SDK for PHP 3.x

IotClient extends AwsClient
in package

This client is used to interact with the AWS IoT service.

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $client->getCommand method of the client.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
acceptCertificateTransfer()  : Result
acceptCertificateTransferAsync()  : Promise
addThingToBillingGroup()  : Result
addThingToBillingGroupAsync()  : Promise
addThingToThingGroup()  : Result
addThingToThingGroupAsync()  : Promise
associateTargetsWithJob()  : Result
associateTargetsWithJobAsync()  : Promise
attachPolicy()  : Result
attachPolicyAsync()  : Promise
attachPrincipalPolicy()  : Result
attachPrincipalPolicyAsync()  : Promise
attachSecurityProfile()  : Result
attachSecurityProfileAsync()  : Promise
attachThingPrincipal()  : Result
attachThingPrincipalAsync()  : Promise
cancelAuditMitigationActionsTask()  : Result
cancelAuditMitigationActionsTaskAsync()  : Promise
cancelAuditTask()  : Result
cancelAuditTaskAsync()  : Promise
cancelCertificateTransfer()  : Result
cancelCertificateTransferAsync()  : Promise
cancelDetectMitigationActionsTask()  : Result
cancelDetectMitigationActionsTaskAsync()  : Promise
cancelJob()  : Result
cancelJobAsync()  : Promise
cancelJobExecution()  : Result
cancelJobExecutionAsync()  : Promise
clearDefaultAuthorizer()  : Result
clearDefaultAuthorizerAsync()  : Promise
confirmTopicRuleDestination()  : Result
confirmTopicRuleDestinationAsync()  : Promise
createAuditSuppression()  : Result
createAuditSuppressionAsync()  : Promise
createAuthorizer()  : Result
createAuthorizerAsync()  : Promise
createBillingGroup()  : Result
createBillingGroupAsync()  : Promise
createCertificateFromCsr()  : Result
createCertificateFromCsrAsync()  : Promise
createCertificateProvider()  : Result
createCertificateProviderAsync()  : Promise
createCustomMetric()  : Result
createCustomMetricAsync()  : Promise
createDimension()  : Result
createDimensionAsync()  : Promise
createDomainConfiguration()  : Result
createDomainConfigurationAsync()  : Promise
createDynamicThingGroup()  : Result
createDynamicThingGroupAsync()  : Promise
createFleetMetric()  : Result
createFleetMetricAsync()  : Promise
createJob()  : Result
createJobAsync()  : Promise
createJobTemplate()  : Result
createJobTemplateAsync()  : Promise
createKeysAndCertificate()  : Result
createKeysAndCertificateAsync()  : Promise
createMitigationAction()  : Result
createMitigationActionAsync()  : Promise
createOTAUpdate()  : Result
createOTAUpdateAsync()  : Promise
createPackage()  : Result
createPackageAsync()  : Promise
createPackageVersion()  : Result
createPackageVersionAsync()  : Promise
createPolicy()  : Result
createPolicyAsync()  : Promise
createPolicyVersion()  : Result
createPolicyVersionAsync()  : Promise
createProvisioningClaim()  : Result
createProvisioningClaimAsync()  : Promise
createProvisioningTemplate()  : Result
createProvisioningTemplateAsync()  : Promise
createProvisioningTemplateVersion()  : Result
createProvisioningTemplateVersionAsync()  : Promise
createRoleAlias()  : Result
createRoleAliasAsync()  : Promise
createScheduledAudit()  : Result
createScheduledAuditAsync()  : Promise
createSecurityProfile()  : Result
createSecurityProfileAsync()  : Promise
createStream()  : Result
createStreamAsync()  : Promise
createThing()  : Result
createThingAsync()  : Promise
createThingGroup()  : Result
createThingGroupAsync()  : Promise
createThingType()  : Result
createThingTypeAsync()  : Promise
createTopicRule()  : Result
createTopicRuleAsync()  : Promise
createTopicRuleDestination()  : Result
createTopicRuleDestinationAsync()  : Promise
deleteAccountAuditConfiguration()  : Result
deleteAccountAuditConfigurationAsync()  : Promise
deleteAuditSuppression()  : Result
deleteAuditSuppressionAsync()  : Promise
deleteAuthorizer()  : Result
deleteAuthorizerAsync()  : Promise
deleteBillingGroup()  : Result
deleteBillingGroupAsync()  : Promise
deleteCACertificate()  : Result
deleteCACertificateAsync()  : Promise
deleteCertificate()  : Result
deleteCertificateAsync()  : Promise
deleteCertificateProvider()  : Result
deleteCertificateProviderAsync()  : Promise
deleteCustomMetric()  : Result
deleteCustomMetricAsync()  : Promise
deleteDimension()  : Result
deleteDimensionAsync()  : Promise
deleteDomainConfiguration()  : Result
deleteDomainConfigurationAsync()  : Promise
deleteDynamicThingGroup()  : Result
deleteDynamicThingGroupAsync()  : Promise
deleteFleetMetric()  : Result
deleteFleetMetricAsync()  : Promise
deleteJob()  : Result
deleteJobAsync()  : Promise
deleteJobExecution()  : Result
deleteJobExecutionAsync()  : Promise
deleteJobTemplate()  : Result
deleteJobTemplateAsync()  : Promise
deleteMitigationAction()  : Result
deleteMitigationActionAsync()  : Promise
deleteOTAUpdate()  : Result
deleteOTAUpdateAsync()  : Promise
deletePackage()  : Result
deletePackageAsync()  : Promise
deletePackageVersion()  : Result
deletePackageVersionAsync()  : Promise
deletePolicy()  : Result
deletePolicyAsync()  : Promise
deletePolicyVersion()  : Result
deletePolicyVersionAsync()  : Promise
deleteProvisioningTemplate()  : Result
deleteProvisioningTemplateAsync()  : Promise
deleteProvisioningTemplateVersion()  : Result
deleteProvisioningTemplateVersionAsync()  : Promise
deleteRegistrationCode()  : Result
deleteRegistrationCodeAsync()  : Promise
deleteRoleAlias()  : Result
deleteRoleAliasAsync()  : Promise
deleteScheduledAudit()  : Result
deleteScheduledAuditAsync()  : Promise
deleteSecurityProfile()  : Result
deleteSecurityProfileAsync()  : Promise
deleteStream()  : Result
deleteStreamAsync()  : Promise
deleteThing()  : Result
deleteThingAsync()  : Promise
deleteThingGroup()  : Result
deleteThingGroupAsync()  : Promise
deleteThingType()  : Result
deleteThingTypeAsync()  : Promise
deleteTopicRule()  : Result
deleteTopicRuleAsync()  : Promise
deleteTopicRuleDestination()  : Result
deleteTopicRuleDestinationAsync()  : Promise
deleteV2LoggingLevel()  : Result
deleteV2LoggingLevelAsync()  : Promise
deprecateThingType()  : Result
deprecateThingTypeAsync()  : Promise
describeAccountAuditConfiguration()  : Result
describeAccountAuditConfigurationAsync()  : Promise
describeAuditFinding()  : Result
describeAuditFindingAsync()  : Promise
describeAuditMitigationActionsTask()  : Result
describeAuditMitigationActionsTaskAsync()  : Promise
describeAuditSuppression()  : Result
describeAuditSuppressionAsync()  : Promise
describeAuditTask()  : Result
describeAuditTaskAsync()  : Promise
describeAuthorizer()  : Result
describeAuthorizerAsync()  : Promise
describeBillingGroup()  : Result
describeBillingGroupAsync()  : Promise
describeCACertificate()  : Result
describeCACertificateAsync()  : Promise
describeCertificate()  : Result
describeCertificateAsync()  : Promise
describeCertificateProvider()  : Result
describeCertificateProviderAsync()  : Promise
describeCustomMetric()  : Result
describeCustomMetricAsync()  : Promise
describeDefaultAuthorizer()  : Result
describeDefaultAuthorizerAsync()  : Promise
describeDetectMitigationActionsTask()  : Result
describeDetectMitigationActionsTaskAsync()  : Promise
describeDimension()  : Result
describeDimensionAsync()  : Promise
describeDomainConfiguration()  : Result
describeDomainConfigurationAsync()  : Promise
describeEndpoint()  : Result
describeEndpointAsync()  : Promise
describeEventConfigurations()  : Result
describeEventConfigurationsAsync()  : Promise
describeFleetMetric()  : Result
describeFleetMetricAsync()  : Promise
describeIndex()  : Result
describeIndexAsync()  : Promise
describeJob()  : Result
describeJobAsync()  : Promise
describeJobExecution()  : Result
describeJobExecutionAsync()  : Promise
describeJobTemplate()  : Result
describeJobTemplateAsync()  : Promise
describeManagedJobTemplate()  : Result
describeManagedJobTemplateAsync()  : Promise
describeMitigationAction()  : Result
describeMitigationActionAsync()  : Promise
describeProvisioningTemplate()  : Result
describeProvisioningTemplateAsync()  : Promise
describeProvisioningTemplateVersion()  : Result
describeProvisioningTemplateVersionAsync()  : Promise
describeRoleAlias()  : Result
describeRoleAliasAsync()  : Promise
describeScheduledAudit()  : Result
describeScheduledAuditAsync()  : Promise
describeSecurityProfile()  : Result
describeSecurityProfileAsync()  : Promise
describeStream()  : Result
describeStreamAsync()  : Promise
describeThing()  : Result
describeThingAsync()  : Promise
describeThingGroup()  : Result
describeThingGroupAsync()  : Promise
describeThingRegistrationTask()  : Result
describeThingRegistrationTaskAsync()  : Promise
describeThingType()  : Result
describeThingTypeAsync()  : Promise
detachPolicy()  : Result
detachPolicyAsync()  : Promise
detachPrincipalPolicy()  : Result
detachPrincipalPolicyAsync()  : Promise
detachSecurityProfile()  : Result
detachSecurityProfileAsync()  : Promise
detachThingPrincipal()  : Result
detachThingPrincipalAsync()  : Promise
disableTopicRule()  : Result
disableTopicRuleAsync()  : Promise
emitDeprecationWarning()  : mixed
enableTopicRule()  : Result
enableTopicRuleAsync()  : Promise
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getBehaviorModelTrainingSummaries()  : Result
getBehaviorModelTrainingSummariesAsync()  : Promise
getBucketsAggregation()  : Result
getBucketsAggregationAsync()  : Promise
getCardinality()  : Result
getCardinalityAsync()  : Promise
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEffectivePolicies()  : Result
getEffectivePoliciesAsync()  : Promise
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIndexingConfiguration()  : Result
getIndexingConfigurationAsync()  : Promise
getIterator()  : mixed
getJobDocument()  : Result
getJobDocumentAsync()  : Promise
getLoggingOptions()  : Result
getLoggingOptionsAsync()  : Promise
getOTAUpdate()  : Result
getOTAUpdateAsync()  : Promise
getPackage()  : Result
getPackageAsync()  : Promise
getPackageConfiguration()  : Result
getPackageConfigurationAsync()  : Promise
getPackageVersion()  : Result
getPackageVersionAsync()  : Promise
getPaginator()  : mixed
getPercentiles()  : Result
getPercentilesAsync()  : Promise
getPolicy()  : Result
getPolicyAsync()  : Promise
getPolicyVersion()  : Result
getPolicyVersionAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getRegistrationCode()  : Result
getRegistrationCodeAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getStatistics()  : Result
getStatisticsAsync()  : Promise
getTopicRule()  : Result
getTopicRuleAsync()  : Promise
getTopicRuleDestination()  : Result
getTopicRuleDestinationAsync()  : Promise
getV2LoggingOptions()  : Result
getV2LoggingOptionsAsync()  : Promise
getWaiter()  : mixed
listActiveViolations()  : Result
listActiveViolationsAsync()  : Promise
listAttachedPolicies()  : Result
listAttachedPoliciesAsync()  : Promise
listAuditFindings()  : Result
listAuditFindingsAsync()  : Promise
listAuditMitigationActionsExecutions()  : Result
listAuditMitigationActionsExecutionsAsync()  : Promise
listAuditMitigationActionsTasks()  : Result
listAuditMitigationActionsTasksAsync()  : Promise
listAuditSuppressions()  : Result
listAuditSuppressionsAsync()  : Promise
listAuditTasks()  : Result
listAuditTasksAsync()  : Promise
listAuthorizers()  : Result
listAuthorizersAsync()  : Promise
listBillingGroups()  : Result
listBillingGroupsAsync()  : Promise
listCACertificates()  : Result
listCACertificatesAsync()  : Promise
listCertificateProviders()  : Result
listCertificateProvidersAsync()  : Promise
listCertificates()  : Result
listCertificatesAsync()  : Promise
listCertificatesByCA()  : Result
listCertificatesByCAAsync()  : Promise
listCustomMetrics()  : Result
listCustomMetricsAsync()  : Promise
listDetectMitigationActionsExecutions()  : Result
listDetectMitigationActionsExecutionsAsync()  : Promise
listDetectMitigationActionsTasks()  : Result
listDetectMitigationActionsTasksAsync()  : Promise
listDimensions()  : Result
listDimensionsAsync()  : Promise
listDomainConfigurations()  : Result
listDomainConfigurationsAsync()  : Promise
listFleetMetrics()  : Result
listFleetMetricsAsync()  : Promise
listIndices()  : Result
listIndicesAsync()  : Promise
listJobExecutionsForJob()  : Result
listJobExecutionsForJobAsync()  : Promise
listJobExecutionsForThing()  : Result
listJobExecutionsForThingAsync()  : Promise
listJobs()  : Result
listJobsAsync()  : Promise
listJobTemplates()  : Result
listJobTemplatesAsync()  : Promise
listManagedJobTemplates()  : Result
listManagedJobTemplatesAsync()  : Promise
listMetricValues()  : Result
listMetricValuesAsync()  : Promise
listMitigationActions()  : Result
listMitigationActionsAsync()  : Promise
listOTAUpdates()  : Result
listOTAUpdatesAsync()  : Promise
listOutgoingCertificates()  : Result
listOutgoingCertificatesAsync()  : Promise
listPackages()  : Result
listPackagesAsync()  : Promise
listPackageVersions()  : Result
listPackageVersionsAsync()  : Promise
listPolicies()  : Result
listPoliciesAsync()  : Promise
listPolicyPrincipals()  : Result
listPolicyPrincipalsAsync()  : Promise
listPolicyVersions()  : Result
listPolicyVersionsAsync()  : Promise
listPrincipalPolicies()  : Result
listPrincipalPoliciesAsync()  : Promise
listPrincipalThings()  : Result
listPrincipalThingsAsync()  : Promise
listProvisioningTemplates()  : Result
listProvisioningTemplatesAsync()  : Promise
listProvisioningTemplateVersions()  : Result
listProvisioningTemplateVersionsAsync()  : Promise
listRelatedResourcesForAuditFinding()  : Result
listRelatedResourcesForAuditFindingAsync()  : Promise
listRoleAliases()  : Result
listRoleAliasesAsync()  : Promise
listScheduledAudits()  : Result
listScheduledAuditsAsync()  : Promise
listSecurityProfiles()  : Result
listSecurityProfilesAsync()  : Promise
listSecurityProfilesForTarget()  : Result
listSecurityProfilesForTargetAsync()  : Promise
listStreams()  : Result
listStreamsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
listTargetsForPolicy()  : Result
listTargetsForPolicyAsync()  : Promise
listTargetsForSecurityProfile()  : Result
listTargetsForSecurityProfileAsync()  : Promise
listThingGroups()  : Result
listThingGroupsAsync()  : Promise
listThingGroupsForThing()  : Result
listThingGroupsForThingAsync()  : Promise
listThingPrincipals()  : Result
listThingPrincipalsAsync()  : Promise
listThingRegistrationTaskReports()  : Result
listThingRegistrationTaskReportsAsync()  : Promise
listThingRegistrationTasks()  : Result
listThingRegistrationTasksAsync()  : Promise
listThings()  : Result
listThingsAsync()  : Promise
listThingsInBillingGroup()  : Result
listThingsInBillingGroupAsync()  : Promise
listThingsInThingGroup()  : Result
listThingsInThingGroupAsync()  : Promise
listThingTypes()  : Result
listThingTypesAsync()  : Promise
listTopicRuleDestinations()  : Result
listTopicRuleDestinationsAsync()  : Promise
listTopicRules()  : Result
listTopicRulesAsync()  : Promise
listV2LoggingLevels()  : Result
listV2LoggingLevelsAsync()  : Promise
listViolationEvents()  : Result
listViolationEventsAsync()  : Promise
putVerificationStateOnViolation()  : Result
putVerificationStateOnViolationAsync()  : Promise
registerCACertificate()  : Result
registerCACertificateAsync()  : Promise
registerCertificate()  : Result
registerCertificateAsync()  : Promise
registerCertificateWithoutCA()  : Result
registerCertificateWithoutCAAsync()  : Promise
registerThing()  : Result
registerThingAsync()  : Promise
rejectCertificateTransfer()  : Result
rejectCertificateTransferAsync()  : Promise
removeThingFromBillingGroup()  : Result
removeThingFromBillingGroupAsync()  : Promise
removeThingFromThingGroup()  : Result
removeThingFromThingGroupAsync()  : Promise
replaceTopicRule()  : Result
replaceTopicRuleAsync()  : Promise
searchIndex()  : Result
searchIndexAsync()  : Promise
setDefaultAuthorizer()  : Result
setDefaultAuthorizerAsync()  : Promise
setDefaultPolicyVersion()  : Result
setDefaultPolicyVersionAsync()  : Promise
setLoggingOptions()  : Result
setLoggingOptionsAsync()  : Promise
setV2LoggingLevel()  : Result
setV2LoggingLevelAsync()  : Promise
setV2LoggingOptions()  : Result
setV2LoggingOptionsAsync()  : Promise
startAuditMitigationActionsTask()  : Result
startAuditMitigationActionsTaskAsync()  : Promise
startDetectMitigationActionsTask()  : Result
startDetectMitigationActionsTaskAsync()  : Promise
startOnDemandAuditTask()  : Result
startOnDemandAuditTaskAsync()  : Promise
startThingRegistrationTask()  : Result
startThingRegistrationTaskAsync()  : Promise
stopThingRegistrationTask()  : Result
stopThingRegistrationTaskAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
testAuthorization()  : Result
testAuthorizationAsync()  : Promise
testInvokeAuthorizer()  : Result
testInvokeAuthorizerAsync()  : Promise
transferCertificate()  : Result
transferCertificateAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAccountAuditConfiguration()  : Result
updateAccountAuditConfigurationAsync()  : Promise
updateAuditSuppression()  : Result
updateAuditSuppressionAsync()  : Promise
updateAuthorizer()  : Result
updateAuthorizerAsync()  : Promise
updateBillingGroup()  : Result
updateBillingGroupAsync()  : Promise
updateCACertificate()  : Result
updateCACertificateAsync()  : Promise
updateCertificate()  : Result
updateCertificateAsync()  : Promise
updateCertificateProvider()  : Result
updateCertificateProviderAsync()  : Promise
updateCustomMetric()  : Result
updateCustomMetricAsync()  : Promise
updateDimension()  : Result
updateDimensionAsync()  : Promise
updateDomainConfiguration()  : Result
updateDomainConfigurationAsync()  : Promise
updateDynamicThingGroup()  : Result
updateDynamicThingGroupAsync()  : Promise
updateEventConfigurations()  : Result
updateEventConfigurationsAsync()  : Promise
updateFleetMetric()  : Result
updateFleetMetricAsync()  : Promise
updateIndexingConfiguration()  : Result
updateIndexingConfigurationAsync()  : Promise
updateJob()  : Result
updateJobAsync()  : Promise
updateMitigationAction()  : Result
updateMitigationActionAsync()  : Promise
updatePackage()  : Result
updatePackageAsync()  : Promise
updatePackageConfiguration()  : Result
updatePackageConfigurationAsync()  : Promise
updatePackageVersion()  : Result
updatePackageVersionAsync()  : Promise
updateProvisioningTemplate()  : Result
updateProvisioningTemplateAsync()  : Promise
updateRoleAlias()  : Result
updateRoleAliasAsync()  : Promise
updateScheduledAudit()  : Result
updateScheduledAuditAsync()  : Promise
updateSecurityProfile()  : Result
updateSecurityProfileAsync()  : Promise
updateStream()  : Result
updateStreamAsync()  : Promise
updateThing()  : Result
updateThingAsync()  : Promise
updateThingGroup()  : Result
updateThingGroupAsync()  : Promise
updateThingGroupsForThing()  : Result
updateThingGroupsForThingAsync()  : Promise
updateTopicRuleDestination()  : Result
updateTopicRuleDestinationAsync()  : Promise
validateSecurityProfileBehaviors()  : Result
validateSecurityProfileBehaviorsAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, 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.
  • token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key, false to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one 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).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

