@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSIot extends Object implements AWSIot
AWSIot
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public void setEndpoint(String endpoint)
AWSIot
Callers can pass in just the endpoint (ex: "iot.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://iot.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSIot
endpoint
- The endpoint (ex: "iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://iot.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSIot
AWSIot.setEndpoint(String)
, sets the regional endpoint for this client's service calls.
Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSIot
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AcceptCertificateTransferResult acceptCertificateTransfer(AcceptCertificateTransferRequest request)
AWSIot
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.
acceptCertificateTransfer
in interface AWSIot
request
- The input for the AcceptCertificateTransfer operation.public AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest request)
AWSIot
Adds a thing to a thing group.
addThingToThingGroup
in interface AWSIot
public AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest request)
AWSIot
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.
associateTargetsWithJob
in interface AWSIot
public AttachPolicyResult attachPolicy(AttachPolicyRequest request)
AWSIot
Attaches a policy to the specified target.
attachPolicy
in interface AWSIot
@Deprecated public AttachPrincipalPolicyResult attachPrincipalPolicy(AttachPrincipalPolicyRequest request)
AWSIot
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
attachPrincipalPolicy
in interface AWSIot
request
- The input for the AttachPrincipalPolicy operation.public AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest request)
AWSIot
Attaches the specified principal to the specified thing.
attachThingPrincipal
in interface AWSIot
request
- The input for the AttachThingPrincipal operation.public CancelCertificateTransferResult cancelCertificateTransfer(CancelCertificateTransferRequest request)
AWSIot
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.
cancelCertificateTransfer
in interface AWSIot
request
- The input for the CancelCertificateTransfer operation.public CancelJobResult cancelJob(CancelJobRequest request)
AWSIot
Cancels a job.
public ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest request)
AWSIot
Clears the default authorizer.
clearDefaultAuthorizer
in interface AWSIot
public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
AWSIot
Creates an authorizer.
createAuthorizer
in interface AWSIot
public CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest request)
AWSIot
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"
createCertificateFromCsr
in interface AWSIot
request
- The input for the CreateCertificateFromCsr operation.public CreateJobResult createJob(CreateJobRequest request)
AWSIot
Creates a job.
public CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest request)
AWSIot
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.
createKeysAndCertificate
in interface AWSIot
request
- The input for the CreateKeysAndCertificate operation.public CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest request)
AWSIot
Creates an AWS IoT OTAUpdate on a target group of things or groups.
createOTAUpdate
in interface AWSIot
public CreatePolicyResult createPolicy(CreatePolicyRequest request)
AWSIot
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.
createPolicy
in interface AWSIot
request
- The input for the CreatePolicy operation.public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest request)
AWSIot
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).
createPolicyVersion
in interface AWSIot
request
- The input for the CreatePolicyVersion operation.public CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest request)
AWSIot
Creates a role alias.
createRoleAlias
in interface AWSIot
public CreateStreamResult createStream(CreateStreamRequest request)
AWSIot
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.
createStream
in interface AWSIot
public CreateThingResult createThing(CreateThingRequest request)
AWSIot
Creates a thing record in the registry.
createThing
in interface AWSIot
request
- The input for the CreateThing operation.public CreateThingGroupResult createThingGroup(CreateThingGroupRequest request)
AWSIot
Create a thing group.
createThingGroup
in interface AWSIot
public CreateThingTypeResult createThingType(CreateThingTypeRequest request)
AWSIot
Creates a new thing type.
createThingType
in interface AWSIot
request
- The input for the CreateThingType operation.public CreateTopicRuleResult createTopicRule(CreateTopicRuleRequest request)
AWSIot
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.
createTopicRule
in interface AWSIot
request
- The input for the CreateTopicRule operation.public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
AWSIot
Deletes an authorizer.
deleteAuthorizer
in interface AWSIot
public DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest request)
AWSIot
Deletes a registered CA certificate.
deleteCACertificate
in interface AWSIot
request
- Input for the DeleteCACertificate operation.public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
AWSIot
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.
deleteCertificate
in interface AWSIot
request
- The input for the DeleteCertificate operation.public DeleteJobResult deleteJob(DeleteJobRequest request)
AWSIot
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.
public DeleteJobExecutionResult deleteJobExecution(DeleteJobExecutionRequest request)
AWSIot
Deletes a job execution.
deleteJobExecution
in interface AWSIot
public DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest request)
AWSIot
Delete an OTA update.
deleteOTAUpdate
in interface AWSIot
public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
AWSIot
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.
deletePolicy
in interface AWSIot
request
- The input for the DeletePolicy operation.public DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest request)
AWSIot
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.
deletePolicyVersion
in interface AWSIot
request
- The input for the DeletePolicyVersion operation.public DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest request)
AWSIot
Deletes a CA certificate registration code.
deleteRegistrationCode
in interface AWSIot
request
- The input for the DeleteRegistrationCode operation.public DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest request)
AWSIot
Deletes a role alias
deleteRoleAlias
in interface AWSIot
public DeleteStreamResult deleteStream(DeleteStreamRequest request)
AWSIot
Deletes a stream.
deleteStream
in interface AWSIot
public DeleteThingResult deleteThing(DeleteThingRequest request)
AWSIot
Deletes the specified thing.
deleteThing
in interface AWSIot
request
- The input for the DeleteThing operation.public DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest request)
AWSIot
Deletes a thing group.
deleteThingGroup
in interface AWSIot
public DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest request)
AWSIot
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.
deleteThingType
in interface AWSIot
request
- The input for the DeleteThingType operation.public DeleteTopicRuleResult deleteTopicRule(DeleteTopicRuleRequest request)
AWSIot
Deletes the rule.
deleteTopicRule
in interface AWSIot
request
- The input for the DeleteTopicRule operation.public DeleteV2LoggingLevelResult deleteV2LoggingLevel(DeleteV2LoggingLevelRequest request)
AWSIot
Deletes a logging level.
deleteV2LoggingLevel
in interface AWSIot
public DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest request)
AWSIot
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingType
in interface AWSIot
request
- The input for the DeprecateThingType operation.public DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest request)
AWSIot
Describes an authorizer.
describeAuthorizer
in interface AWSIot
public DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest request)
AWSIot
Describes a registered CA certificate.
describeCACertificate
in interface AWSIot
request
- The input for the DescribeCACertificate operation.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
AWSIot
Gets information about the specified certificate.
describeCertificate
in interface AWSIot
request
- The input for the DescribeCertificate operation.public DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest request)
AWSIot
Describes the default authorizer.
describeDefaultAuthorizer
in interface AWSIot
public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
AWSIot
Returns a unique endpoint specific to the AWS account making the call.
describeEndpoint
in interface AWSIot
request
- The input for the DescribeEndpoint operation.public DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest request)
AWSIot
Describes event configurations.
describeEventConfigurations
in interface AWSIot
public DescribeIndexResult describeIndex(DescribeIndexRequest request)
AWSIot
Describes a search index.
describeIndex
in interface AWSIot
public DescribeJobResult describeJob(DescribeJobRequest request)
AWSIot
Describes a job.
describeJob
in interface AWSIot
public DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest request)
AWSIot
Describes a job execution.
describeJobExecution
in interface AWSIot
public DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest request)
AWSIot
Describes a role alias.
describeRoleAlias
in interface AWSIot
public DescribeStreamResult describeStream(DescribeStreamRequest request)
AWSIot
Gets information about a stream.
describeStream
in interface AWSIot
public DescribeThingResult describeThing(DescribeThingRequest request)
AWSIot
Gets information about the specified thing.
describeThing
in interface AWSIot
request
- The input for the DescribeThing operation.public DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest request)
AWSIot
Describe a thing group.
describeThingGroup
in interface AWSIot
public DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest request)
AWSIot
Describes a bulk thing provisioning task.
describeThingRegistrationTask
in interface AWSIot
public DescribeThingTypeResult describeThingType(DescribeThingTypeRequest request)
AWSIot
Gets information about the specified thing type.
describeThingType
in interface AWSIot
request
- The input for the DescribeThingType operation.public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
AWSIot
Detaches a policy from the specified target.
detachPolicy
in interface AWSIot
@Deprecated public DetachPrincipalPolicyResult detachPrincipalPolicy(DetachPrincipalPolicyRequest request)
AWSIot
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
detachPrincipalPolicy
in interface AWSIot
request
- The input for the DetachPrincipalPolicy operation.public DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest request)
AWSIot
Detaches the specified principal from the specified thing.
detachThingPrincipal
in interface AWSIot
request
- The input for the DetachThingPrincipal operation.public DisableTopicRuleResult disableTopicRule(DisableTopicRuleRequest request)
AWSIot
Disables the rule.
disableTopicRule
in interface AWSIot
request
- The input for the DisableTopicRuleRequest operation.public EnableTopicRuleResult enableTopicRule(EnableTopicRuleRequest request)
AWSIot
Enables the rule.
enableTopicRule
in interface AWSIot
request
- The input for the EnableTopicRuleRequest operation.public GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest request)
AWSIot
Gets effective policies.
getEffectivePolicies
in interface AWSIot
public GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest request)
AWSIot
Gets the search configuration.
getIndexingConfiguration
in interface AWSIot
public GetJobDocumentResult getJobDocument(GetJobDocumentRequest request)
AWSIot
Gets a job document.
getJobDocument
in interface AWSIot
public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest request)
AWSIot
Gets the logging options.
getLoggingOptions
in interface AWSIot
request
- The input for the GetLoggingOptions operation.public GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest request)
AWSIot
Gets an OTA update.
getOTAUpdate
in interface AWSIot
public GetPolicyResult getPolicy(GetPolicyRequest request)
AWSIot
Gets information about the specified policy with the policy document of the default version.
public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest request)
AWSIot
Gets information about the specified policy version.
getPolicyVersion
in interface AWSIot
request
- The input for the GetPolicyVersion operation.public GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest request)
AWSIot
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCode
in interface AWSIot
request
- The input to the GetRegistrationCode operation.public GetTopicRuleResult getTopicRule(GetTopicRuleRequest request)
AWSIot
Gets information about the rule.
getTopicRule
in interface AWSIot
request
- The input for the GetTopicRule operation.public GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest request)
AWSIot
Gets the fine grained logging options.
getV2LoggingOptions
in interface AWSIot
public ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest request)
AWSIot
Lists the policies attached to the specified thing group.
listAttachedPolicies
in interface AWSIot
public ListAuthorizersResult listAuthorizers(ListAuthorizersRequest request)
AWSIot
Lists the authorizers registered in your account.
listAuthorizers
in interface AWSIot
public ListCACertificatesResult listCACertificates(ListCACertificatesRequest request)
AWSIot
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.
listCACertificates
in interface AWSIot
request
- Input for the ListCACertificates operation.public ListCertificatesResult listCertificates(ListCertificatesRequest request)
AWSIot
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.
listCertificates
in interface AWSIot
request
- The input for the ListCertificates operation.public ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest request)
AWSIot
List the device certificates signed by the specified CA certificate.
listCertificatesByCA
in interface AWSIot
request
- The input to the ListCertificatesByCA operation.public ListIndicesResult listIndices(ListIndicesRequest request)
AWSIot
Lists the search indices.
listIndices
in interface AWSIot
public ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest request)
AWSIot
Lists the job executions for a job.
listJobExecutionsForJob
in interface AWSIot
public ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest request)
AWSIot
Lists the job executions for the specified thing.
listJobExecutionsForThing
in interface AWSIot
public ListJobsResult listJobs(ListJobsRequest request)
AWSIot
Lists jobs.
public ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest request)
AWSIot
Lists OTA updates.
listOTAUpdates
in interface AWSIot
public ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest request)
AWSIot
Lists certificates that are being transferred but not yet accepted.
listOutgoingCertificates
in interface AWSIot
request
- The input to the ListOutgoingCertificates operation.public ListPoliciesResult listPolicies(ListPoliciesRequest request)
AWSIot
Lists your policies.
listPolicies
in interface AWSIot
request
- The input for the ListPolicies operation.@Deprecated public ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest request)
AWSIot
Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
listPolicyPrincipals
in interface AWSIot
request
- The input for the ListPolicyPrincipals operation.public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest request)
AWSIot
Lists the versions of the specified policy and identifies the default version.
listPolicyVersions
in interface AWSIot
request
- The input for the ListPolicyVersions operation.@Deprecated public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest request)
AWSIot
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.
listPrincipalPolicies
in interface AWSIot
request
- The input for the ListPrincipalPolicies operation.public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest request)
AWSIot
Lists the things associated with the specified principal.
listPrincipalThings
in interface AWSIot
request
- The input for the ListPrincipalThings operation.public ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest request)
AWSIot
Lists the role aliases registered in your account.
listRoleAliases
in interface AWSIot
public ListStreamsResult listStreams(ListStreamsRequest request)
AWSIot
Lists all of the streams in your AWS account.
listStreams
in interface AWSIot
public ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest request)
AWSIot
List targets for the specified policy.
listTargetsForPolicy
in interface AWSIot
public ListThingGroupsResult listThingGroups(ListThingGroupsRequest request)
AWSIot
List the thing groups in your account.
listThingGroups
in interface AWSIot
public ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest request)
AWSIot
List the thing groups to which the specified thing belongs.
listThingGroupsForThing
in interface AWSIot
public ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest request)
AWSIot
Lists the principals associated with the specified thing.
listThingPrincipals
in interface AWSIot
request
- The input for the ListThingPrincipal operation.public ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest request)
AWSIot
Information about the thing registration tasks.
listThingRegistrationTaskReports
in interface AWSIot
public ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest request)
AWSIot
List bulk thing provisioning tasks.
listThingRegistrationTasks
in interface AWSIot
public ListThingTypesResult listThingTypes(ListThingTypesRequest request)
AWSIot
Lists the existing thing types.
listThingTypes
in interface AWSIot
request
- The input for the ListThingTypes operation.public ListThingsResult listThings(ListThingsRequest request)
AWSIot
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.
listThings
in interface AWSIot
request
- The input for the ListThings operation.public ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest request)
AWSIot
Lists the things in the specified group.
listThingsInThingGroup
in interface AWSIot
public ListTopicRulesResult listTopicRules(ListTopicRulesRequest request)
AWSIot
Lists the rules for the specific topic.
listTopicRules
in interface AWSIot
request
- The input for the ListTopicRules operation.public ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest request)
AWSIot
Lists logging levels.
listV2LoggingLevels
in interface AWSIot
public RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest request)
AWSIot
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.
registerCACertificate
in interface AWSIot
request
- The input to the RegisterCACertificate operation.public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)
AWSIot
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.
registerCertificate
in interface AWSIot
request
- The input to the RegisterCertificate operation.public RegisterThingResult registerThing(RegisterThingRequest request)
AWSIot
Provisions a thing.
registerThing
in interface AWSIot
public RejectCertificateTransferResult rejectCertificateTransfer(RejectCertificateTransferRequest request)
AWSIot
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.
rejectCertificateTransfer
in interface AWSIot
request
- The input for the RejectCertificateTransfer operation.public RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest request)
AWSIot
Remove the specified thing from the specified group.
removeThingFromThingGroup
in interface AWSIot
public ReplaceTopicRuleResult replaceTopicRule(ReplaceTopicRuleRequest request)
AWSIot
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.
replaceTopicRule
in interface AWSIot
request
- The input for the ReplaceTopicRule operation.public SearchIndexResult searchIndex(SearchIndexRequest request)
AWSIot
The query search index.
searchIndex
in interface AWSIot
public SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest request)
AWSIot
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
setDefaultAuthorizer
in interface AWSIot
public SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request)
AWSIot
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.
setDefaultPolicyVersion
in interface AWSIot
request
- The input for the SetDefaultPolicyVersion operation.public SetLoggingOptionsResult setLoggingOptions(SetLoggingOptionsRequest request)
AWSIot
Sets the logging options.
setLoggingOptions
in interface AWSIot
request
- The input for the SetLoggingOptions operation.public SetV2LoggingLevelResult setV2LoggingLevel(SetV2LoggingLevelRequest request)
AWSIot
Sets the logging level.
setV2LoggingLevel
in interface AWSIot
public SetV2LoggingOptionsResult setV2LoggingOptions(SetV2LoggingOptionsRequest request)
AWSIot
Sets the logging options for the V2 logging service.
setV2LoggingOptions
in interface AWSIot
public StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest request)
AWSIot
Creates a bulk thing provisioning task.
startThingRegistrationTask
in interface AWSIot
public StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest request)
AWSIot
Cancels a bulk thing provisioning task.
stopThingRegistrationTask
in interface AWSIot
public TestAuthorizationResult testAuthorization(TestAuthorizationRequest request)
AWSIot
Test custom authorization.
testAuthorization
in interface AWSIot
public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
AWSIot
Invoke the specified custom authorizer for testing purposes.
testInvokeAuthorizer
in interface AWSIot
public TransferCertificateResult transferCertificate(TransferCertificateRequest request)
AWSIot
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.
transferCertificate
in interface AWSIot
request
- The input for the TransferCertificate operation.public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
AWSIot
Updates an authorizer.
updateAuthorizer
in interface AWSIot
public UpdateCACertificateResult updateCACertificate(UpdateCACertificateRequest request)
AWSIot
Updates a registered CA certificate.
updateCACertificate
in interface AWSIot
request
- The input to the UpdateCACertificate operation.public UpdateCertificateResult updateCertificate(UpdateCertificateRequest request)
AWSIot
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.
updateCertificate
in interface AWSIot
request
- The input for the UpdateCertificate operation.public UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest request)
AWSIot
Updates the event configurations.
updateEventConfigurations
in interface AWSIot
public UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest request)
AWSIot
Updates the search configuration.
updateIndexingConfiguration
in interface AWSIot
public UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest request)
AWSIot
Updates a role alias.
updateRoleAlias
in interface AWSIot
public UpdateStreamResult updateStream(UpdateStreamRequest request)
AWSIot
Updates an existing stream. The stream version will be incremented by one.
updateStream
in interface AWSIot
public UpdateThingResult updateThing(UpdateThingRequest request)
AWSIot
Updates the data for a thing.
updateThing
in interface AWSIot
request
- The input for the UpdateThing operation.public UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest request)
AWSIot
Update a thing group.
updateThingGroup
in interface AWSIot
public UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest request)
AWSIot
Updates the groups to which the thing belongs.
updateThingGroupsForThing
in interface AWSIot
public void shutdown()
AWSIot
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSIot
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSIot
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.