AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AcceptCertificateTransferRequest

Container for the parameters to the 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.

Class AcceptCertificateTransferResponse

This is the response object from the AcceptCertificateTransfer operation.

Class Action

Describes the actions associated with a rule.

Class AddThingToThingGroupRequest

Container for the parameters to the AddThingToThingGroup operation. Adds a thing to a thing group.

Class AddThingToThingGroupResponse

This is the response object from the AddThingToThingGroup operation.

Class Allowed

Contains information that allowed the authorization.

Class AssociateTargetsWithJobRequest

Container for the parameters to the AssociateTargetsWithJob operation. 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.

Class AssociateTargetsWithJobResponse

This is the response object from the AssociateTargetsWithJob operation.

Class AttachPolicyRequest

Container for the parameters to the AttachPolicy operation. Attaches a policy to the specified target.

Class AttachPolicyResponse

This is the response object from the AttachPolicy operation.

Class AttachPrincipalPolicyRequest

Container for the parameters to the AttachPrincipalPolicy operation. Attaches the specified policy to the specified principal (certificate or other credential).

Note: This API is deprecated. Please use AttachPolicy instead.

Class AttachPrincipalPolicyResponse

This is the response object from the AttachPrincipalPolicy operation.

Class AttachThingPrincipalRequest

Container for the parameters to the AttachThingPrincipal operation. Attaches the specified principal to the specified thing.

Class AttachThingPrincipalResponse

The output from the AttachThingPrincipal operation.

Class AttributePayload

The attribute payload.

Class AuthInfo

A collection of authorization information.

Class AuthorizerDescription

The authorizer description.

Class AuthorizerSummary

The authorizer summary.

Class AuthResult

The authorizer result.

Class CACertificate

A CA certificate.

Class CACertificateDescription

Describes a CA certificate.

Class CancelCertificateTransferRequest

Container for the parameters to the 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.

Class CancelCertificateTransferResponse

This is the response object from the CancelCertificateTransfer operation.

Class CancelJobExecutionRequest

Container for the parameters to the CancelJobExecution operation. Cancels the execution of a job for a given thing.

Class CancelJobExecutionResponse

This is the response object from the CancelJobExecution operation.

Class CancelJobRequest

Container for the parameters to the CancelJob operation. Cancels a job.

Class CancelJobResponse

This is the response object from the CancelJob operation.

Class Certificate

Information about a certificate.

Class CertificateConflictException

IoT exception

Class CertificateDescription

Describes a certificate.

Class CertificateStateException

IoT exception

Class CertificateValidationException

IoT exception

Class ClearDefaultAuthorizerRequest

Container for the parameters to the ClearDefaultAuthorizer operation. Clears the default authorizer.

Class ClearDefaultAuthorizerResponse

This is the response object from the ClearDefaultAuthorizer operation.

Class CloudwatchAlarmAction

Describes an action that updates a CloudWatch alarm.

Class CloudwatchMetricAction

Describes an action that captures a CloudWatch metric.

Class CodeSigning

Describes the method to use when code signing a file.

Class CodeSigningCertificateChain

Describes the certificate chain being used when code signing a file.

Class CodeSigningSignature

Describes the signature for a file.

Class Configuration

Configuration.

Class ConflictingResourceUpdateException

IoT exception

Class CreateAuthorizerRequest

Container for the parameters to the CreateAuthorizer operation. Creates an authorizer.

Class CreateAuthorizerResponse

This is the response object from the CreateAuthorizer operation.

Class CreateCertificateFromCsrRequest

Container for the parameters to the 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"

Class CreateCertificateFromCsrResponse

The output from the CreateCertificateFromCsr operation.

Class CreateJobRequest

Container for the parameters to the CreateJob operation. Creates a job.

Class CreateJobResponse

This is the response object from the CreateJob operation.

Class CreateKeysAndCertificateRequest

Container for the parameters to the 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.

Class CreateKeysAndCertificateResponse