acceptCertificateTransfer()

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

acceptCertificateTransferAsync()

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

addThingToBillingGroup()

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

addThingToBillingGroupAsync()

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

addThingToThingGroup()

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

addThingToThingGroupAsync()

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

associateTargetsWithJob()

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

associateTargetsWithJobAsync()

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

attachPolicy()

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

attachPolicyAsync()

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

attachPrincipalPolicy()

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

attachPrincipalPolicyAsync()

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

attachSecurityProfile()

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

attachSecurityProfileAsync()

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

attachThingPrincipal()

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

attachThingPrincipalAsync()

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

cancelAuditMitigationActionsTask()

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

cancelAuditMitigationActionsTaskAsync()

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

cancelAuditTask()

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

cancelAuditTaskAsync()

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

cancelCertificateTransfer()

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

cancelCertificateTransferAsync()

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

cancelDetectMitigationActionsTask()

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

cancelDetectMitigationActionsTaskAsync()

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

cancelJob()

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

cancelJobAsync()

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

cancelJobExecution()

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

cancelJobExecutionAsync()

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

clearDefaultAuthorizer()

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

clearDefaultAuthorizerAsync()

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

confirmTopicRuleDestination()

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

confirmTopicRuleDestinationAsync()

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

createAuditSuppression()

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

