Documentation

ConfigServiceClient extends AwsClient
in package

This client is used to interact with AWS Config.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
batchGetAggregateResourceConfig()  :
batchGetAggregateResourceConfigAsync()  :
batchGetResourceConfig()  :
batchGetResourceConfigAsync()  :
deleteAggregationAuthorization()  :
deleteAggregationAuthorizationAsync()  :
deleteConfigRule()  :
deleteConfigRuleAsync()  :
deleteConfigurationAggregator()  :
deleteConfigurationAggregatorAsync()  :
deleteConfigurationRecorder()  :
deleteConfigurationRecorderAsync()  :
deleteConformancePack()  :
deleteConformancePackAsync()  :
deleteDeliveryChannel()  :
deleteDeliveryChannelAsync()  :
deleteEvaluationResults()  :
deleteEvaluationResultsAsync()  :
deleteOrganizationConfigRule()  :
deleteOrganizationConfigRuleAsync()  :
deleteOrganizationConformancePack()  :
deleteOrganizationConformancePackAsync()  :
deletePendingAggregationRequest()  :
deletePendingAggregationRequestAsync()  :
deleteRemediationConfiguration()  :
deleteRemediationConfigurationAsync()  :
deleteRemediationExceptions()  :
deleteRemediationExceptionsAsync()  :
deleteResourceConfig()  :
deleteResourceConfigAsync()  :
deleteRetentionConfiguration()  :
deleteRetentionConfigurationAsync()  :
deliverConfigSnapshot()  :
deliverConfigSnapshotAsync()  :
describeAggregateComplianceByConfigRules()  :
describeAggregateComplianceByConfigRulesAsync()  :
describeAggregationAuthorizations()  :
describeAggregationAuthorizationsAsync()  :
describeComplianceByConfigRule()  :
describeComplianceByConfigRuleAsync()  :
describeComplianceByResource()  :
describeComplianceByResourceAsync()  :
describeConfigRuleEvaluationStatus()  :
describeConfigRuleEvaluationStatusAsync()  :
describeConfigRules()  :
describeConfigRulesAsync()  :
describeConfigurationAggregators()  :
describeConfigurationAggregatorsAsync()  :
describeConfigurationAggregatorSourcesStatus()  :
describeConfigurationAggregatorSourcesStatusAsync()  :
describeConfigurationRecorders()  :
describeConfigurationRecordersAsync()  :
describeConfigurationRecorderStatus()  :
describeConfigurationRecorderStatusAsync()  :
describeConformancePackCompliance()  :
describeConformancePackComplianceAsync()  :
describeConformancePacks()  :
describeConformancePacksAsync()  :
describeConformancePackStatus()  :
describeConformancePackStatusAsync()  :
describeDeliveryChannels()  :
describeDeliveryChannelsAsync()  :
describeDeliveryChannelStatus()  :
describeDeliveryChannelStatusAsync()  :
describeOrganizationConfigRules()  :
describeOrganizationConfigRulesAsync()  :
describeOrganizationConfigRuleStatuses()  :
describeOrganizationConfigRuleStatusesAsync()  :
describeOrganizationConformancePacks()  :
describeOrganizationConformancePacksAsync()  :
describeOrganizationConformancePackStatuses()  :
describeOrganizationConformancePackStatusesAsync()  :
describePendingAggregationRequests()  :
describePendingAggregationRequestsAsync()  :
describeRemediationConfigurations()  :
describeRemediationConfigurationsAsync()  :
describeRemediationExceptions()  :
describeRemediationExceptionsAsync()  :
describeRemediationExecutionStatus()  :
describeRemediationExecutionStatusAsync()  :
describeRetentionConfigurations()  :
describeRetentionConfigurationsAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAggregateComplianceDetailsByConfigRule()  :
getAggregateComplianceDetailsByConfigRuleAsync()  :
getAggregateConfigRuleComplianceSummary()  :
getAggregateConfigRuleComplianceSummaryAsync()  :
getAggregateDiscoveredResourceCounts()  :
getAggregateDiscoveredResourceCountsAsync()  :
getAggregateResourceConfig()  :
getAggregateResourceConfigAsync()  :
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCommand()  : CommandInterface
getComplianceDetailsByConfigRule()  :
getComplianceDetailsByConfigRuleAsync()  :
getComplianceDetailsByResource()  :
getComplianceDetailsByResourceAsync()  :
getComplianceSummaryByConfigRule()  :
getComplianceSummaryByConfigRuleAsync()  :
getComplianceSummaryByResourceType()  :
getComplianceSummaryByResourceTypeAsync()  :
getConfig()  : mixed|null
Get a client configuration value.
getConformancePackComplianceDetails()  :
getConformancePackComplianceDetailsAsync()  :
getConformancePackComplianceSummary()  :
getConformancePackComplianceSummaryAsync()  :
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getDiscoveredResourceCounts()  :
getDiscoveredResourceCountsAsync()  :
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getOrganizationConfigRuleDetailedStatus()  :
getOrganizationConfigRuleDetailedStatusAsync()  :
getOrganizationConformancePackDetailedStatus()  :
getOrganizationConformancePackDetailedStatusAsync()  :
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getResourceConfigHistory()  :
getResourceConfigHistoryAsync()  :
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listAggregateDiscoveredResources()  :
listAggregateDiscoveredResourcesAsync()  :
listDiscoveredResources()  :
listDiscoveredResourcesAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
putAggregationAuthorization()  :
putAggregationAuthorizationAsync()  :
putConfigRule()  :
putConfigRuleAsync()  :
putConfigurationAggregator()  :
putConfigurationAggregatorAsync()  :
putConfigurationRecorder()  :
putConfigurationRecorderAsync()  :
putConformancePack()  :
putConformancePackAsync()  :
putDeliveryChannel()  :
putDeliveryChannelAsync()  :
putEvaluations()  :
putEvaluationsAsync()  :
putExternalEvaluation()  :
putExternalEvaluationAsync()  :
putOrganizationConfigRule()  :
putOrganizationConfigRuleAsync()  :
putOrganizationConformancePack()  :
putOrganizationConformancePackAsync()  :
putRemediationConfigurations()  :
putRemediationConfigurationsAsync()  :
putRemediationExceptions()  :
putRemediationExceptionsAsync()  :
putResourceConfig()  :
putResourceConfigAsync()  :
putRetentionConfiguration()  :
putRetentionConfigurationAsync()  :
selectAggregateResourceConfig()  :
selectAggregateResourceConfigAsync()  :
selectResourceConfig()  :
selectResourceConfigAsync()  :
startConfigRulesEvaluation()  :
startConfigRulesEvaluationAsync()  :
startConfigurationRecorder()  :
startConfigurationRecorderAsync()  :
startRemediationExecution()  :
startRemediationExecutionAsync()  :
stopConfigurationRecorder()  :
stopConfigurationRecorderAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
mixed —

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