The output of the CreateKeysAndCertificate operation.

Class CreateOTAUpdateRequest

Container for the parameters to the CreateOTAUpdate operation. Creates an AWS IoT OTAUpdate on a target group of things or groups.

Class CreateOTAUpdateResponse

This is the response object from the CreateOTAUpdate operation.

Class CreatePolicyRequest

Container for the parameters to the 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.

Class CreatePolicyResponse

The output from the CreatePolicy operation.

Class CreatePolicyVersionRequest

Container for the parameters to the 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).

Class CreatePolicyVersionResponse

The output of the CreatePolicyVersion operation.

Class CreateRoleAliasRequest

Container for the parameters to the CreateRoleAlias operation. Creates a role alias.

Class CreateRoleAliasResponse

This is the response object from the CreateRoleAlias operation.

Class CreateStreamRequest

Container for the parameters to the CreateStream operation. 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. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

Class CreateStreamResponse

This is the response object from the CreateStream operation.

Class CreateThingGroupRequest

Container for the parameters to the CreateThingGroup operation. Create a thing group.

Class CreateThingGroupResponse

This is the response object from the CreateThingGroup operation.

Class CreateThingRequest

Container for the parameters to the CreateThing operation. Creates a thing record in the registry.

Class CreateThingResponse

The output of the CreateThing operation.

Class CreateThingTypeRequest

Container for the parameters to the CreateThingType operation. Creates a new thing type.

Class CreateThingTypeResponse

The output of the CreateThingType operation.

Class CreateTopicRuleRequest

Container for the parameters to the 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.

Class CreateTopicRuleResponse

This is the response object from the CreateTopicRule operation.

Class CustomCodeSigning

Describes a custom method used to code sign a file.

Class DeleteAuthorizerRequest

Container for the parameters to the DeleteAuthorizer operation. Deletes an authorizer.

Class DeleteAuthorizerResponse

This is the response object from the DeleteAuthorizer operation.

Class DeleteCACertificateRequest

Container for the parameters to the DeleteCACertificate operation. Deletes a registered CA certificate.

Class DeleteCACertificateResponse

The output for the DeleteCACertificate operation.

Class DeleteCertificateRequest

Container for the parameters to the 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.

Class DeleteCertificateResponse

This is the response object from the DeleteCertificate operation.

Class DeleteConflictException

IoT exception

Class DeleteJobExecutionRequest

Container for the parameters to the DeleteJobExecution operation. Deletes a job execution.

Class DeleteJobExecutionResponse

This is the response object from the DeleteJobExecution operation.

Class DeleteJobRequest

Container for the parameters to the DeleteJob operation. Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.

Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.

Class DeleteJobResponse

This is the response object from the DeleteJob operation.

Class DeleteOTAUpdateRequest

Container for the parameters to the DeleteOTAUpdate operation. Delete an OTA update.

Class DeleteOTAUpdateResponse

This is the response object from the DeleteOTAUpdate operation.

Class DeletePolicyRequest

Container for the parameters to the 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.

Class DeletePolicyResponse

This is the response object from the DeletePolicy operation.

Class DeletePolicyVersionRequest

Container for the parameters to the 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.

Class DeletePolicyVersionResponse

This is the response object from the DeletePolicyVersion operation.

Class DeleteRegistrationCodeRequest

Container for the parameters to the DeleteRegistrationCode operation. Deletes a CA certificate registration code.

Class DeleteRegistrationCodeResponse

The output for the DeleteRegistrationCode operation.

Class DeleteRoleAliasRequest

Container for the parameters to the DeleteRoleAlias operation. Deletes a role alias

Class DeleteRoleAliasResponse

This is the response object from the DeleteRoleAlias operation.

Class DeleteStreamRequest

Container for the parameters to the DeleteStream operation. Deletes a stream.

Class DeleteStreamResponse

This is the response object from the DeleteStream operation.

Class DeleteThingGroupRequest