createAuditSuppressionAsync()

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

createAuthorizer()

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

createAuthorizerAsync()

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

createBillingGroup()

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

createBillingGroupAsync()

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

createCertificateFromCsr()

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

createCertificateFromCsrAsync()

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

createCertificateProvider()

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

createCertificateProviderAsync()

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

createCustomMetric()

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

createCustomMetricAsync()

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

createDimension()

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

createDimensionAsync()

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

createDomainConfiguration()

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

createDomainConfigurationAsync()

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

createDynamicThingGroup()

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

createDynamicThingGroupAsync()

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

createFleetMetric()

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

createFleetMetricAsync()

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

createJob()

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

createJobAsync()

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

createJobTemplate()

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

createJobTemplateAsync()

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

createKeysAndCertificate()

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

createKeysAndCertificateAsync()

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

createMitigationAction()

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

createMitigationActionAsync()

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

createOTAUpdate()

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

createOTAUpdateAsync()

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

createPackage()

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

createPackageAsync()

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

createPackageVersion()

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

createPackageVersionAsync()

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

createPolicy()

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

createPolicyAsync()

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

createPolicyVersion()

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

createPolicyVersionAsync()

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

createProvisioningClaim()

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

createProvisioningClaimAsync()

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

createProvisioningTemplate()

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

