using AWSSDK.Iot.accept_certificate_transfer
accept_certificate_transfer([::AWSConfig], arguments::Dict)
accept_certificate_transfer([::AWSConfig]; certificateId=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "PATCH", "/accept-certificate-transfer/{certificateId}", arguments::Dict)
iot([::AWSConfig], "PATCH", "/accept-certificate-transfer/{certificateId}", certificateId=, <keyword arguments>)

AcceptCertificateTransfer Operation

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.

Arguments

certificateId = ::String – Required

The ID of the certificate.

setAsActive = ::Bool

Specifies whether the certificate is active.

Exceptions

ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.attach_principal_policy
attach_principal_policy([::AWSConfig], arguments::Dict)
attach_principal_policy([::AWSConfig]; policyName=, x-amzn-iot-principal=)

using AWSCore.Services.iot
iot([::AWSConfig], "PUT", "/principal-policies/{policyName}", arguments::Dict)
iot([::AWSConfig], "PUT", "/principal-policies/{policyName}", policyName=, x-amzn-iot-principal=)

AttachPrincipalPolicy Operation

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

Arguments

policyName = ::String – Required

The policy name.

x-amzn-iot-principal = ::String – Required

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or LimitExceededException.

See also: AWS API Documentation

using AWSSDK.Iot.attach_thing_principal
attach_thing_principal([::AWSConfig], arguments::Dict)
attach_thing_principal([::AWSConfig]; thingName=, x-amzn-principal=)

using AWSCore.Services.iot
iot([::AWSConfig], "PUT", "/things/{thingName}/principals", arguments::Dict)
iot([::AWSConfig], "PUT", "/things/{thingName}/principals", thingName=, x-amzn-principal=)

AttachThingPrincipal Operation

Attaches the specified principal to the specified thing.

Arguments

thingName = ::String – Required

The name of the thing.

x-amzn-principal = ::String – Required

The principal, such as a certificate or other credential.

Returns

AttachThingPrincipalResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.cancel_certificate_transfer
cancel_certificate_transfer([::AWSConfig], arguments::Dict)
cancel_certificate_transfer([::AWSConfig]; certificateId=)

using AWSCore.Services.iot
iot([::AWSConfig], "PATCH", "/cancel-certificate-transfer/{certificateId}", arguments::Dict)
iot([::AWSConfig], "PATCH", "/cancel-certificate-transfer/{certificateId}", certificateId=)

CancelCertificateTransfer Operation

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, AWS 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.

Arguments

certificateId = ::String – Required

The ID of the certificate.