Container for the parameters to the DeleteThingGroup operation. Deletes a thing group.

Class DeleteThingGroupResponse

This is the response object from the DeleteThingGroup operation.

Class DeleteThingRequest

Container for the parameters to the DeleteThing operation. Deletes the specified thing.

Class DeleteThingResponse

The output of the DeleteThing operation.

Class DeleteThingTypeRequest

Container for the parameters to the 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.

Class DeleteThingTypeResponse

The output for the DeleteThingType operation.

Class DeleteTopicRuleRequest

Container for the parameters to the DeleteTopicRule operation. Deletes the rule.

Class DeleteTopicRuleResponse

This is the response object from the DeleteTopicRule operation.

Class DeleteV2LoggingLevelRequest

Container for the parameters to the DeleteV2LoggingLevel operation. Deletes a logging level.

Class DeleteV2LoggingLevelResponse

This is the response object from the DeleteV2LoggingLevel operation.

Class Denied

Contains information that denied the authorization.

Class DeprecateThingTypeRequest

Container for the parameters to the DeprecateThingType operation. Deprecates a thing type. You can not associate new things with deprecated thing type.

Class DeprecateThingTypeResponse

The output for the DeprecateThingType operation.

Class DescribeAuthorizerRequest

Container for the parameters to the DescribeAuthorizer operation. Describes an authorizer.

Class DescribeAuthorizerResponse

This is the response object from the DescribeAuthorizer operation.

Class DescribeCACertificateRequest

Container for the parameters to the DescribeCACertificate operation. Describes a registered CA certificate.

Class DescribeCACertificateResponse

The output from the DescribeCACertificate operation.

Class DescribeCertificateRequest

Container for the parameters to the DescribeCertificate operation. Gets information about the specified certificate.

Class DescribeCertificateResponse

The output of the DescribeCertificate operation.

Class DescribeDefaultAuthorizerRequest

Container for the parameters to the DescribeDefaultAuthorizer operation. Describes the default authorizer.

Class DescribeDefaultAuthorizerResponse

This is the response object from the DescribeDefaultAuthorizer operation.

Class DescribeEndpointRequest

Container for the parameters to the DescribeEndpoint operation. Returns a unique endpoint specific to the AWS account making the call.

Class DescribeEndpointResponse

The output from the DescribeEndpoint operation.

Class DescribeEventConfigurationsRequest

Container for the parameters to the DescribeEventConfigurations operation. Describes event configurations.

Class DescribeEventConfigurationsResponse

This is the response object from the DescribeEventConfigurations operation.

Class DescribeIndexRequest

Container for the parameters to the DescribeIndex operation. Describes a search index.

Class DescribeIndexResponse

This is the response object from the DescribeIndex operation.

Class DescribeJobExecutionRequest

Container for the parameters to the DescribeJobExecution operation. Describes a job execution.

Class DescribeJobExecutionResponse

This is the response object from the DescribeJobExecution operation.

Class DescribeJobRequest

Container for the parameters to the DescribeJob operation. Describes a job.

Class DescribeJobResponse

This is the response object from the DescribeJob operation.

Class DescribeRoleAliasRequest

Container for the parameters to the DescribeRoleAlias operation. Describes a role alias.

Class DescribeRoleAliasResponse

This is the response object from the DescribeRoleAlias operation.

Class DescribeStreamRequest

Container for the parameters to the DescribeStream operation. Gets information about a stream.

Class DescribeStreamResponse

This is the response object from the DescribeStream operation.

Class DescribeThingGroupRequest

Container for the parameters to the DescribeThingGroup operation. Describe a thing group.

Class DescribeThingGroupResponse

This is the response object from the DescribeThingGroup operation.

Class DescribeThingRegistrationTaskRequest

Container for the parameters to the DescribeThingRegistrationTask operation. Describes a bulk thing provisioning task.

Class DescribeThingRegistrationTaskResponse