createProvisioningTemplateAsync()

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

createProvisioningTemplateVersion()

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

createProvisioningTemplateVersionAsync()

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

createRoleAlias()

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

createRoleAliasAsync()

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

createScheduledAudit()

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

createScheduledAuditAsync()

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

createSecurityProfile()

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

createSecurityProfileAsync()

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

createStream()

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

createStreamAsync()

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

createThing()

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

createThingAsync()

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

createThingGroup()

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

createThingGroupAsync()

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

createThingType()

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

createThingTypeAsync()

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

createTopicRule()

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

createTopicRuleAsync()

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

createTopicRuleDestination()

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

createTopicRuleDestinationAsync()

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

deleteAccountAuditConfiguration()

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

deleteAccountAuditConfigurationAsync()

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

deleteAuditSuppression()

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

deleteAuditSuppressionAsync()

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

deleteAuthorizer()

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

deleteAuthorizerAsync()

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

deleteBillingGroup()

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

deleteBillingGroupAsync()

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

deleteCACertificate()

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

deleteCACertificateAsync()

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

deleteCertificate()

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

deleteCertificateAsync()

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

deleteCertificateProvider()

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

deleteCertificateProviderAsync()

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

deleteCustomMetric()

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

deleteCustomMetricAsync()

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

deleteDimension()

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

