AcceptCertificateTransfer

$result = $client->acceptCertificateTransfer([/* ... */]);
$promise = $client->acceptCertificateTransferAsync([/* ... */]);

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

Requires permission to access the AcceptCertificateTransfer action.

Parameter Syntax

$result = $client->acceptCertificateTransfer([
    'certificateId' => '<string>', // REQUIRED
    'setAsActive' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

TransferAlreadyCompletedException:

You can't revert the certificate transfer because the transfer is already complete.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

AddThingToBillingGroup

$result = $client->addThingToBillingGroup([/* ... */]);
$promise = $client->addThingToBillingGroupAsync([/* ... */]);

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

Parameter Syntax

$result = $client->addThingToBillingGroup([
    'billingGroupArn' => '<string>',
    'billingGroupName' => '<string>',
    'thingArn' => '<string>',
    'thingName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

ResourceNotFoundException:

The specified resource does not exist.

AddThingToThingGroup

$result = $client->addThingToThingGroup([/* ... */]);
$promise = $client->addThingToThingGroupAsync([/* ... */]);

Adds a thing to a thing group.

Requires permission to access the AddThingToThingGroup action.

Parameter Syntax

$result = $client->addThingToThingGroup([
    'overrideDynamicGroups' => true || false,
    'thingArn' => '<string>',
    'thingGroupArn' => '<string>',
    'thingGroupName' => '<string>',
    'thingName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

ResourceNotFoundException:

The specified resource does not exist.

AssociateSbomWithPackageVersion

$result = $client->associateSbomWithPackageVersion([/* ... */]);
$promise = $client->associateSbomWithPackageVersionAsync([/* ... */]);

Associates the selected software bill of materials (SBOM) with a specific software package version.

Requires permission to access the AssociateSbomWithPackageVersion action.

Parameter Syntax

$result = $client->associateSbomWithPackageVersion([
    'clientToken' => '<string>',
    'packageName' => '<string>', // REQUIRED
    'sbom' => [ // REQUIRED
        's3Location' => [
            'bucket' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
    ],
    'versionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'packageName' => '<string>',
    'sbom' => [
        's3Location' => [
            'bucket' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
    ],
    'sbomValidationStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED',
    'versionName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The rate exceeds the limit.

ConflictException:

A resource with the same name already exists.

InternalServerException:

Internal error from the service that indicates an unexpected error or that the service is unavailable.

ValidationException:

The request is not valid.

ServiceQuotaExceededException:

A limit has been exceeded.

ResourceNotFoundException:

The specified resource does not exist.

AssociateTargetsWithJob

$result = $client->associateTargetsWithJob([/* ... */]);
$promise = $client->associateTargetsWithJobAsync([/* ... */]);

Associates a group with a continuous job. The following criteria must be met:

• The job must have been created with the targetSelection field set to "CONTINUOUS".

• The job status must currently be "IN_PROGRESS".

• The total number of targets associated with a job must not exceed 100.

Requires permission to access the AssociateTargetsWithJob action.

Parameter Syntax

$result = $client->associateTargetsWithJob([
    'comment' => '<string>',
    'jobId' => '<string>', // REQUIRED
    'namespaceId' => '<string>',
    'targets' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'jobArn' => '<string>',
    'jobId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

LimitExceededException:

A limit has been exceeded.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

AttachPolicy

$result = $client->attachPolicy([/* ... */]);
$promise = $client->attachPolicyAsync([/* ... */]);

Attaches the specified policy to the specified principal (certificate or other credential).

Requires permission to access the AttachPolicy action.

Parameter Syntax

$result = $client->attachPolicy([
    'policyName' => '<string>', // REQUIRED
    'target' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

LimitExceededException:

A limit has been exceeded.

AttachPrincipalPolicy

$result = $client->attachPrincipalPolicy([/* ... */]);
$promise = $client->attachPrincipalPolicyAsync([/* ... */]);

Attaches the specified policy to the specified principal (certificate or other credential).

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.

Requires permission to access the AttachPrincipalPolicy action.

Parameter Syntax

$result = $client->attachPrincipalPolicy([
    'policyName' => '<string>', // REQUIRED
    'principal' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

LimitExceededException:

A limit has been exceeded.

AttachSecurityProfile

$result = $client->attachSecurityProfile([/* ... */]);
$promise = $client->attachSecurityProfileAsync([/* ... */]);

Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.

Requires permission to access the AttachSecurityProfile action.

Parameter Syntax

$result = $client->attachSecurityProfile([
    'securityProfileName' => '<string>', // REQUIRED
    'securityProfileTargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

LimitExceededException:

A limit has been exceeded.

VersionConflictException:

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

AttachThingPrincipal

$result = $client->attachThingPrincipal([/* ... */]);
$promise = $client->attachThingPrincipalAsync([/* ... */]);

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal action.

Parameter Syntax

$result = $client->attachThingPrincipal([
    'principal' => '<string>', // REQUIRED
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CancelAuditMitigationActionsTask

$result = $client->cancelAuditMitigationActionsTask([/* ... */]);
$promise = $client->cancelAuditMitigationActionsTaskAsync([/* ... */]);

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

Requires permission to access the CancelAuditMitigationActionsTask action.

Parameter Syntax

$result = $client->cancelAuditMitigationActionsTask([
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CancelAuditTask

$result = $client->cancelAuditTask([/* ... */]);
$promise = $client->cancelAuditTaskAsync([/* ... */]);

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.

Requires permission to access the CancelAuditTask action.

Parameter Syntax

$result = $client->cancelAuditTask([
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CancelCertificateTransfer

$result = $client->cancelCertificateTransfer([/* ... */]);
$promise = $client->cancelCertificateTransferAsync([/* ... */]);

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

Requires permission to access the CancelCertificateTransfer action.

Parameter Syntax

$result = $client->cancelCertificateTransfer([
    'certificateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

TransferAlreadyCompletedException:

You can't revert the certificate transfer because the transfer is already complete.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CancelDetectMitigationActionsTask

$result = $client->cancelDetectMitigationActionsTask([/* ... */]);
$promise = $client->cancelDetectMitigationActionsTaskAsync([/* ... */]);

Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask action.

Parameter Syntax

$result = $client->cancelDetectMitigationActionsTask([
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CancelJob

$result = $client->cancelJob([/* ... */]);
$promise = $client->cancelJobAsync([/* ... */]);

Cancels a job.

Requires permission to access the CancelJob action.

Parameter Syntax

$result = $client->cancelJob([
    'comment' => '<string>',
    'force' => true || false,
    'jobId' => '<string>', // REQUIRED
    'reasonCode' => '<string>',
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'jobArn' => '<string>',
    'jobId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

LimitExceededException:

A limit has been exceeded.

CancelJobExecution

$result = $client->cancelJobExecution([/* ... */]);
$promise = $client->cancelJobExecutionAsync([/* ... */]);

Cancels the execution of a job for a given thing.

Requires permission to access the CancelJobExecution action.

Parameter Syntax

$result = $client->cancelJobExecution([
    'expectedVersion' => <integer>,
    'force' => true || false,
    'jobId' => '<string>', // REQUIRED
    'statusDetails' => ['<string>', ...],
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is not valid.

InvalidStateTransitionException:

An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is "IN_PROGRESS" without setting the force parameter.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

VersionConflictException:

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

ClearDefaultAuthorizer

$result = $client->clearDefaultAuthorizer([/* ... */]);
$promise = $client->clearDefaultAuthorizerAsync([/* ... */]);

Clears the default authorizer.

Requires permission to access the ClearDefaultAuthorizer action.

Parameter Syntax

$result = $client->clearDefaultAuthorizer([
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

ConfirmTopicRuleDestination

$result = $client->confirmTopicRuleDestination([/* ... */]);
$promise = $client->confirmTopicRuleDestinationAsync([/* ... */]);

Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

Requires permission to access the ConfirmTopicRuleDestination action.

Parameter Syntax

$result = $client->confirmTopicRuleDestination([
    'confirmationToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalException:

An unexpected error has occurred.

InvalidRequestException:

The request is not valid.

ServiceUnavailableException:

The service is temporarily unavailable.

UnauthorizedException:

You are not authorized to perform this operation.

ConflictingResourceUpdateException:

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

CreateAuditSuppression

$result = $client->createAuditSuppression([/* ... */]);
$promise = $client->createAuditSuppressionAsync([/* ... */]);

Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression action.

Parameter Syntax

$result = $client->createAuditSuppression([
    'checkName' => '<string>', // REQUIRED
    'clientRequestToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'expirationDate' => <integer || string || DateTime>,
    'resourceIdentifier' => [ // REQUIRED
        'account' => '<string>',
        'caCertificateId' => '<string>',
        'clientId' => '<string>',
        'cognitoIdentityPoolId' => '<string>',
        'deviceCertificateArn' => '<string>',
        'deviceCertificateId' => '<string>',
        'iamRoleArn' => '<string>',
        'issuerCertificateIdentifier' => [
            'issuerCertificateSerialNumber' => '<string>',
            'issuerCertificateSubject' => '<string>',
            'issuerId' => '<string>',
        ],
        'policyVersionIdentifier' => [
            'policyName' => '<string>',
            'policyVersionId' => '<string>',
        ],
        'roleAliasArn' => '<string>',
    ],
    'suppressIndefinitely' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

LimitExceededException:

A limit has been exceeded.

CreateAuthorizer

$result = $client->createAuthorizer([/* ... */]);
$promise = $client->createAuthorizerAsync([/* ... */]);

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Parameter Syntax

$result = $client->createAuthorizer([
    'authorizerFunctionArn' => '<string>', // REQUIRED
    'authorizerName' => '<string>', // REQUIRED
    'enableCachingForHttp' => true || false,
    'signingDisabled' => true || false,
    'status' => 'ACTIVE|INACTIVE',
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'tokenKeyName' => '<string>',
    'tokenSigningPublicKeys' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'authorizerArn' => '<string>',
    'authorizerName' => '<string>',
]

Result Details

Errors

ResourceAlreadyExistsException:

The resource already exists.

InvalidRequestException:

The request is not valid.

LimitExceededException:

A limit has been exceeded.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateBillingGroup

$result = $client->createBillingGroup([/* ... */]);
$promise = $client->createBillingGroupAsync([/* ... */]);

Creates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a ResourceAlreadyExistsException is thrown.

Requires permission to access the CreateBillingGroup action.

Parameter Syntax

$result = $client->createBillingGroup([
    'billingGroupName' => '<string>', // REQUIRED
    'billingGroupProperties' => [
        'billingGroupDescription' => '<string>',
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'billingGroupArn' => '<string>',
    'billingGroupId' => '<string>',
    'billingGroupName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CreateCertificateFromCsr

$result = $client->createCertificateFromCsr([/* ... */]);
$promise = $client->createCertificateFromCsrAsync([/* ... */]);

Creates an X.509 certificate using the specified certificate signing request.

Requires permission to access the CreateCertificateFromCsr action.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR.

You can also run the aws iot create-certificate-from-csr part of the command in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"

Parameter Syntax

$result = $client->createCertificateFromCsr([
    'certificateSigningRequest' => '<string>', // REQUIRED
    'setAsActive' => true || false,
]);

Parameter Details

Result Syntax

[
    'certificateArn' => '<string>',
    'certificateId' => '<string>',
    'certificatePem' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateCertificateProvider

$result = $client->createCertificateProvider([/* ... */]);
$promise = $client->createCertificateProviderAsync([/* ... */]);

Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.

Requires permission to access the CreateCertificateProvider action.

Parameter Syntax

$result = $client->createCertificateProvider([
    'accountDefaultForOperations' => ['<string>', ...], // REQUIRED
    'certificateProviderName' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'lambdaFunctionArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'certificateProviderArn' => '<string>',
    'certificateProviderName' => '<string>',
]

Result Details

Errors

LimitExceededException:

A limit has been exceeded.

ResourceAlreadyExistsException:

The resource already exists.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateCustomMetric

$result = $client->createCustomMetric([/* ... */]);
$promise = $client->createCustomMetricAsync([/* ... */]);

Use this API to define a Custom Metric published by your devices to Device Defender.

Requires permission to access the CreateCustomMetric action.

Parameter Syntax

$result = $client->createCustomMetric([
    'clientRequestToken' => '<string>', // REQUIRED
    'displayName' => '<string>',
    'metricName' => '<string>', // REQUIRED
    'metricType' => 'string-list|ip-address-list|number-list|number', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'metricArn' => '<string>',
    'metricName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

LimitExceededException:

A limit has been exceeded.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CreateDimension

$result = $client->createDimension([/* ... */]);
$promise = $client->createDimensionAsync([/* ... */]);

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

Requires permission to access the CreateDimension action.

Parameter Syntax

$result = $client->createDimension([
    'clientRequestToken' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'stringValues' => ['<string>', ...], // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'type' => 'TOPIC_FILTER', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Errors

InternalFailureException:

An unexpected error has occurred.

InvalidRequestException:

The request is not valid.

LimitExceededException:

A limit has been exceeded.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

CreateDomainConfiguration

$result = $client->createDomainConfiguration([/* ... */]);
$promise = $client->createDomainConfigurationAsync([/* ... */]);

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration action.

Parameter Syntax

$result = $client->createDomainConfiguration([
    'applicationProtocol' => 'SECURE_MQTT|MQTT_WSS|HTTPS|DEFAULT',
    'authenticationType' => 'CUSTOM_AUTH_X509|CUSTOM_AUTH|AWS_X509|AWS_SIGV4|DEFAULT',
    'authorizerConfig' => [
        'allowAuthorizerOverride' => true || false,
        'defaultAuthorizerName' => '<string>',
    ],
    'clientCertificateConfig' => [
        'clientCertificateCallbackArn' => '<string>',
    ],
    'domainConfigurationName' => '<string>', // REQUIRED
    'domainName' => '<string>',
    'serverCertificateArns' => ['<string>', ...],
    'serverCertificateConfig' => [
        'enableOCSPCheck' => true || false,
    ],
    'serviceType' => 'DATA|CREDENTIAL_PROVIDER|JOBS',
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'tlsConfig' => [
        'securityPolicy' => '<string>',
    ],
    'validationCertificateArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'domainConfigurationArn' => '<string>',
    'domainConfigurationName' => '<string>',
]

Result Details

Errors

LimitExceededException:

A limit has been exceeded.

CertificateValidationException:

The certificate is invalid.

ResourceAlreadyExistsException:

The resource already exists.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

InvalidRequestException:

The request is not valid.

UnauthorizedException:

You are not authorized to perform this operation.

ThrottlingException:

The rate exceeds the limit.

CreateDynamicThingGroup

$result = $client->createDynamicThingGroup([/* ... */]);
$promise = $client->createDynamicThingGroupAsync([/* ... */]);

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

Parameter Syntax

$result = $client->createDynamicThingGroup([
    'indexName' => '<string>',
    'queryString' => '<string>', // REQUIRED
    'queryVersion' => '<string>',
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'thingGroupName' => '<string>', // REQUIRED
    'thingGroupProperties' => [
        'attributePayload' => [
            'attributes' => ['<string>', ...],
            'merge' => true || false,
        ],
        'thingGroupDescription' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'indexName' => '<string>',
    'queryString' => '<string>',
    'queryVersion' => '<string>',
    'thingGroupArn' => '<string>',
    'thingGroupId' => '<string>',
    'thingGroupName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

InvalidQueryException:

The query is invalid.

LimitExceededException:

A limit has been exceeded.

CreateFleetMetric

$result = $client->createFleetMetric([/* ... */]);
$promise = $client->createFleetMetricAsync([/* ... */]);

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

Parameter Syntax

$result = $client->createFleetMetric([
    'aggregationField' => '<string>', // REQUIRED
    'aggregationType' => [ // REQUIRED
        'name' => 'Statistics|Percentiles|Cardinality', // REQUIRED
        'values' => ['<string>', ...],
    ],
    'description' => '<string>',
    'indexName' => '<string>',
    'metricName' => '<string>', // REQUIRED
    'period' => <integer>, // REQUIRED
    'queryString' => '<string>', // REQUIRED
    'queryVersion' => '<string>',
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'unit' => 'Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None',
]);

Parameter Details

Result Syntax

[
    'metricArn' => '<string>',
    'metricName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

LimitExceededException:

A limit has been exceeded.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The specified resource does not exist.

InvalidQueryException:

The query is invalid.

InvalidAggregationException:

The aggregation is invalid.

IndexNotReadyException:

The index is not ready.

CreateJob

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

Creates a job.

Requires permission to access the CreateJob action.

Parameter Syntax

$result = $client->createJob([
    'abortConfig' => [
        'criteriaList' => [ // REQUIRED
            [
                'action' => 'CANCEL', // REQUIRED
                'failureType' => 'FAILED|REJECTED|TIMED_OUT|ALL', // REQUIRED
                'minNumberOfExecutedThings' => <integer>, // REQUIRED
                'thresholdPercentage' => <float>, // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'destinationPackageVersions' => ['<string>', ...],
    'document' => '<string>',
    'documentParameters' => ['<string>', ...],
    'documentSource' => '<string>',
    'jobExecutionsRetryConfig' => [
        'criteriaList' => [ // REQUIRED
            [
                'failureType' => 'FAILED|TIMED_OUT|ALL', // REQUIRED
                'numberOfRetries' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
    'jobExecutionsRolloutConfig' => [
        'exponentialRate' => [
            'baseRatePerMinute' => <integer>, // REQUIRED
            'incrementFactor' => <float>, // REQUIRED
            'rateIncreaseCriteria' => [ // REQUIRED
                'numberOfNotifiedThings' => <integer>,
                'numberOfSucceededThings' => <integer>,
            ],
        ],
        'maximumPerMinute' => <integer>,
    ],
    'jobId' => '<string>', // REQUIRED
    'jobTemplateArn' => '<string>',
    'namespaceId' => '<string>',
    'presignedUrlConfig' => [
        'expiresInSec' => <integer>,
        'roleArn' => '<string>',
    ],
    'schedulingConfig' => [
        'endBehavior' => 'STOP_ROLLOUT|CANCEL|FORCE_CANCEL',
        'endTime' => '<string>',
        'maintenanceWindows' => [
            [
                'durationInMinutes' => <integer>, // REQUIRED
                'startTime' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'startTime' => '<string>',
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'targetSelection' => 'CONTINUOUS|SNAPSHOT',
    'targets' => ['<string>', ...], // REQUIRED
    'timeoutConfig' => [
        'inProgressTimeoutInMinutes' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'jobArn' => '<string>',
    'jobId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

ResourceAlreadyExistsException:

The resource already exists.

LimitExceededException:

A limit has been exceeded.

ThrottlingException:

The rate exceeds the limit.

ServiceUnavailableException:

The service is temporarily unavailable.

CreateJobTemplate

$result = $client->createJobTemplate([/* ... */]);
$promise = $client->createJobTemplateAsync([/* ... */]);

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Parameter Syntax

$result = $client->createJobTemplate([
    'abortConfig' => [
        'criteriaList' => [ // REQUIRED
            [
                'action' => 'CANCEL', // REQUIRED
                'failureType' => 'FAILED|REJECTED|TIMED_OUT|ALL', // REQUIRED
                'minNumberOfExecutedThings' => <integer>, // REQUIRED
                'thresholdPercentage' => <float>, // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>', // REQUIRED
    'destinationPackageVersions' => ['<string>', ...],
    'document' => '<string>',
    'documentSource' => '<string>',
    'jobArn' => '<string>',
    'jobExecutionsRetryConfig' => [
        'criteriaList' => [ // REQUIRED
            [
                'failureType' => 'FAILED|TIMED_OUT|ALL', // REQUIRED
                'numberOfRetries' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
    'jobExecutionsRolloutConfig' => [
        'exponentialRate' => [
            'baseRatePerMinute' => <integer>, // REQUIRED
            'incrementFactor' => <float>, // REQUIRED
            'rateIncreaseCriteria' => [ // REQUIRED
                'numberOfNotifiedThings' => <integer>,
                'numberOfSucceededThings' => <integer>,
            ],
        ],
        'maximumPerMinute' => <integer>,
    ],
    'jobTemplateId' => '<string>', // REQUIRED
    'maintenanceWindows' => [
        [
            'durationInMinutes' => <integer>, // REQUIRED
            'startTime' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'presignedUrlConfig' => [
        'expiresInSec' => <integer>,
        'roleArn' => '<string>',
    ],
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'timeoutConfig' => [
        'inProgressTimeoutInMinutes' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'jobTemplateArn' => '<string>',
    'jobTemplateId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

ConflictException:

A resource with the same name already exists.

LimitExceededException:

A limit has been exceeded.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CreateKeysAndCertificate

$result = $client->createKeysAndCertificate([/* ... */]);
$promise = $client->createKeysAndCertificateAsync([/* ... */]);

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Requires permission to access the CreateKeysAndCertificate action.

Parameter Syntax

$result = $client->createKeysAndCertificate([
    'setAsActive' => true || false,
]);

Parameter Details

Result Syntax

[
    'certificateArn' => '<string>',
    'certificateId' => '<string>',
    'certificatePem' => '<string>',
    'keyPair' => [
        'PrivateKey' => '<string>',
        'PublicKey' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateMitigationAction

$result = $client->createMitigationAction([/* ... */]);
$promise = $client->createMitigationActionAsync([/* ... */]);

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

Requires permission to access the CreateMitigationAction action.

Parameter Syntax

$result = $client->createMitigationAction([
    'actionName' => '<string>', // REQUIRED
    'actionParams' => [ // REQUIRED
        'addThingsToThingGroupParams' => [
            'overrideDynamicGroups' => true || false,
            'thingGroupNames' => ['<string>', ...], // REQUIRED
        ],
        'enableIoTLoggingParams' => [
            'logLevel' => 'DEBUG|INFO|ERROR|WARN|DISABLED', // REQUIRED
            'roleArnForLogging' => '<string>', // REQUIRED
        ],
        'publishFindingToSnsParams' => [
            'topicArn' => '<string>', // REQUIRED
        ],
        'replaceDefaultPolicyVersionParams' => [
            'templateName' => 'BLANK_POLICY', // REQUIRED
        ],
        'updateCACertificateParams' => [
            'action' => 'DEACTIVATE', // REQUIRED
        ],
        'updateDeviceCertificateParams' => [
            'action' => 'DEACTIVATE', // REQUIRED
        ],
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'actionArn' => '<string>',
    'actionId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

LimitExceededException:

A limit has been exceeded.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CreateOTAUpdate

$result = $client->createOTAUpdate([/* ... */]);
$promise = $client->createOTAUpdateAsync([/* ... */]);

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

Parameter Syntax

$result = $client->createOTAUpdate([
    'additionalParameters' => ['<string>', ...],
    'awsJobAbortConfig' => [
        'abortCriteriaList' => [ // REQUIRED
            [
                'action' => 'CANCEL', // REQUIRED
                'failureType' => 'FAILED|REJECTED|TIMED_OUT|ALL', // REQUIRED
                'minNumberOfExecutedThings' => <integer>, // REQUIRED
                'thresholdPercentage' => <float>, // REQUIRED
            ],
            // ...
        ],
    ],
    'awsJobExecutionsRolloutConfig' => [
        'exponentialRate' => [
            'baseRatePerMinute' => <integer>, // REQUIRED
            'incrementFactor' => <float>, // REQUIRED
            'rateIncreaseCriteria' => [ // REQUIRED
                'numberOfNotifiedThings' => <integer>,
                'numberOfSucceededThings' => <integer>,
            ],
        ],
        'maximumPerMinute' => <integer>,
    ],
    'awsJobPresignedUrlConfig' => [
        'expiresInSec' => <integer>,
    ],
    'awsJobTimeoutConfig' => [
        'inProgressTimeoutInMinutes' => <integer>,
    ],
    'description' => '<string>',
    'files' => [ // REQUIRED
        [
            'attributes' => ['<string>', ...],
            'codeSigning' => [
                'awsSignerJobId' => '<string>',
                'customCodeSigning' => [
                    'certificateChain' => [
                        'certificateName' => '<string>',
                        'inlineDocument' => '<string>',
                    ],
                    'hashAlgorithm' => '<string>',
                    'signature' => [
                        'inlineDocument' => <string || resource || Psr\Http\Message\StreamInterface>,
                    ],
                    'signatureAlgorithm' => '<string>',
                ],
                'startSigningJobParameter' => [
                    'destination' => [
                        's3Destination' => [
                            'bucket' => '<string>',
                            'prefix' => '<string>',
                        ],
                    ],
                    'signingProfileName' => '<string>',
                    'signingProfileParameter' => [
                        'certificateArn' => '<string>',
                        'certificatePathOnDevice' => '<string>',
                        'platform' => '<string>',
                    ],
                ],
            ],
            'fileLocation' => [
                's3Location' => [
                    'bucket' => '<string>',
                    'key' => '<string>',
                    'version' => '<string>',
                ],
                'stream' => [
                    'fileId' => <integer>,
                    'streamId' => '<string>',
                ],
            ],
            'fileName' => '<string>',
            'fileType' => <integer>,
            'fileVersion' => '<string>',
        ],
        // ...
    ],
    'otaUpdateId' => '<string>', // REQUIRED
    'protocols' => ['<string>', ...],
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'targetSelection' => 'CONTINUOUS|SNAPSHOT',
    'targets' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'awsIotJobArn' => '<string>',
    'awsIotJobId' => '<string>',
    'otaUpdateArn' => '<string>',
    'otaUpdateId' => '<string>',
    'otaUpdateStatus' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

LimitExceededException:

A limit has been exceeded.

ResourceNotFoundException:

The specified resource does not exist.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

InternalFailureException:

An unexpected error has occurred.

ServiceUnavailableException:

The service is temporarily unavailable.

CreatePackage

$result = $client->createPackage([/* ... */]);
$promise = $client->createPackageAsync([/* ... */]);

Creates an IoT software package that can be deployed to your fleet.

Requires permission to access the CreatePackage and GetIndexingConfiguration actions.

Parameter Syntax

$result = $client->createPackage([
    'clientToken' => '<string>',
    'description' => '<string>',
    'packageName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'packageArn' => '<string>',
    'packageName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The rate exceeds the limit.

ConflictException:

A resource with the same name already exists.

InternalServerException:

Internal error from the service that indicates an unexpected error or that the service is unavailable.

ValidationException:

The request is not valid.

ServiceQuotaExceededException:

A limit has been exceeded.

CreatePackageVersion

$result = $client->createPackageVersion([/* ... */]);
$promise = $client->createPackageVersionAsync([/* ... */]);

Creates a new version for an existing IoT software package.

Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.

Parameter Syntax

$result = $client->createPackageVersion([
    'artifact' => [
        's3Location' => [
            'bucket' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
    ],
    'attributes' => ['<string>', ...],
    'clientToken' => '<string>',
    'description' => '<string>',
    'packageName' => '<string>', // REQUIRED
    'recipe' => '<string>',
    'tags' => ['<string>', ...],
    'versionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attributes' => ['<string>', ...],
    'description' => '<string>',
    'errorReason' => '<string>',
    'packageName' => '<string>',
    'packageVersionArn' => '<string>',
    'status' => 'DRAFT|PUBLISHED|DEPRECATED',
    'versionName' => '<string>',
]

Result Details

Errors

ThrottlingException:

The rate exceeds the limit.

ConflictException:

A resource with the same name already exists.

InternalServerException:

Internal error from the service that indicates an unexpected error or that the service is unavailable.

ValidationException:

The request is not valid.

ServiceQuotaExceededException:

A limit has been exceeded.

CreatePolicy

$result = $client->createPolicy([/* ... */]);
$promise = $client->createPolicyAsync([/* ... */]);

Creates an IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

Requires permission to access the CreatePolicy action.

Parameter Syntax

$result = $client->createPolicy([
    'policyDocument' => '<string>', // REQUIRED
    'policyName' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'policyArn' => '<string>',
    'policyDocument' => '<string>',
    'policyName' => '<string>',
    'policyVersionId' => '<string>',
]

Result Details

Errors

ResourceAlreadyExistsException:

The resource already exists.

MalformedPolicyException:

The policy documentation is not valid.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreatePolicyVersion

$result = $client->createPolicyVersion([/* ... */]);
$promise = $client->createPolicyVersionAsync([/* ... */]);

Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Requires permission to access the CreatePolicyVersion action.

Parameter Syntax

$result = $client->createPolicyVersion([
    'policyDocument' => '<string>', // REQUIRED
    'policyName' => '<string>', // REQUIRED
    'setAsDefault' => true || false,
]);

Parameter Details

Result Syntax

[
    'isDefaultVersion' => true || false,
    'policyArn' => '<string>',
    'policyDocument' => '<string>',
    'policyVersionId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

MalformedPolicyException:

The policy documentation is not valid.

VersionsLimitExceededException:

The number of policy versions exceeds the limit.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateProvisioningClaim

$result = $client->createProvisioningClaim([/* ... */]);
$promise = $client->createProvisioningClaimAsync([/* ... */]);

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim action.

Parameter Syntax

$result = $client->createProvisioningClaim([
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'certificateId' => '<string>',
    'certificatePem' => '<string>',
    'expiration' => <DateTime>,
    'keyPair' => [
        'PrivateKey' => '<string>',
        'PublicKey' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateProvisioningTemplate

$result = $client->createProvisioningTemplate([/* ... */]);
$promise = $client->createProvisioningTemplateAsync([/* ... */]);

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

Parameter Syntax

$result = $client->createProvisioningTemplate([
    'description' => '<string>',
    'enabled' => true || false,
    'preProvisioningHook' => [
        'payloadVersion' => '<string>',
        'targetArn' => '<string>', // REQUIRED
    ],
    'provisioningRoleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'templateBody' => '<string>', // REQUIRED
    'templateName' => '<string>', // REQUIRED
    'type' => 'FLEET_PROVISIONING|JITP',
]);

Parameter Details

Result Syntax

[
    'defaultVersionId' => <integer>,
    'templateArn' => '<string>',
    'templateName' => '<string>',
]

Result Details

Errors

InternalFailureException:

An unexpected error has occurred.

InvalidRequestException:

The request is not valid.

LimitExceededException:

A limit has been exceeded.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ResourceAlreadyExistsException:

The resource already exists.

CreateProvisioningTemplateVersion

$result = $client->createProvisioningTemplateVersion([/* ... */]);
$promise = $client->createProvisioningTemplateVersionAsync([/* ... */]);

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

Parameter Syntax

$result = $client->createProvisioningTemplateVersion([
    'setAsDefault' => true || false,
    'templateBody' => '<string>', // REQUIRED
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'isDefaultVersion' => true || false,
    'templateArn' => '<string>',
    'templateName' => '<string>',
    'versionId' => <integer>,
]

Result Details

Errors

VersionsLimitExceededException:

The number of policy versions exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

ResourceNotFoundException:

The specified resource does not exist.

UnauthorizedException:

You are not authorized to perform this operation.

ConflictingResourceUpdateException:

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

CreateRoleAlias

$result = $client->createRoleAlias([/* ... */]);
$promise = $client->createRoleAliasAsync([/* ... */]);

Creates a role alias.

Requires permission to access the CreateRoleAlias action.

Parameter Syntax

$result = $client->createRoleAlias([
    'credentialDurationSeconds' => <integer>,
    'roleAlias' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'roleAlias' => '<string>',
    'roleAliasArn' => '<string>',
]

Result Details

Errors

ResourceAlreadyExistsException:

The resource already exists.

InvalidRequestException:

The request is not valid.

LimitExceededException:

A limit has been exceeded.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateScheduledAudit

$result = $client->createScheduledAudit([/* ... */]);
$promise = $client->createScheduledAuditAsync([/* ... */]);

Creates a scheduled audit that is run at a specified time interval.

Requires permission to access the CreateScheduledAudit action.

Parameter Syntax

$result = $client->createScheduledAudit([
    'dayOfMonth' => '<string>',
    'dayOfWeek' => 'SUN|MON|TUE|WED|THU|FRI|SAT',
    'frequency' => 'DAILY|WEEKLY|BIWEEKLY|MONTHLY', // REQUIRED
    'scheduledAuditName' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'targetCheckNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'scheduledAuditArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

LimitExceededException:

A limit has been exceeded.

CreateSecurityProfile

$result = $client->createSecurityProfile([/* ... */]);
$promise = $client->createSecurityProfileAsync([/* ... */]);

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

Parameter Syntax

$result = $client->createSecurityProfile([
    'additionalMetricsToRetain' => ['<string>', ...],
    'additionalMetricsToRetainV2' => [
        [
            'exportMetric' => true || false,
            'metric' => '<string>', // REQUIRED
            'metricDimension' => [
                'dimensionName' => '<string>', // REQUIRED
                'operator' => 'IN|NOT_IN',
            ],
        ],
        // ...
    ],
    'alertTargets' => [
        '<AlertTargetType>' => [
            'alertTargetArn' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'behaviors' => [
        [
            'criteria' => [
                'comparisonOperator' => 'less-than|less-than-equals|greater-than|greater-than-equals|in-cidr-set|not-in-cidr-set|in-port-set|not-in-port-set|in-set|not-in-set',
                'consecutiveDatapointsToAlarm' => <integer>,
                'consecutiveDatapointsToClear' => <integer>,
                'durationSeconds' => <integer>,
                'mlDetectionConfig' => [
                    'confidenceLevel' => 'LOW|MEDIUM|HIGH', // REQUIRED
                ],
                'statisticalThreshold' => [
                    'statistic' => '<string>',
                ],
                'value' => [
                    'cidrs' => ['<string>', ...],
                    'count' => <integer>,
                    'number' => <float>,
                    'numbers' => [<float>, ...],
                    'ports' => [<integer>, ...],
                    'strings' => ['<string>', ...],
                ],
            ],
            'exportMetric' => true || false,
            'metric' => '<string>',
            'metricDimension' => [
                'dimensionName' => '<string>', // REQUIRED
                'operator' => 'IN|NOT_IN',
            ],
            'name' => '<string>', // REQUIRED
            'suppressAlerts' => true || false,
        ],
        // ...
    ],
    'metricsExportConfig' => [
        'mqttTopic' => '<string>', // REQUIRED
        'roleArn' => '<string>', // REQUIRED
    ],
    'securityProfileDescription' => '<string>',
    'securityProfileName' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'securityProfileArn' => '<string>',
    'securityProfileName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CreateStream

$result = $client->createStream([/* ... */]);
$promise = $client->createStreamAsync([/* ... */]);

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

Requires permission to access the CreateStream action.

Parameter Syntax

$result = $client->createStream([
    'description' => '<string>',
    'files' => [ // REQUIRED
        [
            'fileId' => <integer>,
            's3Location' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
        ],
        // ...
    ],
    'roleArn' => '<string>', // REQUIRED
    'streamId' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'streamArn' => '<string>',
    'streamId' => '<string>',
    'streamVersion' => <integer>,
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

LimitExceededException:

A limit has been exceeded.

ResourceNotFoundException:

The specified resource does not exist.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

CreateThing

$result = $client->createThing([/* ... */]);
$promise = $client->createThingAsync([/* ... */]);

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

Requires permission to access the CreateThing action.

Parameter Syntax

$result = $client->createThing([
    'attributePayload' => [
        'attributes' => ['<string>', ...],
        'merge' => true || false,
    ],
    'billingGroupName' => '<string>',
    'thingName' => '<string>', // REQUIRED
    'thingTypeName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'thingArn' => '<string>',
    'thingId' => '<string>',
    'thingName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The specified resource does not exist.

CreateThingGroup

$result = $client->createThingGroup([/* ... */]);
$promise = $client->createThingGroupAsync([/* ... */]);

Create a thing group.

Requires permission to access the CreateThingGroup action.

Parameter Syntax

$result = $client->createThingGroup([
    'parentGroupName' => '<string>',
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'thingGroupName' => '<string>', // REQUIRED
    'thingGroupProperties' => [
        'attributePayload' => [
            'attributes' => ['<string>', ...],
            'merge' => true || false,
        ],
        'thingGroupDescription' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'thingGroupArn' => '<string>',
    'thingGroupId' => '<string>',
    'thingGroupName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

ThrottlingException:

The rate exceeds the limit.

InternalFailureException:

An unexpected error has occurred.

CreateThingType

$result = $client->createThingType([/* ... */]);
$promise = $client->createThingTypeAsync([/* ... */]);

Creates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a ResourceAlreadyExistsException is thrown.

Requires permission to access the CreateThingType action.

Parameter Syntax

$result = $client->createThingType([
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'thingTypeName' => '<string>', // REQUIRED
    'thingTypeProperties' => [
        'searchableAttributes' => ['<string>', ...],
        'thingTypeDescription' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'thingTypeArn' => '<string>',
    'thingTypeId' => '<string>',
    'thingTypeName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request is not valid.

ThrottlingException:

The rate exceeds the limit.

UnauthorizedException:

You are not authorized to perform this operation.

ServiceUnavailableException:

The service is temporarily unavailable.

InternalFailureException:

An unexpected error has occurred.

ResourceAlreadyExistsException:

The resource already exists.

CreateTopicRule

$result = $client->createTopicRule([/* ... */]);
$promise = $client->createTopicRuleAsync([/* ... */]);

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

Requires permission to access the CreateTopicRule action.

Parameter Syntax

$result = $client->createTopicRule([
    'ruleName' => '<string>', // REQUIRED
    'tags' => '<string>',
    'topicRulePayload' => [ // REQUIRED
        'actions' => [ // REQUIRED
            [
                'cloudwatchAlarm' => [
                    'alarmName' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                    'stateReason' => '<string>', // REQUIRED
                    'stateValue' => '<string>', // REQUIRED
                ],
                'cloudwatchLogs' => [
                    'batchMode' => true || false,
                    'logGroupName' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                ],
                'cloudwatchMetric' => [
                    'metricName' => '<string>', // REQUIRED
                    'metricNamespace' => '<string>', // REQUIRED
                    'metricTimestamp' => '<string>',
                    'metricUnit' => '<string>', // REQUIRED
                    'metricValue' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                ],
                'dynamoDB' => [
                    'hashKeyField' => '<string>', // REQUIRED
                    'hashKeyType' => 'STRING|NUMBER',
                    'hashKeyValue' => '<string>', // REQUIRED
                    'operation' => '<string>',
                    'payloadField' => '<string>',
                    'rangeKeyField' => '<string>',
                    'rangeKeyType' => 'STRING|NUMBER',
                    'rangeKeyValue' => '<string>',
                    'roleArn' => '<string>', // REQUIRED
                    'tableName' => '<string>', // REQUIRED
                ],
                'dynamoDBv2' => [
                    'putItem' => [ // REQUIRED
                        'tableName' => '<string>', // REQUIRED
                    ],
                    'roleArn' => '<string>', // REQUIRED
                ],
                'elasticsearch' => [
                    'endpoint' => '<string>', // REQUIRED
                    'id' => '<string>', // REQUIRED
                    'index' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                    'type' => '<string>', // REQUIRED
                ],
                'firehose' => [
                    'batchMode' => true || false,
                    'deliveryStreamName' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                    'separator' => '<string>',
                ],
                'http' => [
                    'auth' => [
                        'sigv4' => [
                            'roleArn' => '<string>', // REQUIRED
                            'serviceName' => '<string>', // REQUIRED
                            'signingRegion' => '<string>', // REQUIRED
                        ],
                    ],
                    'confirmationUrl' => '<string>',
                    'headers' => [
                        [
                            'key' => '<string>', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'url' => '<string>', // REQUIRED
                ],
                'iotAnalytics' => [
                    'batchMode' => true || false,
                    'channelArn' => '<string>',
                    'channelName' => '<string>',
                    'roleArn' => '<string>',
                ],
                'iotEvents' => [
                    'batchMode' => true || false,
                    'inputName' => '<string>', // REQUIRED
                    'messageId' => '<string>',
                    'roleArn' => '<string>', // REQUIRED
                ],
                'iotSiteWise' => [
                    'putAssetPropertyValueEntries' => [ // REQUIRED
                        [
                            'assetId' => '<string>',
                            'entryId' => '<string>',
                            'propertyAlias' => '<string>',
                            'propertyId' => '<string>',
                            'propertyValues' => [ // REQUIRED
                                [
                                    'quality' => '<string>',
                                    'timestamp' => [ // REQUIRED
                                        'offsetInNanos' => '<string>',
                                        'timeInSeconds' => '<string>', // REQUIRED
                                    ],
                                    'value' => [ // REQUIRED
                                        'booleanValue' => '<string>',
                                        'doubleValue' => '<string>',
                                        'integerValue' => '<string>',
                                        'stringValue' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'roleArn' => '<string>', // REQUIRED
                ],
                'kafka' => [
                    'clientProperties' => ['<string>', ...], // REQUIRED
                    'destinationArn' => '<string>', // REQUIRED
                    'headers' => [
                        [
                            'key' => '<string>', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'key' => '<string>',
                    'partition' => '<string>',
                    'topic' => '<string>', // REQUIRED
                ],
                'kinesis' => [
                    'partitionKey' => '<string>',
                    'roleArn' => '<string>', // REQUIRED
                    'streamName' => '<string>', // REQUIRED
                ],
                'lambda' => [
                    'functionArn' => '<string>', // REQUIRED
                ],
                'location' => [
                    'deviceId' => '<string>', // REQUIRED
                    'latitude' => '<string>', // REQUIRED
                    'longitude' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                    'timestamp' => [
                        'unit' => '<string>',
                        'value' => '<string>', // REQUIRED
                    ],
                    'trackerName' => '<string>', // REQUIRED
                ],
                'openSearch' => [
                    'endpoint' => '<string>', // REQUIRED
                    'id' => '<string>', // REQUIRED
                    'index' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                    'type' => '<string>', // REQUIRED
                ],
                'republish' => [
                    'headers' => [
                        'contentType' => '<string>',
                        'correlationData' => '<string>',
                        'messageExpiry' => '<string>',
                        'payloadFormatIndicator' => '<string>',
                        'responseTopic' => '<string>',
                        'userProperties' => [
                            [
                                'key' => '<string>', // REQUIRED
                                'value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'qos' => <integer>,
                    'roleArn' => '<string>', // REQUIRED
                    'topic' => '<string>', // REQUIRED
                ],
                's3' => [
                    'bucketName' => '<string>', // REQUIRED
                    'cannedAcl' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control|log-delivery-write',
                    'key' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                ],
                'salesforce' => [
                    'token' => '<string>', // REQUIRED
                    'url' => '<string>', // REQUIRED
                ],
                'sns' => [
                    'messageFormat' => 'RAW|JSON',
                    'roleArn' => '<string>', // REQUIRED
                    'targetArn' => '<string>', // REQUIRED
                ],
                'sqs' => [
                    'queueUrl' => '<string>', // REQUIRED
                    'roleArn' => '<string>', // REQUIRED
                    'useBase64' => true || false,
                ],
                'stepFunctions' => [
                    'executionNamePrefix' => '<string>',
                    'roleArn' => '<string>', // REQUIRED
                    'stateMachineName' => '<string>', // REQUIRED
                ],
                'timestream' => [
                    'databaseName' => '<string>', // REQUIRED
                    'dimensions' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'roleArn' => '<string>', // REQUIRED
                    'tableName' => '<string>', // REQUIRED
                    'timestamp' => [
                        'unit' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                ],
            ],
            // ...
        ],
        'awsIotSqlVersion' => '<string>',
        'description' => '<string>',
        'errorAction' => [
            'cloudwatchAlarm' => [
                'alarmName' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
                'stateReason' => '<string>', // REQUIRED
                'stateValue' => '<string>', // REQUIRED
            ],
            'cloudwatchLogs' => [
                'batchMode' => true || false,
                'logGroupName' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
            ],
            'cloudwatchMetric' => [
                'metricName' => '<string>', // REQUIRED
                'metricNamespace' => '<string>', // REQUIRED
                'metricTimestamp' => '<string>',
                'metricUnit' => '<string>', // REQUIRED
                'metricValue' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
            ],
            'dynamoDB' => [
                'hashKeyField' => '<string>', // REQUIRED
                'hashKeyType' => 'STRING|NUMBER',
                'hashKeyValue' => '<string>', // REQUIRED
                'operation' => '<string>',
                'payloadField' => '<string>',
                'rangeKeyField' => '<string>',
                'rangeKeyType' => 'STRING|NUMBER',
                'rangeKeyValue' => '<string>',
                'roleArn' => '<string>', // REQUIRED
                'tableName' => '<string>', // REQUIRED
            ],
            'dynamoDBv2' => [
                'putItem' => [ // REQUIRED
                    'tableName' => '<string>', // REQUIRED
                ],
                'roleArn' => '<string>', // REQUIRED
            ],
            'elasticsearch' => [
                'endpoint' => '<string>', // REQUIRED
                'id' => '<string>', // REQUIRED
                'index' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
                'type' => '<string>', // REQUIRED
            ],
            'firehose' => [
                'batchMode' => true || false,
                'deliveryStreamName' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
                'separator' => '<string>',
            ],
            'http' => [
                'auth' => [
                    'sigv4' => [
                        'roleArn' => '<string>', // REQUIRED
                        'serviceName' => '<string>', // REQUIRED
                        'signingRegion' => '<string>', // REQUIRED
                    ],
                ],
                'confirmationUrl' => '<string>',
                'headers' => [
                    [
                        'key' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'url' => '<string>', // REQUIRED
            ],
            'iotAnalytics' => [
                'batchMode' => true || false,
                'channelArn' => '<string>',
                'channelName' => '<string>',
                'roleArn' => '<string>',
            ],
            'iotEvents' => [
                'batchMode' => true || false,
                'inputName' => '<string>', // REQUIRED
                'messageId' => '<string>',
                'roleArn' => '<string>', // REQUIRED
            ],
            'iotSiteWise' => [
                'putAssetPropertyValueEntries' => [ // REQUIRED
                    [
                        'assetId' => '<string>',
                        'entryId' => '<string>',
                        'propertyAlias' => '<string>',
                        'propertyId' => '<string>',
                        'propertyValues' => [ // REQUIRED
                            [
                                'quality' => '<string>',
                                'timestamp' => [ // REQUIRED
                                    'offsetInNanos' => '<string>',
                                    'timeInSeconds' => '<string>', // REQUIRED
                                ],
                                'value' => [ // REQUIRED
                                    'booleanValue' => '<string>',
                                    'doubleValue' => '<string>',
                                    'integerValue' => '<string>',
                                    'stringValue' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'roleArn' => '<string>', // REQUIRED
            ],
            'kafka' => [
                'clientProperties' => ['<string>', ...], // REQUIRED
                'destinationArn' => '<string>', // REQUIRED
                'headers' => [
                    [
                        'key' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'key' => '<string>',
                'partition' => '<string>',
                'topic' => '<string>', // REQUIRED
            ],
            'kinesis' => [
                'partitionKey' => '<string>',
                'roleArn' => '<string>', // REQUIRED
                'streamName' => '<string>', // REQUIRED
            ],
            'lambda' => [
                'functionArn' => '<string>', // REQUIRED
            ],
            'location' => [
                'deviceId' => '<string>', // REQUIRED
                'latitude' => '<string>', // REQUIRED
                'longitude' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
                'timestamp' => [
                    'unit' => '<string>',
                    'value' => '<string>', // REQUIRED
                ],
                'trackerName' => '<string>', // REQUIRED
            ],
            'openSearch' => [
                'endpoint' => '<string>', // REQUIRED
                'id' => '<string>', // REQUIRED
                'index' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
                'type' => '<string>', // REQUIRED
            ],
            'republish' => [
                'headers' => [
                    'contentType' => '<string>',
                    'correlationData' => '<string>',
                    'messageExpiry' => '<string>',
                    'payloadFormatIndicator' => '<string>',
                    'responseTopic' => '<string>',
                    'userProperties' => [
                        [
                            'key' => '<string>', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'qos' => <integer>,
                'roleArn' => '<string>', // REQUIRED
                'topic' => '<string>', // REQUIRED
            ],
            's3' => [
                'bucketName' => '<string>', // REQUIRED
                'cannedAcl' => 'private|public-read|public-read-write|aws-exec-read|authenticated-read|bucket-owner-read|bucket-owner-full-control|log-delivery-write',
                'key' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
            ],
            'salesforce' => [
                'token' => '<string>', // REQUIRED
                'url' => '<string>', // REQUIRED
            ],
            'sns' => [
                'messageFormat' => 'RAW|JSON',
                'roleArn' => '<string>', // REQUIRED
                'targetArn' => '<string>', // REQUIRED
            ],
            'sqs' => [
                'queueUrl' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
                'useBase64' => true || false,
            ],
            'stepFunctions' => [
                'executionNamePrefix' => '<string>',
                'roleArn' => '<string>', // REQUIRED
                'stateMachineName' => '<string>', // REQUIRED
            ],
            'timestream' => [
                'databaseName' => '<string>', // REQUIRED
                'dimensions' => [ // REQUIRED
                    [
                        'name' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'roleArn' => '<string>', // REQUIRED
                'tableName' => '<string>', // REQUIRED
                'timestamp' => [
                    'unit' => '<string>', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
            ],
        ],
        'ruleDisabled' => true || false,
        'sql' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

SqlParseException:

The Rule-SQL expression can't be parsed correctly.

InternalException:

An unexpected error has occurred.

InvalidRequestException:

The request is not valid.

ResourceAlreadyExistsException:

The resource already exists.

ServiceUnavailableException:

The service is temporarily unavailable.

ConflictingResourceUpdateException:

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.