This is the response object from the DescribeThingRegistrationTask operation.

Class DescribeThingRequest

Container for the parameters to the DescribeThing operation. Gets information about the specified thing.

Class DescribeThingResponse

The output from the DescribeThing operation.

Class DescribeThingTypeRequest

Container for the parameters to the DescribeThingType operation. Gets information about the specified thing type.

Class DescribeThingTypeResponse

The output for the DescribeThingType operation.

Class DetachPolicyRequest

Container for the parameters to the DetachPolicy operation. Detaches a policy from the specified target.

Class DetachPolicyResponse

This is the response object from the DetachPolicy operation.

Class DetachPrincipalPolicyRequest

Container for the parameters to the DetachPrincipalPolicy operation. Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

Class DetachPrincipalPolicyResponse

This is the response object from the DetachPrincipalPolicy operation.

Class DetachThingPrincipalRequest

Container for the parameters to the DetachThingPrincipal operation. Detaches the specified principal from the specified thing.

Class DetachThingPrincipalResponse

The output from the DetachThingPrincipal operation.

Class DisableTopicRuleRequest

Container for the parameters to the DisableTopicRule operation. Disables the rule.

Class DisableTopicRuleResponse

This is the response object from the DisableTopicRule operation.

Class DynamoDBAction

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

"hashKeyValue": "${topic(3)}"

The following field uses the timestamp:

"rangeKeyValue": "${timestamp()}"

Class DynamoDBv2Action

Describes an action to write to a DynamoDB table.

This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.

Class EffectivePolicy

The policy that has the effect on the authorization results.

Class ElasticsearchAction

Describes an action that writes data to an Amazon Elasticsearch Service domain.

Class EnableTopicRuleRequest

Container for the parameters to the EnableTopicRule operation. Enables the rule.

Class EnableTopicRuleResponse

This is the response object from the EnableTopicRule operation.

Class ErrorInfo

Error information.

Class ExplicitDeny

Information that explicitly denies authorization.

Class FirehoseAction

Describes an action that writes data to an Amazon Kinesis Firehose stream.

Class GetEffectivePoliciesRequest

Container for the parameters to the GetEffectivePolicies operation. Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

Class GetEffectivePoliciesResponse

This is the response object from the GetEffectivePolicies operation.

Class GetIndexingConfigurationRequest

Container for the parameters to the GetIndexingConfiguration operation. Gets the search configuration.

Class GetIndexingConfigurationResponse

This is the response object from the GetIndexingConfiguration operation.

Class GetJobDocumentRequest

Container for the parameters to the GetJobDocument operation. Gets a job document.

Class GetJobDocumentResponse

This is the response object from the GetJobDocument operation.

Class GetLoggingOptionsRequest

Container for the parameters to the GetLoggingOptions operation. Gets the logging options.

Class GetLoggingOptionsResponse

The output from the GetLoggingOptions operation.

Class GetOTAUpdateRequest

Container for the parameters to the GetOTAUpdate operation. Gets an OTA update.

Class GetOTAUpdateResponse

This is the response object from the GetOTAUpdate operation.

Class GetPolicyRequest

Container for the parameters to the GetPolicy operation. Gets information about the specified policy with the policy document of the default version.

Class GetPolicyResponse

The output from the GetPolicy operation.

Class GetPolicyVersionRequest

Container for the parameters to the GetPolicyVersion operation. Gets information about the specified policy version.

Class GetPolicyVersionResponse

The output from the GetPolicyVersion operation.

Class GetRegistrationCodeRequest

Container for the parameters to the GetRegistrationCode operation. Gets a registration code used to register a CA certificate with AWS IoT.

Class GetRegistrationCodeResponse

The output from the GetRegistrationCode operation.

Class GetTopicRuleRequest

Container for the parameters to the GetTopicRule operation. Gets information about the rule.

Class GetTopicRuleResponse

The output from the GetTopicRule operation.