deleteDimensionAsync()

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

deleteDomainConfiguration()

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

deleteDomainConfigurationAsync()

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

deleteDynamicThingGroup()

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

deleteDynamicThingGroupAsync()

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

deleteFleetMetric()

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

deleteFleetMetricAsync()

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

deleteJob()

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

deleteJobAsync()

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

deleteJobExecution()

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

deleteJobExecutionAsync()

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

deleteJobTemplate()

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

deleteJobTemplateAsync()

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

deleteMitigationAction()

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

deleteMitigationActionAsync()

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

deleteOTAUpdate()

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

deleteOTAUpdateAsync()

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

deletePackage()

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

deletePackageAsync()

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

deletePackageVersion()

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

deletePackageVersionAsync()

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

deletePolicy()

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

deletePolicyAsync()

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

deletePolicyVersion()

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

deletePolicyVersionAsync()

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

deleteProvisioningTemplate()

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

deleteProvisioningTemplateAsync()

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

deleteProvisioningTemplateVersion()

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

deleteProvisioningTemplateVersionAsync()

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

deleteRegistrationCode()

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

deleteRegistrationCodeAsync()

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

deleteRoleAlias()

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

deleteRoleAliasAsync()

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

deleteScheduledAudit()

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

deleteScheduledAuditAsync()

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