Exceptions

ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.create_certificate_from_csr
create_certificate_from_csr([::AWSConfig], arguments::Dict)
create_certificate_from_csr([::AWSConfig]; certificateSigningRequest=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/certificates", arguments::Dict)
iot([::AWSConfig], "POST", "/certificates", certificateSigningRequest=, <keyword arguments>)

CreateCertificateFromCsr Operation

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

Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

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.

Assuming 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 AWS CLI command to create a certificate for the corresponding CSR.

The aws iot create-certificate-from-csr part of the command can also be run 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"

Arguments

certificateSigningRequest = ::String – Required

The certificate signing request (CSR).

setAsActive = ::Bool

Specifies whether the certificate is active.

Returns

CreateCertificateFromCsrResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.create_keys_and_certificate
create_keys_and_certificate([::AWSConfig], arguments::Dict)
create_keys_and_certificate([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/keys-and-certificate", arguments::Dict)
iot([::AWSConfig], "POST", "/keys-and-certificate", <keyword arguments>)

CreateKeysAndCertificate Operation

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

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

Arguments

setAsActive = ::Bool

Specifies whether the certificate is active.

Returns

CreateKeysAndCertificateResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.create_policy
create_policy([::AWSConfig], arguments::Dict)
create_policy([::AWSConfig]; policyName=, policyDocument=)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/policies/{policyName}", arguments::Dict)
iot([::AWSConfig], "POST", "/policies/{policyName}", policyName=, policyDocument=)

CreatePolicy Operation

Creates an AWS 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.

Arguments

policyName = ::String – Required

The policy name.

policyDocument = ::String – Required

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

Returns

CreatePolicyResponse

Exceptions

ResourceAlreadyExistsException, MalformedPolicyException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.create_policy_version
create_policy_version([::AWSConfig], arguments::Dict)
create_policy_version([::AWSConfig]; policyName=, policyDocument=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/policies/{policyName}/version", arguments::Dict)
iot([::AWSConfig], "POST", "/policies/{policyName}/version", policyName=, policyDocument=, <keyword arguments>)

CreatePolicyVersion Operation

Creates a new version of the specified AWS 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).

Arguments

policyName = ::String – Required

The policy name.

policyDocument = ::String – Required

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespaces

setAsDefault = ::Bool

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

Returns

CreatePolicyVersionResponse

Exceptions

ResourceNotFoundException, MalformedPolicyException, VersionsLimitExceededException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.create_thing
create_thing([::AWSConfig], arguments::Dict)
create_thing([::AWSConfig]; thingName=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/things/{thingName}", arguments::Dict)
iot([::AWSConfig], "POST", "/things/{thingName}", thingName=, <keyword arguments>)

CreateThing Operation

Creates a thing record in the thing registry.

Arguments

thingName = ::String – Required

The name of the thing to create.

thingTypeName = ::String

The name of the thing type associated with the new thing.

attributePayload = [ ... ]

The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

{\"attributes\":{\"string1\":\"string2\"}}

 attributePayload = [
        "attributes" =>  ::Dict{String,String},
        "merge" =>  ::Bool
    ]

Returns

CreateThingResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException or ResourceNotFoundException.

See also: AWS API Documentation

using AWSSDK.Iot.create_thing_type
create_thing_type([::AWSConfig], arguments::Dict)
create_thing_type([::AWSConfig]; thingTypeName=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/thing-types/{thingTypeName}", arguments::Dict)
iot([::AWSConfig], "POST", "/thing-types/{thingTypeName}", thingTypeName=, <keyword arguments>)

CreateThingType Operation

Creates a new thing type.

Arguments

thingTypeName = ::String – Required

The name of the thing type.

thingTypeProperties = [ ... ]

The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.

 thingTypeProperties = [
        "thingTypeDescription" =>  ::String,
        "searchableAttributes" =>  [::String, ...]
    ]

Returns

CreateThingTypeResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceAlreadyExistsException.

See also: AWS API Documentation

using AWSSDK.Iot.create_topic_rule
create_topic_rule([::AWSConfig], arguments::Dict)
create_topic_rule([::AWSConfig]; ruleName=, topicRulePayload=)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/rules/{ruleName}", arguments::Dict)
iot([::AWSConfig], "POST", "/rules/{ruleName}", ruleName=, topicRulePayload=)

CreateTopicRule Operation

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.

Arguments

ruleName = ::String – Required

The name of the rule.

topicRulePayload = [ ... ] – Required

The rule payload.

 topicRulePayload = [
        "sql" => <required> ::String,
        "description" =>  ::String,
        "actions" => <required> [[
            "dynamoDB" =>  [
                "tableName" => <required> ::String,
                "roleArn" => <required> ::String,
                "operation" =>  ::String,
                "hashKeyField" => <required> ::String,
                "hashKeyValue" => <required> ::String,
                "hashKeyType" =>  "STRING" or "NUMBER",
                "rangeKeyField" =>  ::String,
                "rangeKeyValue" =>  ::String,
                "rangeKeyType" =>  "STRING" or "NUMBER",
                "payloadField" =>  ::String
            ],
            "dynamoDBv2" =>  [
                "roleArn" =>  ::String,
                "putItem" =>  ["tableName" => <required> ::String]
            ],
            "lambda" =>  ["functionArn" => <required> ::String],
            "sns" =>  [
                "targetArn" => <required> ::String,
                "roleArn" => <required> ::String,
                "messageFormat" =>  "RAW" or "JSON"
            ],
            "sqs" =>  [
                "roleArn" => <required> ::String,
                "queueUrl" => <required> ::String,
                "useBase64" =>  ::Bool
            ],
            "kinesis" =>  [
                "roleArn" => <required> ::String,
                "streamName" => <required> ::String,
                "partitionKey" =>  ::String
            ],
            "republish" =>  [
                "roleArn" => <required> ::String,
                "topic" => <required> ::String
            ],
            "s3" =>  [
                "roleArn" => <required> ::String,
                "bucketName" => <required> ::String,
                "key" => <required> ::String,
                "cannedAcl" =>  "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" or "log-delivery-write"
            ],
            "firehose" =>  [
                "roleArn" => <required> ::String,
                "deliveryStreamName" => <required> ::String,
                "separator" =>  ::String
            ],
            "cloudwatchMetric" =>  [
                "roleArn" => <required> ::String,
                "metricNamespace" => <required> ::String,
                "metricName" => <required> ::String,
                "metricValue" => <required> ::String,
                "metricUnit" => <required> ::String,
                "metricTimestamp" =>  ::String
            ],
            "cloudwatchAlarm" =>  [
                "roleArn" => <required> ::String,
                "alarmName" => <required> ::String,
                "stateReason" => <required> ::String,
                "stateValue" => <required> ::String
            ],
            "elasticsearch" =>  [
                "roleArn" => <required> ::String,
                "endpoint" => <required> ::String,
                "index" => <required> ::String,
                "type" => <required> ::String,
                "id" => <required> ::String
            ],
            "salesforce" =>  [
                "token" => <required> ::String,
                "url" => <required> ::String
            ]
        ], ...],
        "ruleDisabled" =>  ::Bool,
        "awsIotSqlVersion" =>  ::String
    ]

Exceptions

SqlParseException, InternalException, InvalidRequestException, ResourceAlreadyExistsException or ServiceUnavailableException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_cacertificate
delete_cacertificate([::AWSConfig], arguments::Dict)
delete_cacertificate([::AWSConfig]; caCertificateId=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/cacertificate/{caCertificateId}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/cacertificate/{caCertificateId}", caCertificateId=)

DeleteCACertificate Operation

Deletes a registered CA certificate.

Arguments

caCertificateId = ::String – Required

The ID of the certificate to delete.

Returns

DeleteCACertificateResponse

Exceptions

InvalidRequestException, CertificateStateException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceNotFoundException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_certificate
delete_certificate([::AWSConfig], arguments::Dict)
delete_certificate([::AWSConfig]; certificateId=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/certificates/{certificateId}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/certificates/{certificateId}", certificateId=)

DeleteCertificate Operation

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

Arguments

certificateId = ::String – Required

The ID of the certificate.

Exceptions

CertificateStateException, DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceNotFoundException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_policy
delete_policy([::AWSConfig], arguments::Dict)
delete_policy([::AWSConfig]; policyName=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/policies/{policyName}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/policies/{policyName}", policyName=)

DeletePolicy Operation

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

Arguments

policyName = ::String – Required

The name of the policy to delete.

Exceptions

DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_policy_version
delete_policy_version([::AWSConfig], arguments::Dict)
delete_policy_version([::AWSConfig]; policyName=, policyVersionId=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/policies/{policyName}/version/{policyVersionId}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/policies/{policyName}/version/{policyVersionId}", policyName=, policyVersionId=)

DeletePolicyVersion Operation

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

Arguments

policyName = ::String – Required

The name of the policy.

policyVersionId = ::String – Required

The policy version ID.

Exceptions

DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_registration_code
delete_registration_code([::AWSConfig], arguments::Dict)
delete_registration_code([::AWSConfig]; )

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/registrationcode", arguments::Dict)
iot([::AWSConfig], "DELETE", "/registrationcode", )

DeleteRegistrationCode Operation

Deletes a CA certificate registration code.

Arguments

Returns

DeleteRegistrationCodeResponse

Exceptions

ThrottlingException, ResourceNotFoundException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_thing
delete_thing([::AWSConfig], arguments::Dict)
delete_thing([::AWSConfig]; thingName=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/things/{thingName}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/things/{thingName}", thingName=, <keyword arguments>)

DeleteThing Operation

Deletes the specified thing.

Arguments

thingName = ::String – Required

The name of the thing to delete.

expectedVersion = ::Int

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.

Returns

DeleteThingResponse

Exceptions

ResourceNotFoundException, VersionConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_thing_type
delete_thing_type([::AWSConfig], arguments::Dict)
delete_thing_type([::AWSConfig]; thingTypeName=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/thing-types/{thingTypeName}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/thing-types/{thingTypeName}", thingTypeName=)

DeleteThingType Operation

Deletes the specified thing type . You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

Arguments

thingTypeName = ::String – Required

The name of the thing type.

Returns

DeleteThingTypeResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.delete_topic_rule
delete_topic_rule([::AWSConfig], arguments::Dict)
delete_topic_rule([::AWSConfig]; ruleName=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/rules/{ruleName}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/rules/{ruleName}", ruleName=)

DeleteTopicRule Operation

Deletes the specified rule.

Arguments

ruleName = ::String – Required

The name of the rule.

Exceptions

InternalException, InvalidRequestException, ServiceUnavailableException or UnauthorizedException.

See also: AWS API Documentation

using AWSSDK.Iot.deprecate_thing_type
deprecate_thing_type([::AWSConfig], arguments::Dict)
deprecate_thing_type([::AWSConfig]; thingTypeName=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/thing-types/{thingTypeName}/deprecate", arguments::Dict)
iot([::AWSConfig], "POST", "/thing-types/{thingTypeName}/deprecate", thingTypeName=, <keyword arguments>)

DeprecateThingType Operation

Deprecates a thing type. You can not associate new things with deprecated thing type.

Arguments

thingTypeName = ::String – Required

The name of the thing type to deprecate.

undoDeprecate = ::Bool

Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

Returns

DeprecateThingTypeResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.describe_cacertificate
describe_cacertificate([::AWSConfig], arguments::Dict)
describe_cacertificate([::AWSConfig]; caCertificateId=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/cacertificate/{caCertificateId}", arguments::Dict)
iot([::AWSConfig], "GET", "/cacertificate/{caCertificateId}", caCertificateId=)

DescribeCACertificate Operation

Describes a registered CA certificate.

Arguments

caCertificateId = ::String – Required

The CA certificate identifier.

Returns

DescribeCACertificateResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceNotFoundException.

See also: AWS API Documentation

using AWSSDK.Iot.describe_certificate
describe_certificate([::AWSConfig], arguments::Dict)
describe_certificate([::AWSConfig]; certificateId=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/certificates/{certificateId}", arguments::Dict)
iot([::AWSConfig], "GET", "/certificates/{certificateId}", certificateId=)

DescribeCertificate Operation

Gets information about the specified certificate.

Arguments

certificateId = ::String – Required

The ID of the certificate.

Returns

DescribeCertificateResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceNotFoundException.

See also: AWS API Documentation

using AWSSDK.Iot.describe_endpoint
describe_endpoint([::AWSConfig], arguments::Dict)
describe_endpoint([::AWSConfig]; )

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/endpoint", arguments::Dict)
iot([::AWSConfig], "GET", "/endpoint", )

DescribeEndpoint Operation

Returns a unique endpoint specific to the AWS account making the call.

Arguments

Returns

DescribeEndpointResponse

Exceptions

InternalFailureException, UnauthorizedException or ThrottlingException.

See also: AWS API Documentation

using AWSSDK.Iot.describe_thing
describe_thing([::AWSConfig], arguments::Dict)
describe_thing([::AWSConfig]; thingName=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/things/{thingName}", arguments::Dict)
iot([::AWSConfig], "GET", "/things/{thingName}", thingName=)

DescribeThing Operation

Gets information about the specified thing.

Arguments

thingName = ::String – Required

The name of the thing.

Returns

DescribeThingResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.describe_thing_type
describe_thing_type([::AWSConfig], arguments::Dict)
describe_thing_type([::AWSConfig]; thingTypeName=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/thing-types/{thingTypeName}", arguments::Dict)
iot([::AWSConfig], "GET", "/thing-types/{thingTypeName}", thingTypeName=)

DescribeThingType Operation

Gets information about the specified thing type.

Arguments

thingTypeName = ::String – Required

The name of the thing type.

Returns

DescribeThingTypeResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.detach_principal_policy
detach_principal_policy([::AWSConfig], arguments::Dict)
detach_principal_policy([::AWSConfig]; policyName=, x-amzn-iot-principal=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/principal-policies/{policyName}", arguments::Dict)
iot([::AWSConfig], "DELETE", "/principal-policies/{policyName}", policyName=, x-amzn-iot-principal=)

DetachPrincipalPolicy Operation

Removes the specified policy from the specified certificate.

Arguments

policyName = ::String – Required

The name of the policy to detach.

x-amzn-iot-principal = ::String – Required

The principal.

If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.detach_thing_principal
detach_thing_principal([::AWSConfig], arguments::Dict)
detach_thing_principal([::AWSConfig]; thingName=, x-amzn-principal=)

using AWSCore.Services.iot
iot([::AWSConfig], "DELETE", "/things/{thingName}/principals", arguments::Dict)
iot([::AWSConfig], "DELETE", "/things/{thingName}/principals", thingName=, x-amzn-principal=)

DetachThingPrincipal Operation

Detaches the specified principal from the specified thing.

Arguments

thingName = ::String – Required

The name of the thing.

x-amzn-principal = ::String – Required

If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

Returns

DetachThingPrincipalResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.disable_topic_rule
disable_topic_rule([::AWSConfig], arguments::Dict)
disable_topic_rule([::AWSConfig]; ruleName=)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/rules/{ruleName}/disable", arguments::Dict)
iot([::AWSConfig], "POST", "/rules/{ruleName}/disable", ruleName=)

DisableTopicRule Operation

Disables the specified rule.

Arguments

ruleName = ::String – Required

The name of the rule to disable.

Exceptions

InternalException, InvalidRequestException, ServiceUnavailableException or UnauthorizedException.

See also: AWS API Documentation

using AWSSDK.Iot.enable_topic_rule
enable_topic_rule([::AWSConfig], arguments::Dict)
enable_topic_rule([::AWSConfig]; ruleName=)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/rules/{ruleName}/enable", arguments::Dict)
iot([::AWSConfig], "POST", "/rules/{ruleName}/enable", ruleName=)

EnableTopicRule Operation

Enables the specified rule.

Arguments

ruleName = ::String – Required

The name of the topic rule to enable.

Exceptions

InternalException, InvalidRequestException, ServiceUnavailableException or UnauthorizedException.

See also: AWS API Documentation

using AWSSDK.Iot.get_logging_options
get_logging_options([::AWSConfig], arguments::Dict)
get_logging_options([::AWSConfig]; )

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/loggingOptions", arguments::Dict)
iot([::AWSConfig], "GET", "/loggingOptions", )

GetLoggingOptions Operation

Gets the logging options.

Arguments

Returns

GetLoggingOptionsResponse

Exceptions

InternalException, InvalidRequestException or ServiceUnavailableException.

See also: AWS API Documentation

using AWSSDK.Iot.get_policy
get_policy([::AWSConfig], arguments::Dict)
get_policy([::AWSConfig]; policyName=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/policies/{policyName}", arguments::Dict)
iot([::AWSConfig], "GET", "/policies/{policyName}", policyName=)

GetPolicy Operation

Gets information about the specified policy with the policy document of the default version.

Arguments

policyName = ::String – Required

The name of the policy.

Returns

GetPolicyResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.get_policy_version
get_policy_version([::AWSConfig], arguments::Dict)
get_policy_version([::AWSConfig]; policyName=, policyVersionId=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/policies/{policyName}/version/{policyVersionId}", arguments::Dict)
iot([::AWSConfig], "GET", "/policies/{policyName}/version/{policyVersionId}", policyName=, policyVersionId=)

GetPolicyVersion Operation

Gets information about the specified policy version.

Arguments

policyName = ::String – Required

The name of the policy.

policyVersionId = ::String – Required

The policy version ID.

Returns

GetPolicyVersionResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.get_registration_code
get_registration_code([::AWSConfig], arguments::Dict)
get_registration_code([::AWSConfig]; )

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/registrationcode", arguments::Dict)
iot([::AWSConfig], "GET", "/registrationcode", )

GetRegistrationCode Operation

Gets a registration code used to register a CA certificate with AWS IoT.

Arguments

Returns

GetRegistrationCodeResponse

Exceptions

ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or InvalidRequestException.

See also: AWS API Documentation

using AWSSDK.Iot.get_topic_rule
get_topic_rule([::AWSConfig], arguments::Dict)
get_topic_rule([::AWSConfig]; ruleName=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/rules/{ruleName}", arguments::Dict)
iot([::AWSConfig], "GET", "/rules/{ruleName}", ruleName=)

GetTopicRule Operation

Gets information about the specified rule.

Arguments

ruleName = ::String – Required

The name of the rule.

Returns

GetTopicRuleResponse

Exceptions

InternalException, InvalidRequestException, ServiceUnavailableException or UnauthorizedException.

See also: AWS API Documentation

using AWSSDK.Iot.list_cacertificates
list_cacertificates([::AWSConfig], arguments::Dict)
list_cacertificates([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/cacertificates", arguments::Dict)
iot([::AWSConfig], "GET", "/cacertificates", <keyword arguments>)

ListCACertificates Operation

Lists the CA certificates registered for your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Arguments

pageSize = ::Int

The result page size.

marker = ::String

The marker for the next set of results.

isAscendingOrder = ::Bool

Determines the order of the results.

Returns

ListCACertificatesResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_certificates
list_certificates([::AWSConfig], arguments::Dict)
list_certificates([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/certificates", arguments::Dict)
iot([::AWSConfig], "GET", "/certificates", <keyword arguments>)

ListCertificates Operation

Lists the certificates registered in your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Arguments

pageSize = ::Int

The result page size.

marker = ::String

The marker for the next set of results.

isAscendingOrder = ::Bool

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

Returns

ListCertificatesResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_certificates_by_ca
list_certificates_by_ca([::AWSConfig], arguments::Dict)
list_certificates_by_ca([::AWSConfig]; caCertificateId=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/certificates-by-ca/{caCertificateId}", arguments::Dict)
iot([::AWSConfig], "GET", "/certificates-by-ca/{caCertificateId}", caCertificateId=, <keyword arguments>)

ListCertificatesByCA Operation

List the device certificates signed by the specified CA certificate.

Arguments

caCertificateId = ::String – Required

The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

pageSize = ::Int

The result page size.

marker = ::String

The marker for the next set of results.

isAscendingOrder = ::Bool

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

Returns

ListCertificatesByCAResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_outgoing_certificates
list_outgoing_certificates([::AWSConfig], arguments::Dict)
list_outgoing_certificates([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/certificates-out-going", arguments::Dict)
iot([::AWSConfig], "GET", "/certificates-out-going", <keyword arguments>)

ListOutgoingCertificates Operation

Lists certificates that are being transfered but not yet accepted.

Arguments

pageSize = ::Int

The result page size.

marker = ::String

The marker for the next set of results.

isAscendingOrder = ::Bool

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

Returns

ListOutgoingCertificatesResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_policies
list_policies([::AWSConfig], arguments::Dict)
list_policies([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/policies", arguments::Dict)
iot([::AWSConfig], "GET", "/policies", <keyword arguments>)

ListPolicies Operation

Lists your policies.

Arguments

marker = ::String

The marker for the next set of results.

pageSize = ::Int

The result page size.

isAscendingOrder = ::Bool

Specifies the order for results. If true, the results are returned in ascending creation order.

Returns

ListPoliciesResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_policy_principals
list_policy_principals([::AWSConfig], arguments::Dict)
list_policy_principals([::AWSConfig]; x-amzn-iot-policy=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/policy-principals", arguments::Dict)
iot([::AWSConfig], "GET", "/policy-principals", x-amzn-iot-policy=, <keyword arguments>)

ListPolicyPrincipals Operation

Lists the principals associated with the specified policy.

Arguments

x-amzn-iot-policy = ::String – Required

The policy name.

marker = ::String

The marker for the next set of results.

pageSize = ::Int

The result page size.

isAscendingOrder = ::Bool

Specifies the order for results. If true, the results are returned in ascending creation order.

Returns

ListPolicyPrincipalsResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_policy_versions
list_policy_versions([::AWSConfig], arguments::Dict)
list_policy_versions([::AWSConfig]; policyName=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/policies/{policyName}/version", arguments::Dict)
iot([::AWSConfig], "GET", "/policies/{policyName}/version", policyName=)

ListPolicyVersions Operation

Lists the versions of the specified policy and identifies the default version.

Arguments

policyName = ::String – Required

The policy name.

Returns

ListPolicyVersionsResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_principal_policies
list_principal_policies([::AWSConfig], arguments::Dict)
list_principal_policies([::AWSConfig]; x-amzn-iot-principal=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/principal-policies", arguments::Dict)
iot([::AWSConfig], "GET", "/principal-policies", x-amzn-iot-principal=, <keyword arguments>)

ListPrincipalPolicies Operation

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Arguments

x-amzn-iot-principal = ::String – Required

The principal.

marker = ::String

The marker for the next set of results.

pageSize = ::Int

The result page size.

isAscendingOrder = ::Bool

Specifies the order for results. If true, results are returned in ascending creation order.

Returns

ListPrincipalPoliciesResponse

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_principal_things
list_principal_things([::AWSConfig], arguments::Dict)
list_principal_things([::AWSConfig]; x-amzn-principal=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/principals/things", arguments::Dict)
iot([::AWSConfig], "GET", "/principals/things", x-amzn-principal=, <keyword arguments>)

ListPrincipalThings Operation

Lists the things associated with the specified principal.

Arguments

nextToken = ::String

The token for the next set of results, or null if there are no additional results.

maxResults = ::Int

The maximum number of results to return in this operation.

x-amzn-principal = ::String – Required

The principal.

Returns

ListPrincipalThingsResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceNotFoundException.

See also: AWS API Documentation

using AWSSDK.Iot.list_thing_principals
list_thing_principals([::AWSConfig], arguments::Dict)
list_thing_principals([::AWSConfig]; thingName=)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/things/{thingName}/principals", arguments::Dict)
iot([::AWSConfig], "GET", "/things/{thingName}/principals", thingName=)

ListThingPrincipals Operation

Lists the principals associated with the specified thing.

Arguments

thingName = ::String – Required

The name of the thing.

Returns

ListThingPrincipalsResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceNotFoundException.

See also: AWS API Documentation

using AWSSDK.Iot.list_thing_types
list_thing_types([::AWSConfig], arguments::Dict)
list_thing_types([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/thing-types", arguments::Dict)
iot([::AWSConfig], "GET", "/thing-types", <keyword arguments>)

ListThingTypes Operation

Lists the existing thing types.

Arguments

nextToken = ::String

The token for the next set of results, or null if there are no additional results.

maxResults = ::Int

The maximum number of results to return in this operation.

thingTypeName = ::String

The name of the thing type.

Returns

ListThingTypesResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_things
list_things([::AWSConfig], arguments::Dict)
list_things([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/things", arguments::Dict)
iot([::AWSConfig], "GET", "/things", <keyword arguments>)

ListThings Operation

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

Arguments

nextToken = ::String

The token for the next set of results, or null if there are no additional results.

maxResults = ::Int

The maximum number of results to return in this operation.

attributeName = ::String

The attribute name used to search for things.

attributeValue = ::String

The attribute value used to search for things.

thingTypeName = ::String

The name of the thing type used to search for things.

Returns

ListThingsResponse

Exceptions

InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.list_topic_rules
list_topic_rules([::AWSConfig], arguments::Dict)
list_topic_rules([::AWSConfig]; <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "GET", "/rules", arguments::Dict)
iot([::AWSConfig], "GET", "/rules", <keyword arguments>)

ListTopicRules Operation

Lists the rules for the specific topic.

Arguments

topic = ::String

The topic.

maxResults = ::Int

The maximum number of results to return.

nextToken = ::String

A token used to retrieve the next value.

ruleDisabled = ::Bool

Specifies whether the rule is disabled.

Returns

ListTopicRulesResponse

Exceptions

InternalException, InvalidRequestException or ServiceUnavailableException.

See also: AWS API Documentation

using AWSSDK.Iot.register_cacertificate
register_cacertificate([::AWSConfig], arguments::Dict)
register_cacertificate([::AWSConfig]; caCertificate=, verificationCertificate=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/cacertificate", arguments::Dict)
iot([::AWSConfig], "POST", "/cacertificate", caCertificate=, verificationCertificate=, <keyword arguments>)

RegisterCACertificate Operation

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.

Arguments

caCertificate = ::String – Required

The CA certificate.

verificationCertificate = ::String – Required

The private key verification certificate.

setAsActive = ::Bool

A boolean value that specifies if the CA certificate is set to active.

allowAutoRegistration = ::Bool

Allows this CA certificate to be used for auto registration of device certificates.

Returns

RegisterCACertificateResponse

Exceptions

ResourceAlreadyExistsException, RegistrationCodeValidationException, InvalidRequestException, CertificateValidationException, ThrottlingException, LimitExceededException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.register_certificate
register_certificate([::AWSConfig], arguments::Dict)
register_certificate([::AWSConfig]; certificatePem=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/certificate/register", arguments::Dict)
iot([::AWSConfig], "POST", "/certificate/register", certificatePem=, <keyword arguments>)

RegisterCertificate Operation

Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

Arguments

certificatePem = ::String – Required

The certificate data, in PEM format.

caCertificatePem = ::String

The CA certificate used to sign the device certificate being registered.

setAsActive = ::Bool

A boolean value that specifies if the CA certificate is set to active.

status = "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE" or "PENDING_ACTIVATION"

The status of the register certificate request.

Returns

RegisterCertificateResponse

Exceptions

ResourceAlreadyExistsException, InvalidRequestException, CertificateValidationException, CertificateStateException, CertificateConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.reject_certificate_transfer
reject_certificate_transfer([::AWSConfig], arguments::Dict)
reject_certificate_transfer([::AWSConfig]; certificateId=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "PATCH", "/reject-certificate-transfer/{certificateId}", arguments::Dict)
iot([::AWSConfig], "PATCH", "/reject-certificate-transfer/{certificateId}", certificateId=, <keyword arguments>)

RejectCertificateTransfer Operation

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

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

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

Arguments

certificateId = ::String – Required

The ID of the certificate.

rejectReason = ::String

The reason the certificate transfer was rejected.

Exceptions

ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.replace_topic_rule
replace_topic_rule([::AWSConfig], arguments::Dict)
replace_topic_rule([::AWSConfig]; ruleName=, topicRulePayload=)

using AWSCore.Services.iot
iot([::AWSConfig], "PATCH", "/rules/{ruleName}", arguments::Dict)
iot([::AWSConfig], "PATCH", "/rules/{ruleName}", ruleName=, topicRulePayload=)

ReplaceTopicRule Operation

Replaces the specified rule. You must specify all parameters for the new 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.

Arguments

ruleName = ::String – Required

The name of the rule.

topicRulePayload = [ ... ] – Required

The rule payload.

 topicRulePayload = [
        "sql" => <required> ::String,
        "description" =>  ::String,
        "actions" => <required> [[
            "dynamoDB" =>  [
                "tableName" => <required> ::String,
                "roleArn" => <required> ::String,
                "operation" =>  ::String,
                "hashKeyField" => <required> ::String,
                "hashKeyValue" => <required> ::String,
                "hashKeyType" =>  "STRING" or "NUMBER",
                "rangeKeyField" =>  ::String,
                "rangeKeyValue" =>  ::String,
                "rangeKeyType" =>  "STRING" or "NUMBER",
                "payloadField" =>  ::String
            ],
            "dynamoDBv2" =>  [
                "roleArn" =>  ::String,
                "putItem" =>  ["tableName" => <required> ::String]
            ],
            "lambda" =>  ["functionArn" => <required> ::String],
            "sns" =>  [
                "targetArn" => <required> ::String,
                "roleArn" => <required> ::String,
                "messageFormat" =>  "RAW" or "JSON"
            ],
            "sqs" =>  [
                "roleArn" => <required> ::String,
                "queueUrl" => <required> ::String,
                "useBase64" =>  ::Bool
            ],
            "kinesis" =>  [
                "roleArn" => <required> ::String,
                "streamName" => <required> ::String,
                "partitionKey" =>  ::String
            ],
            "republish" =>  [
                "roleArn" => <required> ::String,
                "topic" => <required> ::String
            ],
            "s3" =>  [
                "roleArn" => <required> ::String,
                "bucketName" => <required> ::String,
                "key" => <required> ::String,
                "cannedAcl" =>  "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" or "log-delivery-write"
            ],
            "firehose" =>  [
                "roleArn" => <required> ::String,
                "deliveryStreamName" => <required> ::String,
                "separator" =>  ::String
            ],
            "cloudwatchMetric" =>  [
                "roleArn" => <required> ::String,
                "metricNamespace" => <required> ::String,
                "metricName" => <required> ::String,
                "metricValue" => <required> ::String,
                "metricUnit" => <required> ::String,
                "metricTimestamp" =>  ::String
            ],
            "cloudwatchAlarm" =>  [
                "roleArn" => <required> ::String,
                "alarmName" => <required> ::String,
                "stateReason" => <required> ::String,
                "stateValue" => <required> ::String
            ],
            "elasticsearch" =>  [
                "roleArn" => <required> ::String,
                "endpoint" => <required> ::String,
                "index" => <required> ::String,
                "type" => <required> ::String,
                "id" => <required> ::String
            ],
            "salesforce" =>  [
                "token" => <required> ::String,
                "url" => <required> ::String
            ]
        ], ...],
        "ruleDisabled" =>  ::Bool,
        "awsIotSqlVersion" =>  ::String
    ]

Exceptions

SqlParseException, InternalException, InvalidRequestException, ServiceUnavailableException or UnauthorizedException.

See also: AWS API Documentation

using AWSSDK.Iot.set_default_policy_version
set_default_policy_version([::AWSConfig], arguments::Dict)
set_default_policy_version([::AWSConfig]; policyName=, policyVersionId=)

using AWSCore.Services.iot
iot([::AWSConfig], "PATCH", "/policies/{policyName}/version/{policyVersionId}", arguments::Dict)
iot([::AWSConfig], "PATCH", "/policies/{policyName}/version/{policyVersionId}", policyName=, policyVersionId=)

SetDefaultPolicyVersion Operation

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

Arguments

policyName = ::String – Required

The policy name.

policyVersionId = ::String – Required

The policy version ID.

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.set_logging_options
set_logging_options([::AWSConfig], arguments::Dict)
set_logging_options([::AWSConfig]; loggingOptionsPayload=)

using AWSCore.Services.iot
iot([::AWSConfig], "POST", "/loggingOptions", arguments::Dict)
iot([::AWSConfig], "POST", "/loggingOptions", loggingOptionsPayload=)

SetLoggingOptions Operation

Sets the logging options.

Arguments

loggingOptionsPayload = [ ... ] – Required

The logging options payload.

 loggingOptionsPayload = [
        "roleArn" => <required> ::String,
        "logLevel" =>  "DEBUG", "INFO", "ERROR", "WARN" or "DISABLED"
    ]

Exceptions

InternalException, InvalidRequestException or ServiceUnavailableException.

See also: AWS API Documentation

using AWSSDK.Iot.transfer_certificate
transfer_certificate([::AWSConfig], arguments::Dict)
transfer_certificate([::AWSConfig]; certificateId=, targetAwsAccount=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "PATCH", "/transfer-certificate/{certificateId}", arguments::Dict)
iot([::AWSConfig], "PATCH", "/transfer-certificate/{certificateId}", certificateId=, targetAwsAccount=, <keyword arguments>)

TransferCertificate Operation

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

Arguments

certificateId = ::String – Required

The ID of the certificate.

targetAwsAccount = ::String – Required

The AWS account.

transferMessage = ::String

The transfer message.

Returns

TransferCertificateResponse

Exceptions

InvalidRequestException, ResourceNotFoundException, CertificateStateException, TransferConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.update_cacertificate
update_cacertificate([::AWSConfig], arguments::Dict)
update_cacertificate([::AWSConfig]; caCertificateId=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "PUT", "/cacertificate/{caCertificateId}", arguments::Dict)
iot([::AWSConfig], "PUT", "/cacertificate/{caCertificateId}", caCertificateId=, <keyword arguments>)

UpdateCACertificate Operation

Updates a registered CA certificate.

Arguments

caCertificateId = ::String – Required

The CA certificate identifier.

newStatus = "ACTIVE" or "INACTIVE"

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

newAutoRegistrationStatus = "ENABLE" or "DISABLE"

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

Exceptions

ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.update_certificate
update_certificate([::AWSConfig], arguments::Dict)
update_certificate([::AWSConfig]; certificateId=, newStatus=)

using AWSCore.Services.iot
iot([::AWSConfig], "PUT", "/certificates/{certificateId}", arguments::Dict)
iot([::AWSConfig], "PUT", "/certificates/{certificateId}", certificateId=, newStatus=)

UpdateCertificate Operation

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

Arguments

certificateId = ::String – Required

The ID of the certificate.

newStatus = "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE" or "PENDING_ACTIVATION" – Required

The new status.

Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

Exceptions

ResourceNotFoundException, CertificateStateException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException or InternalFailureException.

See also: AWS API Documentation

using AWSSDK.Iot.update_thing
update_thing([::AWSConfig], arguments::Dict)
update_thing([::AWSConfig]; thingName=, <keyword arguments>)

using AWSCore.Services.iot
iot([::AWSConfig], "PATCH", "/things/{thingName}", arguments::Dict)
iot([::AWSConfig], "PATCH", "/things/{thingName}", thingName=, <keyword arguments>)

UpdateThing Operation

Updates the data for a thing.

Arguments

thingName = ::String – Required

The name of the thing to update.

thingTypeName = ::String

The name of the thing type.

attributePayload = [ ... ]

A list of thing attributes, a JSON string containing name-value pairs. For example:

{\"attributes\":{\"name1\":\"value2\"}}

This data is used to add new attributes or update existing attributes.

 attributePayload = [
        "attributes" =>  ::Dict{String,String},
        "merge" =>  ::Bool
    ]

expectedVersion = ::Int

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

removeThingType = ::Bool

Remove a thing type association. If true, the assocation is removed.

Returns

UpdateThingResponse

Exceptions

InvalidRequestException, VersionConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException or ResourceNotFoundException.

See also: AWS API Documentation