Class GetV2LoggingOptionsRequest

Container for the parameters to the GetV2LoggingOptions operation. Gets the fine grained logging options.

Class GetV2LoggingOptionsResponse

This is the response object from the GetV2LoggingOptions operation.

Class GroupNameAndArn

The name and ARN of a group.

Class ImplicitDeny

Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

Class IndexNotReadyException

IoT exception

Class InternalException

IoT exception

Class InternalFailureException

IoT exception

Class InvalidQueryException

IoT exception

Class InvalidRequestException

IoT exception

Class InvalidResponseException

IoT exception

Class InvalidStateTransitionException

IoT exception

Class IotAnalyticsAction

Sends messge data to an AWS IoT Analytics channel.

Class Job

The Job object contains details about a job.

Class JobExecution

The job execution object represents the execution of a job on a particular device.

Class JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

Class JobExecutionStatusDetails

Details of the job execution status.

Class JobExecutionSummary

The job execution summary.

Class JobExecutionSummaryForJob

Contains a summary of information about job executions for a specific job.

Class JobExecutionSummaryForThing

The job execution summary for a thing.

Class JobProcessDetails

The job process details.

Class JobSummary

The job summary.

Class KeyPair

Describes a key pair.

Class KinesisAction

Describes an action to write data to an Amazon Kinesis stream.

Class LambdaAction

Describes an action to invoke a Lambda function.

Class LimitExceededException

IoT exception

Class ListAttachedPoliciesRequest

Container for the parameters to the ListAttachedPolicies operation. Lists the policies attached to the specified thing group.

Class ListAttachedPoliciesResponse

This is the response object from the ListAttachedPolicies operation.

Class ListAuthorizersRequest

Container for the parameters to the ListAuthorizers operation. Lists the authorizers registered in your account.

Class ListAuthorizersResponse

This is the response object from the ListAuthorizers operation.

Class ListCACertificatesRequest

Container for the parameters to the 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.

Class ListCACertificatesResponse

The output from the ListCACertificates operation.

Class ListCertificatesByCARequest

Container for the parameters to the ListCertificatesByCA operation. List the device certificates signed by the specified CA certificate.

Class ListCertificatesByCAResponse

The output of the ListCertificatesByCA operation.

Class ListCertificatesRequest

Container for the parameters to the 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.

Class ListCertificatesResponse

The output of the ListCertificates operation.

Class ListIndicesRequest

Container for the parameters to the ListIndices operation. Lists the search indices.

Class ListIndicesResponse

This is the response object from the ListIndices operation.

Class ListJobExecutionsForJobRequest

Container for the parameters to the ListJobExecutionsForJob operation. Lists the job executions for a job.

Class ListJobExecutionsForJobResponse

This is the response object from the ListJobExecutionsForJob operation.

Class ListJobExecutionsForThingRequest

Container for the parameters to the ListJobExecutionsForThing operation. Lists the job executions for the specified thing.

Class ListJobExecutionsForThingResponse

This is the response object from the ListJobExecutionsForThing operation.

Class ListJobsRequest

Container for the parameters to the ListJobs operation. Lists jobs.

Class ListJobsResponse

This is the response object from the ListJobs operation.

Class ListOTAUpdatesRequest

Container for the parameters to the ListOTAUpdates operation. Lists OTA updates.

Class ListOTAUpdatesResponse

This is the response object from the ListOTAUpdates operation.

Class ListOutgoingCertificatesRequest

Container for the parameters to the ListOutgoingCertificates operation. Lists certificates that are being transferred but not yet accepted.

Class ListOutgoingCertificatesResponse

The output from the ListOutgoingCertificates operation.

Class ListPoliciesRequest

Container for the parameters to the ListPolicies operation. Lists your policies.

Class ListPoliciesResponse

The output from the ListPolicies operation.

Class ListPolicyPrincipalsRequest

Container for the parameters to the ListPolicyPrincipals operation. Lists the principals associated with the specified policy.