deleteSecurityProfile()

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

deleteSecurityProfileAsync()

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

deleteStream()

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

deleteStreamAsync()

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

deleteThing()

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

deleteThingAsync()

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

deleteThingGroup()

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

deleteThingGroupAsync()

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

deleteThingType()

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

deleteThingTypeAsync()

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

deleteTopicRule()

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

deleteTopicRuleAsync()

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

deleteTopicRuleDestination()

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

deleteTopicRuleDestinationAsync()

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

deleteV2LoggingLevel()

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

deleteV2LoggingLevelAsync()

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

deprecateThingType()

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

deprecateThingTypeAsync()

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

describeAccountAuditConfiguration()

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

describeAccountAuditConfigurationAsync()

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

describeAuditFinding()

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

describeAuditFindingAsync()

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

describeAuditMitigationActionsTask()

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

describeAuditMitigationActionsTaskAsync()

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

describeAuditSuppression()

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

describeAuditSuppressionAsync()

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

describeAuditTask()

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

describeAuditTaskAsync()

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

describeAuthorizer()

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

describeAuthorizerAsync()

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

describeBillingGroup()

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

describeBillingGroupAsync()

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

describeCACertificate()

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

describeCACertificateAsync()

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

describeCertificate()

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

describeCertificateAsync()

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

describeCertificateProvider()

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

describeCertificateProviderAsync()

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

describeCustomMetric()

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

describeCustomMetricAsync()

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

describeDefaultAuthorizer()

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

describeDefaultAuthorizerAsync()

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

describeDetectMitigationActionsTask()

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

describeDetectMitigationActionsTaskAsync()

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

describeDimension()

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

describeDimensionAsync()

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

describeDomainConfiguration()

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

describeDomainConfigurationAsync()

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

describeEndpoint()

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

describeEndpointAsync()

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

describeEventConfigurations()

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

describeEventConfigurationsAsync()

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

describeFleetMetric()

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

describeFleetMetricAsync()

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

describeIndex()

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

describeIndexAsync()

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

describeJob()

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

describeJobAsync()

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

describeJobExecution()

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

describeJobExecutionAsync()

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

describeJobTemplate()

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

describeJobTemplateAsync()

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

describeManagedJobTemplate()

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

describeManagedJobTemplateAsync()

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

describeMitigationAction()

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

describeMitigationActionAsync()

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

describeProvisioningTemplate()

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

describeProvisioningTemplateAsync()

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

describeProvisioningTemplateVersion()

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

describeProvisioningTemplateVersionAsync()

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

describeRoleAlias()

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

describeRoleAliasAsync()

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

describeScheduledAudit()

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

describeScheduledAuditAsync()

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

describeSecurityProfile()

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

describeSecurityProfileAsync()

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

describeStream()

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

describeStreamAsync()

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

describeThing()

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

describeThingAsync()

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

describeThingGroup()

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

describeThingGroupAsync()

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

describeThingRegistrationTask()

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

describeThingRegistrationTaskAsync()

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

describeThingType()

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

describeThingTypeAsync()

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

detachPolicy()

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

detachPolicyAsync()

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

detachPrincipalPolicy()

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

detachPrincipalPolicyAsync()

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

detachSecurityProfile()

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

detachSecurityProfileAsync()

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

detachThingPrincipal()

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

detachThingPrincipalAsync()

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

