C# (CSharp) Amazon.IoT.Model Пространство имен

Пространства имен

Amazon.IoT.Model.Internal

Классы

Имя Описание
Action Describes the actions associated with a rule.
AttachPrincipalPolicyRequest Container for the parameters to the AttachPrincipalPolicy operation. Attaches the specified policy to the specified principal (certificate or other credential).
AttachThingPrincipalRequest Container for the parameters to the AttachThingPrincipal operation. Attaches the specified principal to the specified thing.
AttributePayload The attribute payload.
CACertificate A CA certificate.
CACertificateDescription Describes a CA certificate.
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.

Certificate Information about a certificate.
CertificateConflictException
CertificateDescription Describes a certificate.
CertificateStateException
CertificateValidationException
CloudwatchAlarmAction Describes an action that updates a CloudWatch alarm.
CloudwatchMetricAction Describes an action that captures a CloudWatch metric.
CreateCertificateFromCsrRequest Container for the parameters to the CreateCertificateFromCsr operation. Creates an X.509 certificate using the specified certificate signing request.

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"

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.

CreateKeysAndCertificateResponse The output of the CreateKeysAndCertificate operation.
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.

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).

CreateThingRequest Container for the parameters to the CreateThing operation. Creates a thing record in the thing registry.
CreateThingResponse The output of the CreateThing operation.
CreateThingTypeRequest Container for the parameters to the CreateThingType operation. Creates a new thing type.
CreateThingTypeResponse The output of the CreateThingType operation.
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.
DeleteCACertificateRequest Container for the parameters to the DeleteCACertificate operation. Deletes a registered CA certificate.
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.

DeleteConflictException
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.

DeleteThingRequest Container for the parameters to the DeleteThing operation. Deletes the specified thing.
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.
DeprecateThingTypeRequest Container for the parameters to the DeprecateThingType operation. Deprecates a thing type. You can not associate new things with deprecated thing type.
DescribeCACertificateRequest Container for the parameters to the DescribeCACertificate operation. Describes a registered CA certificate.
DescribeCACertificateResponse The output from the DescribeCACertificate operation.
DescribeThingResponse The output from the DescribeThing operation.
DescribeThingTypeRequest Container for the parameters to the DescribeThingType operation. Gets information about the specified thing type.
DescribeThingTypeResponse The output for the DescribeThingType operation.
DetachPrincipalPolicyRequest Container for the parameters to the DetachPrincipalPolicy operation. Removes the specified policy from the specified certificate.
DisableTopicRuleRequest Container for the parameters to the DisableTopicRule operation. Disables the specified rule.
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()}"

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.

ElasticsearchAction Describes an action that writes data to an Amazon Elasticsearch Service domain.
FirehoseAction Describes an action that writes data to an Amazon Kinesis Firehose stream.
GetRegistrationCodeResponse The output from the GetRegistrationCode operation.
InternalException
InternalFailureException
InvalidRequestException
KinesisAction Describes an action to write data to an Amazon Kinesis stream.
LambdaAction Describes an action to invoke a Lambda function.
LimitExceededException
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.

ListCACertificatesResponse The output from the ListCACertificates operation.
ListCertificatesByCARequest Container for the parameters to the ListCertificatesByCA operation. List the device certificates signed by the specified CA certificate.
ListCertificatesByCAResponse The output of the ListCertificatesByCA operation.
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.

ListOutgoingCertificatesRequest Container for the parameters to the ListOutgoingCertificates operation. Lists certificates that are being transfered but not yet accepted.
ListOutgoingCertificatesResponse The output from the ListOutgoingCertificates operation.
ListPolicyPrincipalsRequest Container for the parameters to the ListPolicyPrincipals operation. Lists the principals associated with the specified policy.
ListPolicyPrincipalsResponse The output from the ListPolicyPrincipals operation.
ListPolicyVersionsRequest Container for the parameters to the ListPolicyVersions operation. Lists the versions of the specified policy and identifies the default version.
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.
ListPrincipalThingsRequest Container for the parameters to the ListPrincipalThings operation. Lists the things associated with the specified principal.
ListPrincipalThingsResponse The output from the ListPrincipalThings operation.
ListThingPrincipalsResponse The output from the ListThingPrincipals operation.
ListThingTypesRequest Container for the parameters to the ListThingTypes operation. Lists the existing thing types.
ListThingTypesResponse The output for the ListThingTypes operation.
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.
ListThingsResponse The output from the ListThings operation.
MalformedPolicyException
OutgoingCertificate A certificate that has been transfered but not yet accepted.
PutItemInput The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
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 and public key. 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.
RegisterCACertificateResponse The output from the RegisterCACertificateResponse operation.
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.
RegisterCertificateResponse The output from the RegisterCertificate operation.
RegistrationCodeValidationException
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.

ReplaceTopicRuleRequest Container for the parameters to the 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.
ResourceAlreadyExistsException
ResourceNotFoundException
S3Action Describes an action to write data to an Amazon S3 bucket.
ServiceUnavailableException
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.
SnsAction Describes an action to publish to an Amazon SNS topic.
SqlParseException
SqsAction Describes an action to publish data to an Amazon SQS queue.
ThingAttribute The properties of the thing, including thing name, thing type name, and a list of thing attributes.
ThingTypeDefinition The definition of the thing type, including thing type name and description.
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.
ThingTypeProperties The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.
ThrottlingException
TopicRule Describes a rule.
TransferAlreadyCompletedException
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.

TransferConflictException
TransferData Data used to transfer a certificate to an AWS account.
UnauthorizedException
UpdateCACertificateRequest Container for the parameters to the UpdateCACertificate operation. Updates a registered CA certificate.
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.

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