Note: This API is deprecated. Please use ListTargetsForPolicy instead.

Class ListPolicyPrincipalsResponse

The output from the ListPolicyPrincipals operation.

Class ListPolicyVersionsRequest

Container for the parameters to the ListPolicyVersions operation. Lists the versions of the specified policy and identifies the default version.

Class ListPolicyVersionsResponse

The output from the ListPolicyVersions operation.

Class ListPrincipalPoliciesRequest

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

Note: This API is deprecated. Please use ListAttachedPolicies instead.

Class ListPrincipalPoliciesResponse

The output from the ListPrincipalPolicies operation.

Class ListPrincipalThingsRequest

Container for the parameters to the ListPrincipalThings operation. Lists the things associated with the specified principal.

Class ListPrincipalThingsResponse

The output from the ListPrincipalThings operation.

Class ListRoleAliasesRequest

Container for the parameters to the ListRoleAliases operation. Lists the role aliases registered in your account.

Class ListRoleAliasesResponse

This is the response object from the ListRoleAliases operation.

Class ListStreamsRequest

Container for the parameters to the ListStreams operation. Lists all of the streams in your AWS account.

Class ListStreamsResponse

This is the response object from the ListStreams operation.

Class ListTargetsForPolicyRequest

Container for the parameters to the ListTargetsForPolicy operation. List targets for the specified policy.

Class ListTargetsForPolicyResponse

This is the response object from the ListTargetsForPolicy operation.

Class ListThingGroupsForThingRequest

Container for the parameters to the ListThingGroupsForThing operation. List the thing groups to which the specified thing belongs.

Class ListThingGroupsForThingResponse

This is the response object from the ListThingGroupsForThing operation.

Class ListThingGroupsRequest

Container for the parameters to the ListThingGroups operation. List the thing groups in your account.

Class ListThingGroupsResponse

This is the response object from the ListThingGroups operation.

Class ListThingPrincipalsRequest

Container for the parameters to the ListThingPrincipals operation. Lists the principals associated with the specified thing.

Class ListThingPrincipalsResponse

The output from the ListThingPrincipals operation.

Class ListThingRegistrationTaskReportsRequest

Container for the parameters to the ListThingRegistrationTaskReports operation. Information about the thing registration tasks.

Class ListThingRegistrationTaskReportsResponse

This is the response object from the ListThingRegistrationTaskReports operation.

Class ListThingRegistrationTasksRequest

Container for the parameters to the ListThingRegistrationTasks operation. List bulk thing provisioning tasks.

Class ListThingRegistrationTasksResponse

This is the response object from the ListThingRegistrationTasks operation.

Class ListThingsInThingGroupRequest

Container for the parameters to the ListThingsInThingGroup operation. Lists the things in the specified group.

Class ListThingsInThingGroupResponse

This is the response object from the ListThingsInThingGroup operation.

Class ListThingsRequest

Container for the parameters to the 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.

Class ListThingsResponse

The output from the ListThings operation.

Class ListThingTypesRequest

Container for the parameters to the ListThingTypes operation. Lists the existing thing types.

Class ListThingTypesResponse

The output for the ListThingTypes operation.

Class ListTopicRulesRequest

Container for the parameters to the ListTopicRules operation. Lists the rules for the specific topic.

Class ListTopicRulesResponse

The output from the ListTopicRules operation.

Class ListV2LoggingLevelsRequest

Container for the parameters to the ListV2LoggingLevels operation. Lists logging levels.

Class ListV2LoggingLevelsResponse

This is the response object from the ListV2LoggingLevels operation.

Class LoggingOptionsPayload

Describes the logging options payload.

Class LogTarget

A log target.

Class LogTargetConfiguration

The target configuration.

Class MalformedPolicyException

IoT exception

Class NotConfiguredException

IoT exception

Class OTAUpdateFile

Describes a file to be associated with an OTA update.

Class OTAUpdateInfo