disableTopicRule()

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

disableTopicRuleAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

enableTopicRule()

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

enableTopicRuleAsync()

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

factory()

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

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>

getBehaviorModelTrainingSummaries()

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

getBehaviorModelTrainingSummariesAsync()

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

getBucketsAggregation()

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

getBucketsAggregationAsync()

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

getCardinality()

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

getCardinalityAsync()

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

getClientBuiltIns()

Provides the set of built-in keys and values used for endpoint resolution

public getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientContextParams()

Provides the set of service context parameter key-value pairs used for endpoint resolution.

public getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCommand()

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

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

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

getEffectivePolicies()

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

getEffectivePoliciesAsync()

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

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

getIndexingConfiguration()

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

getIndexingConfigurationAsync()

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

getIterator()

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

getJobDocument()

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

getJobDocumentAsync()

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

getLoggingOptions()

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

getLoggingOptionsAsync()

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

getOTAUpdate()

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

getOTAUpdateAsync()

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

getPackage()

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

getPackageAsync()

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

getPackageConfiguration()

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

getPackageConfigurationAsync()

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

getPackageVersion()

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

getPackageVersionAsync()

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

getPaginator()

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

getPercentiles()

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

getPercentilesAsync()

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

getPolicy()

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

getPolicyAsync()

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

getPolicyVersion()

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

getPolicyVersionAsync()

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

getRegion()

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

public getRegion() : string
Return values
string

getRegistrationCode()

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

getRegistrationCodeAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getStatistics()

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

getStatisticsAsync()

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

getTopicRule()

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

getTopicRuleAsync()

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

getTopicRuleDestination()

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

getTopicRuleDestinationAsync()

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

getV2LoggingOptions()

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

getV2LoggingOptionsAsync()

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

getWaiter()

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

listActiveViolations()

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

listActiveViolationsAsync()

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

listAttachedPolicies()

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

listAttachedPoliciesAsync()

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

listAuditFindings()

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

listAuditFindingsAsync()

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

listAuditMitigationActionsExecutions()

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

listAuditMitigationActionsExecutionsAsync()

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

listAuditMitigationActionsTasks()

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

listAuditMitigationActionsTasksAsync()

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

listAuditSuppressions()

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

listAuditSuppressionsAsync()

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

listAuditTasks()

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

listAuditTasksAsync()

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

listAuthorizers()

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

listAuthorizersAsync()

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

listBillingGroups()

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

listBillingGroupsAsync()

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

listCACertificates()

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

listCACertificatesAsync()

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

listCertificateProviders()

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

listCertificateProvidersAsync()

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

listCertificates()

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

listCertificatesAsync()

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

listCertificatesByCA()

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

listCertificatesByCAAsync()

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

listCustomMetrics()

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

listCustomMetricsAsync()

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

listDetectMitigationActionsExecutions()

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

listDetectMitigationActionsExecutionsAsync()

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

listDetectMitigationActionsTasks()

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

listDetectMitigationActionsTasksAsync()

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

listDimensions()

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

listDimensionsAsync()

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

listDomainConfigurations()

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

listDomainConfigurationsAsync()

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

listFleetMetrics()

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

listFleetMetricsAsync()

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

listIndices()

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

listIndicesAsync()

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

listJobExecutionsForJob()

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

listJobExecutionsForJobAsync()

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

listJobExecutionsForThing()

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

listJobExecutionsForThingAsync()

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

listJobs()

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

listJobsAsync()

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

listJobTemplates()

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

listJobTemplatesAsync()

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

listManagedJobTemplates()

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

listManagedJobTemplatesAsync()

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

listMetricValues()

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

listMetricValuesAsync()

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

listMitigationActions()

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

listMitigationActionsAsync()

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

listOTAUpdates()

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

listOTAUpdatesAsync()

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

listOutgoingCertificates()

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

listOutgoingCertificatesAsync()

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

listPackages()

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

listPackagesAsync()

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

listPackageVersions()

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

listPackageVersionsAsync()

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

listPolicies()

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

listPoliciesAsync()

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

listPolicyPrincipals()

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

listPolicyPrincipalsAsync()

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

listPolicyVersions()

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

listPolicyVersionsAsync()

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

listPrincipalPolicies()

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

listPrincipalPoliciesAsync()

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

listPrincipalThings()

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

listPrincipalThingsAsync()

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

listProvisioningTemplates()

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

listProvisioningTemplatesAsync()

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

listProvisioningTemplateVersions()

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

listProvisioningTemplateVersionsAsync()

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

listRelatedResourcesForAuditFinding()

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

listRelatedResourcesForAuditFindingAsync()

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

listRoleAliases()

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

listRoleAliasesAsync()

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

listScheduledAudits()

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

listScheduledAuditsAsync()

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

listSecurityProfiles()

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

listSecurityProfilesAsync()

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

listSecurityProfilesForTarget()

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

listSecurityProfilesForTargetAsync()

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

listStreams()

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

listStreamsAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listTargetsForPolicy()

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