batchGetAggregateResourceConfig()

public batchGetAggregateResourceConfig(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchGetAggregateResourceConfigAsync()

public batchGetAggregateResourceConfigAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchGetResourceConfig()

public batchGetResourceConfig(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchGetResourceConfigAsync()

public batchGetResourceConfigAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteAggregationAuthorization()

public deleteAggregationAuthorization(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteAggregationAuthorizationAsync()

public deleteAggregationAuthorizationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigRule()

public deleteConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigRuleAsync()

public deleteConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationAggregator()

public deleteConfigurationAggregator(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationAggregatorAsync()

public deleteConfigurationAggregatorAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationRecorder()

public deleteConfigurationRecorder(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConfigurationRecorderAsync()

public deleteConfigurationRecorderAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConformancePack()

public deleteConformancePack(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConformancePackAsync()

public deleteConformancePackAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDeliveryChannel()

public deleteDeliveryChannel(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDeliveryChannelAsync()

public deleteDeliveryChannelAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEvaluationResults()

public deleteEvaluationResults(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteEvaluationResultsAsync()

public deleteEvaluationResultsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteOrganizationConfigRule()

public deleteOrganizationConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteOrganizationConfigRuleAsync()

public deleteOrganizationConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteOrganizationConformancePack()

public deleteOrganizationConformancePack(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteOrganizationConformancePackAsync()

public deleteOrganizationConformancePackAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deletePendingAggregationRequest()

public deletePendingAggregationRequest(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deletePendingAggregationRequestAsync()

public deletePendingAggregationRequestAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRemediationConfiguration()

public deleteRemediationConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRemediationConfigurationAsync()

public deleteRemediationConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRemediationExceptions()

public deleteRemediationExceptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRemediationExceptionsAsync()

public deleteRemediationExceptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteResourceConfig()

public deleteResourceConfig(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteResourceConfigAsync()

public deleteResourceConfigAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRetentionConfiguration()

public deleteRetentionConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRetentionConfigurationAsync()

public deleteRetentionConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deliverConfigSnapshot()

public deliverConfigSnapshot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deliverConfigSnapshotAsync()

public deliverConfigSnapshotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeAggregateComplianceByConfigRules()

public describeAggregateComplianceByConfigRules(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeAggregateComplianceByConfigRulesAsync()

public describeAggregateComplianceByConfigRulesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeAggregationAuthorizations()

public describeAggregationAuthorizations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeAggregationAuthorizationsAsync()

public describeAggregationAuthorizationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeComplianceByConfigRule()

public describeComplianceByConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeComplianceByConfigRuleAsync()

public describeComplianceByConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeComplianceByResource()

public describeComplianceByResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeComplianceByResourceAsync()

public describeComplianceByResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigRuleEvaluationStatus()

public describeConfigRuleEvaluationStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigRuleEvaluationStatusAsync()

public describeConfigRuleEvaluationStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigRules()

public describeConfigRules(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigRulesAsync()

public describeConfigRulesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationAggregators()

public describeConfigurationAggregators(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationAggregatorsAsync()

public describeConfigurationAggregatorsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationAggregatorSourcesStatus()

public describeConfigurationAggregatorSourcesStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationAggregatorSourcesStatusAsync()

public describeConfigurationAggregatorSourcesStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationRecorders()

public describeConfigurationRecorders(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationRecordersAsync()

public describeConfigurationRecordersAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationRecorderStatus()

public describeConfigurationRecorderStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConfigurationRecorderStatusAsync()

public describeConfigurationRecorderStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConformancePackCompliance()

public describeConformancePackCompliance(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConformancePackComplianceAsync()

public describeConformancePackComplianceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConformancePacks()

public describeConformancePacks(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConformancePacksAsync()

public describeConformancePacksAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConformancePackStatus()

public describeConformancePackStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConformancePackStatusAsync()

public describeConformancePackStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDeliveryChannels()

public describeDeliveryChannels(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDeliveryChannelsAsync()

public describeDeliveryChannelsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDeliveryChannelStatus()

public describeDeliveryChannelStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDeliveryChannelStatusAsync()

public describeDeliveryChannelStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConfigRules()

public describeOrganizationConfigRules(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConfigRulesAsync()

public describeOrganizationConfigRulesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConfigRuleStatuses()

public describeOrganizationConfigRuleStatuses(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConfigRuleStatusesAsync()

public describeOrganizationConfigRuleStatusesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConformancePacks()

public describeOrganizationConformancePacks(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConformancePacksAsync()

public describeOrganizationConformancePacksAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConformancePackStatuses()

public describeOrganizationConformancePackStatuses(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeOrganizationConformancePackStatusesAsync()

public describeOrganizationConformancePackStatusesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describePendingAggregationRequests()

public describePendingAggregationRequests(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describePendingAggregationRequestsAsync()

public describePendingAggregationRequestsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRemediationConfigurations()

public describeRemediationConfigurations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRemediationConfigurationsAsync()

public describeRemediationConfigurationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRemediationExceptions()

public describeRemediationExceptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRemediationExceptionsAsync()

public describeRemediationExceptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRemediationExecutionStatus()

public describeRemediationExecutionStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRemediationExecutionStatusAsync()

public describeRemediationExecutionStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRetentionConfigurations()

public describeRetentionConfigurations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRetentionConfigurationsAsync()

public describeRetentionConfigurationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

getAggregateComplianceDetailsByConfigRule()

public getAggregateComplianceDetailsByConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAggregateComplianceDetailsByConfigRuleAsync()

public getAggregateComplianceDetailsByConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAggregateConfigRuleComplianceSummary()

public getAggregateConfigRuleComplianceSummary(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAggregateConfigRuleComplianceSummaryAsync()

public getAggregateConfigRuleComplianceSummaryAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAggregateDiscoveredResourceCounts()

public getAggregateDiscoveredResourceCounts(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAggregateDiscoveredResourceCountsAsync()

public getAggregateDiscoveredResourceCountsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAggregateResourceConfig()

public getAggregateResourceConfig(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getAggregateResourceConfigAsync()

public getAggregateResourceConfigAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getComplianceDetailsByConfigRule()

public getComplianceDetailsByConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getComplianceDetailsByConfigRuleAsync()

public getComplianceDetailsByConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getComplianceDetailsByResource()

public getComplianceDetailsByResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getComplianceDetailsByResourceAsync()

public getComplianceDetailsByResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getComplianceSummaryByConfigRule()

public getComplianceSummaryByConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getComplianceSummaryByConfigRuleAsync()

public getComplianceSummaryByConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getComplianceSummaryByResourceType()

public getComplianceSummaryByResourceType(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getComplianceSummaryByResourceTypeAsync()

public getComplianceSummaryByResourceTypeAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null —

getConformancePackComplianceDetails()

public getConformancePackComplianceDetails(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConformancePackComplianceDetailsAsync()

public getConformancePackComplianceDetailsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConformancePackComplianceSummary()

public getConformancePackComplianceSummary(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getConformancePackComplianceSummaryAsync()

public getConformancePackComplianceSummaryAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface —

getDiscoveredResourceCounts()

public getDiscoveredResourceCounts(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getDiscoveredResourceCountsAsync()

public getDiscoveredResourceCountsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList —

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getOrganizationConfigRuleDetailedStatus()

public getOrganizationConfigRuleDetailedStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getOrganizationConfigRuleDetailedStatusAsync()

public getOrganizationConfigRuleDetailedStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getOrganizationConformancePackDetailedStatus()

public getOrganizationConformancePackDetailedStatus(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getOrganizationConformancePackDetailedStatusAsync()

public getOrganizationConformancePackDetailedStatusAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getResourceConfigHistory()

public getResourceConfigHistory(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getResourceConfigHistoryAsync()

public getResourceConfigHistoryAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

listAggregateDiscoveredResources()

public listAggregateDiscoveredResources(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listAggregateDiscoveredResourcesAsync()

public listAggregateDiscoveredResourcesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDiscoveredResources()

public listDiscoveredResources(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDiscoveredResourcesAsync()

public listDiscoveredResourcesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAggregationAuthorization()

public putAggregationAuthorization(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putAggregationAuthorizationAsync()

public putAggregationAuthorizationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigRule()

public putConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigRuleAsync()

public putConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationAggregator()

public putConfigurationAggregator(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationAggregatorAsync()

public putConfigurationAggregatorAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationRecorder()

public putConfigurationRecorder(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConfigurationRecorderAsync()

public putConfigurationRecorderAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConformancePack()

public putConformancePack(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putConformancePackAsync()

public putConformancePackAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDeliveryChannel()

public putDeliveryChannel(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putDeliveryChannelAsync()

public putDeliveryChannelAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEvaluations()

public putEvaluations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putEvaluationsAsync()

public putEvaluationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putExternalEvaluation()

public putExternalEvaluation(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putExternalEvaluationAsync()

public putExternalEvaluationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putOrganizationConfigRule()

public putOrganizationConfigRule(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putOrganizationConfigRuleAsync()

public putOrganizationConfigRuleAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putOrganizationConformancePack()

public putOrganizationConformancePack(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putOrganizationConformancePackAsync()

public putOrganizationConformancePackAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putRemediationConfigurations()

public putRemediationConfigurations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putRemediationConfigurationsAsync()

public putRemediationConfigurationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putRemediationExceptions()

public putRemediationExceptions(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putRemediationExceptionsAsync()

public putRemediationExceptionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putResourceConfig()

public putResourceConfig(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putResourceConfigAsync()

public putResourceConfigAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putRetentionConfiguration()

public putRetentionConfiguration(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putRetentionConfigurationAsync()

public putRetentionConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

selectAggregateResourceConfig()

public selectAggregateResourceConfig(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

selectAggregateResourceConfigAsync()

public selectAggregateResourceConfigAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

selectResourceConfig()

public selectResourceConfig(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

selectResourceConfigAsync()

public selectResourceConfigAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startConfigRulesEvaluation()

public startConfigRulesEvaluation(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startConfigRulesEvaluationAsync()

public startConfigRulesEvaluationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startConfigurationRecorder()

public startConfigurationRecorder(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startConfigurationRecorderAsync()

public startConfigurationRecorderAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startRemediationExecution()

public startRemediationExecution(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startRemediationExecutionAsync()

public startRemediationExecutionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopConfigurationRecorder()

public stopConfigurationRecorder(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopConfigurationRecorderAsync()

public stopConfigurationRecorderAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResource()

public tagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResource()

public untagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed —

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed —

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed —

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results