Information about an OTA update.

Class OTAUpdateSummary

An OTA update summary.

Class OutgoingCertificate

A certificate that has been transferred but not yet accepted.

Class Policy

Describes an AWS IoT policy.

Class PolicyVersion

Describes a policy version.

Class PresignedUrlConfig

Configuration for pre-signed S3 URLs.

Class PutItemInput

The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.

Class RegisterCACertificateRequest

Container for the parameters to the 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.

Class RegisterCACertificateResponse

The output from the RegisterCACertificateResponse operation.

Class RegisterCertificateRequest

Container for the parameters to the 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.

Class RegisterCertificateResponse

The output from the RegisterCertificate operation.

Class RegisterThingRequest

Container for the parameters to the RegisterThing operation. Provisions a thing.

Class RegisterThingResponse

This is the response object from the RegisterThing operation.

Class RegistrationCodeValidationException

IoT exception

Class RegistrationConfig

The registration configuration.

Class RejectCertificateTransferRequest

Container for the parameters to the 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.

Class RejectCertificateTransferResponse

This is the response object from the RejectCertificateTransfer operation.

Class RemoveThingFromThingGroupRequest

Container for the parameters to the RemoveThingFromThingGroup operation. Remove the specified thing from the specified group.

Class RemoveThingFromThingGroupResponse

This is the response object from the RemoveThingFromThingGroup operation.

Class ReplaceTopicRuleRequest

Container for the parameters to the ReplaceTopicRule operation. Replaces the 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.

Class ReplaceTopicRuleResponse

This is the response object from the ReplaceTopicRule operation.

Class RepublishAction

Describes an action to republish to another topic.

Class ResourceAlreadyExistsException

IoT exception

Class ResourceNotFoundException

IoT exception

Class ResourceRegistrationFailureException

IoT exception

Class RoleAliasDescription

Role alias description.

Class S3Action

Describes an action to write data to an Amazon S3 bucket.

Class S3Location

The location in S3 the contains the files to stream.

Class SalesforceAction

Describes an action to write a message to a Salesforce IoT Cloud Input Stream.

Class SearchIndexRequest

Container for the parameters to the SearchIndex operation. The query search index.

Class SearchIndexResponse

This is the response object from the SearchIndex operation.

Class ServiceUnavailableException

IoT exception

Class SetDefaultAuthorizerRequest

Container for the parameters to the SetDefaultAuthorizer operation. Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

Class SetDefaultAuthorizerResponse

This is the response object from the SetDefaultAuthorizer operation.

Class SetDefaultPolicyVersionRequest

Container for the parameters to the 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.

Class SetDefaultPolicyVersionResponse

This is the response object from the SetDefaultPolicyVersion operation.

Class SetLoggingOptionsRequest

Container for the parameters to the SetLoggingOptions operation. Sets the logging options.

Class SetLoggingOptionsResponse

This is the response object from the SetLoggingOptions operation.

Class SetV2LoggingLevelRequest

Container for the parameters to the SetV2LoggingLevel operation. Sets the logging level.

Class SetV2LoggingLevelResponse

This is the response object from the SetV2LoggingLevel operation.

Class SetV2LoggingOptionsRequest

Container for the parameters to the SetV2LoggingOptions operation. Sets the logging options for the V2 logging service.

Class SetV2LoggingOptionsResponse

This is the response object from the SetV2LoggingOptions operation.

Class SnsAction

Describes an action to publish to an Amazon SNS topic.

Class SqlParseException

IoT exception

Class SqsAction

Describes an action to publish data to an Amazon SQS queue.

Class StartThingRegistrationTaskRequest

Container for the parameters to the StartThingRegistrationTask operation. Creates a bulk thing provisioning task.

Class StartThingRegistrationTaskResponse

This is the response object from the StartThingRegistrationTask operation.

Class StopThingRegistrationTaskRequest

Container for the parameters to the StopThingRegistrationTask operation. Cancels a bulk thing provisioning task.