listTargetsForPolicyAsync()

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

listTargetsForSecurityProfile()

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

listTargetsForSecurityProfileAsync()

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

listThingGroups()

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

listThingGroupsAsync()

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

listThingGroupsForThing()

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

listThingGroupsForThingAsync()

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

listThingPrincipals()

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

listThingPrincipalsAsync()

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

listThingRegistrationTaskReports()

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

listThingRegistrationTaskReportsAsync()

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

listThingRegistrationTasks()

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

listThingRegistrationTasksAsync()

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

listThings()

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

listThingsAsync()

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

listThingsInBillingGroup()

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

listThingsInBillingGroupAsync()

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

listThingsInThingGroup()

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

listThingsInThingGroupAsync()

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

listThingTypes()

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

listThingTypesAsync()

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

listTopicRuleDestinations()

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

listTopicRuleDestinationsAsync()

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

listTopicRules()

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

listTopicRulesAsync()

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

listV2LoggingLevels()

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

listV2LoggingLevelsAsync()

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

listViolationEvents()

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

listViolationEventsAsync()

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

putVerificationStateOnViolation()

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

putVerificationStateOnViolationAsync()

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

registerCACertificate()

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

registerCACertificateAsync()

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

registerCertificate()

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

registerCertificateAsync()

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

registerCertificateWithoutCA()

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

registerCertificateWithoutCAAsync()

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

registerThing()

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

registerThingAsync()

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

rejectCertificateTransfer()

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

rejectCertificateTransferAsync()

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

removeThingFromBillingGroup()

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

removeThingFromBillingGroupAsync()

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

removeThingFromThingGroup()

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

removeThingFromThingGroupAsync()

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

replaceTopicRule()

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

replaceTopicRuleAsync()

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

searchIndex()

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

searchIndexAsync()

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

setDefaultAuthorizer()

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

setDefaultAuthorizerAsync()

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

setDefaultPolicyVersion()

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

setDefaultPolicyVersionAsync()

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

setLoggingOptions()

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

setLoggingOptionsAsync()

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

setV2LoggingLevel()

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

setV2LoggingLevelAsync()

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

setV2LoggingOptions()

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

setV2LoggingOptionsAsync()

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

startAuditMitigationActionsTask()

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

startAuditMitigationActionsTaskAsync()

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

startDetectMitigationActionsTask()

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

startDetectMitigationActionsTaskAsync()

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

startOnDemandAuditTask()

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

startOnDemandAuditTaskAsync()

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

startThingRegistrationTask()

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

startThingRegistrationTaskAsync()

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

stopThingRegistrationTask()

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

stopThingRegistrationTaskAsync()

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

tagResource()

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

tagResourceAsync()

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

testAuthorization()

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

testAuthorizationAsync()

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

testInvokeAuthorizer()

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

testInvokeAuthorizerAsync()

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

transferCertificate()

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

transferCertificateAsync()

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

untagResource()

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

untagResourceAsync()

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

updateAccountAuditConfiguration()

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

updateAccountAuditConfigurationAsync()

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

updateAuditSuppression()

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

updateAuditSuppressionAsync()

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

updateAuthorizer()

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

updateAuthorizerAsync()

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

updateBillingGroup()

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

updateBillingGroupAsync()

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

updateCACertificate()

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

updateCACertificateAsync()

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

updateCertificate()

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

updateCertificateAsync()

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

updateCertificateProvider()

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

updateCertificateProviderAsync()

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

updateCustomMetric()

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

updateCustomMetricAsync()

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

updateDimension()

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

updateDimensionAsync()

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

updateDomainConfiguration()

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

updateDomainConfigurationAsync()

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

updateDynamicThingGroup()

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

updateDynamicThingGroupAsync()

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

updateEventConfigurations()

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

updateEventConfigurationsAsync()

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

updateFleetMetric()

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

updateFleetMetricAsync()

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

updateIndexingConfiguration()

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

updateIndexingConfigurationAsync()

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

updateJob()

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

updateJobAsync()

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

updateMitigationAction()

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

updateMitigationActionAsync()

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

updatePackage()

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

updatePackageAsync()

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

updatePackageConfiguration()

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

updatePackageConfigurationAsync()

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

updatePackageVersion()

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

updatePackageVersionAsync()

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

updateProvisioningTemplate()

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

updateProvisioningTemplateAsync()

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

updateRoleAlias()

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

updateRoleAliasAsync()

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

updateScheduledAudit()

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

updateScheduledAuditAsync()

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

updateSecurityProfile()

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

updateSecurityProfileAsync()

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

updateStream()

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

updateStreamAsync()

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

updateThing()

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

updateThingAsync()

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

updateThingGroup()

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

updateThingGroupAsync()

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

updateThingGroupsForThing()

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

updateThingGroupsForThingAsync()

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

updateTopicRuleDestination()

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

updateTopicRuleDestinationAsync()

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

validateSecurityProfileBehaviors()

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

validateSecurityProfileBehaviorsAsync()

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

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page