Class StopThingRegistrationTaskResponse

This is the response object from the StopThingRegistrationTask operation.

Class Stream

Describes a group of files that can be streamed.

Class StreamFile

Represents a file to stream.

Class StreamInfo

Information about a stream.

Class StreamSummary

A summary of a stream.

Class TestAuthorizationRequest

Container for the parameters to the TestAuthorization operation. Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

Class TestAuthorizationResponse

This is the response object from the TestAuthorization operation.

Class TestInvokeAuthorizerRequest

Container for the parameters to the TestInvokeAuthorizer operation. Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.

Class TestInvokeAuthorizerResponse

This is the response object from the TestInvokeAuthorizer operation.

Class ThingAttribute

The properties of the thing, including thing name, thing type name, and a list of thing attributes.

Class ThingDocument

The thing search index document.

Class ThingGroupMetadata

Thing group metadata.

Class ThingGroupProperties

Thing group properties.

Class ThingIndexingConfiguration

Thing indexing configuration.

Class ThingTypeDefinition

The definition of the thing type, including thing type name and description.

Class ThingTypeMetadata

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when time was deprecated.

Class ThingTypeProperties

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

Class ThrottlingException

IoT exception

Class TopicRule

Describes a rule.

Class TopicRuleListItem

Describes a rule.

Class TopicRulePayload

Describes a rule.

Class TransferAlreadyCompletedException

IoT exception

Class TransferCertificateRequest

Container for the parameters to the 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.

Class TransferCertificateResponse

The output from the TransferCertificate operation.

Class TransferConflictException

IoT exception

Class TransferData

Data used to transfer a certificate to an AWS account.

Class UnauthorizedException

IoT exception

Class UpdateAuthorizerRequest

Container for the parameters to the UpdateAuthorizer operation. Updates an authorizer.

Class UpdateAuthorizerResponse

This is the response object from the UpdateAuthorizer operation.

Class UpdateCACertificateRequest

Container for the parameters to the UpdateCACertificate operation. Updates a registered CA certificate.

Class UpdateCACertificateResponse

This is the response object from the UpdateCACertificate operation.

Class UpdateCertificateRequest

Container for the parameters to the 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.

Class UpdateCertificateResponse

This is the response object from the UpdateCertificate operation.

Class UpdateEventConfigurationsRequest

Container for the parameters to the UpdateEventConfigurations operation. Updates the event configurations.

Class UpdateEventConfigurationsResponse

This is the response object from the UpdateEventConfigurations operation.

Class UpdateIndexingConfigurationRequest

Container for the parameters to the UpdateIndexingConfiguration operation. Updates the search configuration.

Class UpdateIndexingConfigurationResponse

This is the response object from the UpdateIndexingConfiguration operation.

Class UpdateRoleAliasRequest

Container for the parameters to the UpdateRoleAlias operation. Updates a role alias.

Class UpdateRoleAliasResponse

This is the response object from the UpdateRoleAlias operation.

Class UpdateStreamRequest

Container for the parameters to the UpdateStream operation. Updates an existing stream. The stream version will be incremented by one.

Class UpdateStreamResponse

This is the response object from the UpdateStream operation.

Class UpdateThingGroupRequest

Container for the parameters to the UpdateThingGroup operation. Update a thing group.

Class UpdateThingGroupResponse

This is the response object from the UpdateThingGroup operation.

Class UpdateThingGroupsForThingRequest

Container for the parameters to the UpdateThingGroupsForThing operation. Updates the groups to which the thing belongs.

Class UpdateThingGroupsForThingResponse

This is the response object from the UpdateThingGroupsForThing operation.

Class UpdateThingRequest

Container for the parameters to the UpdateThing operation. Updates the data for a thing.

Class UpdateThingResponse

The output from the UpdateThing operation.

Class VersionConflictException

IoT exception

Class VersionsLimitExceededException

IoT exception