NAME
Paws::IoT - Perl Interface to AWS AWS IoT
SYNOPSIS
use Paws;
my $obj = Paws->service('IoT');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);
DESCRIPTION
AWS IoT
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
For more information about how AWS IoT works, see the Developer Guide (https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html).
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services (https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html).
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28
METHODS
AcceptCertificateTransfer
Each argument is described in detail in: Paws::IoT::AcceptCertificateTransfer
Returns: nothing
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.
AddThingToBillingGroup
Each argument is described in detail in: Paws::IoT::AddThingToBillingGroup
Returns: a Paws::IoT::AddThingToBillingGroupResponse instance
Adds a thing to a billing group.
AddThingToThingGroup
- [OverrideDynamicGroups => Bool]
- [ThingArn => Str]
- [ThingGroupArn => Str]
- [ThingGroupName => Str]
- [ThingName => Str]
Each argument is described in detail in: Paws::IoT::AddThingToThingGroup
Returns: a Paws::IoT::AddThingToThingGroupResponse instance
Adds a thing to a thing group.
AssociateTargetsWithJob
Each argument is described in detail in: Paws::IoT::AssociateTargetsWithJob
Returns: a Paws::IoT::AssociateTargetsWithJobResponse instance
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.
AttachPolicy
Each argument is described in detail in: Paws::IoT::AttachPolicy
Returns: nothing
Attaches a policy to the specified target.
AttachPrincipalPolicy
Each argument is described in detail in: Paws::IoT::AttachPrincipalPolicy
Returns: nothing
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
AttachSecurityProfile
Each argument is described in detail in: Paws::IoT::AttachSecurityProfile
Returns: a Paws::IoT::AttachSecurityProfileResponse instance
Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.
AttachThingPrincipal
Each argument is described in detail in: Paws::IoT::AttachThingPrincipal
Returns: a Paws::IoT::AttachThingPrincipalResponse instance
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
CancelAuditTask
Each argument is described in detail in: Paws::IoT::CancelAuditTask
Returns: a Paws::IoT::CancelAuditTaskResponse instance
Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
CancelCertificateTransfer
Each argument is described in detail in: Paws::IoT::CancelCertificateTransfer
Returns: nothing
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.
CancelJob
Each argument is described in detail in: Paws::IoT::CancelJob
Returns: a Paws::IoT::CancelJobResponse instance
Cancels a job.
CancelJobExecution
- JobId => Str
- ThingName => Str
- [ExpectedVersion => Int]
- [Force => Bool]
- [StatusDetails => Paws::IoT::DetailsMap]
Each argument is described in detail in: Paws::IoT::CancelJobExecution
Returns: nothing
Cancels the execution of a job for a given thing.
ClearDefaultAuthorizer
Each argument is described in detail in: Paws::IoT::ClearDefaultAuthorizer
Returns: a Paws::IoT::ClearDefaultAuthorizerResponse instance
Clears the default authorizer.
CreateAuthorizer
- AuthorizerFunctionArn => Str
- AuthorizerName => Str
- TokenKeyName => Str
- TokenSigningPublicKeys => Paws::IoT::PublicKeyMap
- [Status => Str]
Each argument is described in detail in: Paws::IoT::CreateAuthorizer
Returns: a Paws::IoT::CreateAuthorizerResponse instance
Creates an authorizer.
CreateBillingGroup
- BillingGroupName => Str
- [BillingGroupProperties => Paws::IoT::BillingGroupProperties]
- [Tags => ArrayRef[Paws::IoT::Tag]]
Each argument is described in detail in: Paws::IoT::CreateBillingGroup
Returns: a Paws::IoT::CreateBillingGroupResponse instance
Creates a billing group.
CreateCertificateFromCsr
Each argument is described in detail in: Paws::IoT::CreateCertificateFromCsr
Returns: a Paws::IoT::CreateCertificateFromCsrResponse instance
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"
CreateDynamicThingGroup
- QueryString => Str
- ThingGroupName => Str
- [IndexName => Str]
- [QueryVersion => Str]
- [Tags => ArrayRef[Paws::IoT::Tag]]
- [ThingGroupProperties => Paws::IoT::ThingGroupProperties]
Each argument is described in detail in: Paws::IoT::CreateDynamicThingGroup
Returns: a Paws::IoT::CreateDynamicThingGroupResponse instance
Creates a dynamic thing group.
CreateJob
- JobId => Str
- Targets => ArrayRef[Str|Undef]
- [AbortConfig => Paws::IoT::AbortConfig]
- [Description => Str]
- [Document => Str]
- [DocumentSource => Str]
- [JobExecutionsRolloutConfig => Paws::IoT::JobExecutionsRolloutConfig]
- [PresignedUrlConfig => Paws::IoT::PresignedUrlConfig]
- [Tags => ArrayRef[Paws::IoT::Tag]]
- [TargetSelection => Str]
- [TimeoutConfig => Paws::IoT::TimeoutConfig]
Each argument is described in detail in: Paws::IoT::CreateJob
Returns: a Paws::IoT::CreateJobResponse instance
Creates a job.
CreateKeysAndCertificate
Each argument is described in detail in: Paws::IoT::CreateKeysAndCertificate
Returns: a Paws::IoT::CreateKeysAndCertificateResponse instance
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.
CreateOTAUpdate
- Files => ArrayRef[Paws::IoT::OTAUpdateFile]
- OtaUpdateId => Str
- RoleArn => Str
- Targets => ArrayRef[Str|Undef]
- [AdditionalParameters => Paws::IoT::AdditionalParameterMap]
- [AwsJobExecutionsRolloutConfig => Paws::IoT::AwsJobExecutionsRolloutConfig]
- [Description => Str]
- [Tags => ArrayRef[Paws::IoT::Tag]]
- [TargetSelection => Str]
Each argument is described in detail in: Paws::IoT::CreateOTAUpdate
Returns: a Paws::IoT::CreateOTAUpdateResponse instance
Creates an AWS IoT OTAUpdate on a target group of things or groups.
CreatePolicy
Each argument is described in detail in: Paws::IoT::CreatePolicy
Returns: a Paws::IoT::CreatePolicyResponse instance
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.
CreatePolicyVersion
Each argument is described in detail in: Paws::IoT::CreatePolicyVersion
Returns: a Paws::IoT::CreatePolicyVersionResponse instance
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).
CreateRoleAlias
Each argument is described in detail in: Paws::IoT::CreateRoleAlias
Returns: a Paws::IoT::CreateRoleAliasResponse instance
Creates a role alias.
CreateScheduledAudit
- Frequency => Str
- ScheduledAuditName => Str
- TargetCheckNames => ArrayRef[Str|Undef]
- [DayOfMonth => Str]
- [DayOfWeek => Str]
- [Tags => ArrayRef[Paws::IoT::Tag]]
Each argument is described in detail in: Paws::IoT::CreateScheduledAudit
Returns: a Paws::IoT::CreateScheduledAuditResponse instance
Creates a scheduled audit that is run at a specified time interval.
CreateSecurityProfile
- SecurityProfileName => Str
- [AdditionalMetricsToRetain => ArrayRef[Str|Undef]]
- [AlertTargets => Paws::IoT::AlertTargets]
- [Behaviors => ArrayRef[Paws::IoT::Behavior]]
- [SecurityProfileDescription => Str]
- [Tags => ArrayRef[Paws::IoT::Tag]]
Each argument is described in detail in: Paws::IoT::CreateSecurityProfile
Returns: a Paws::IoT::CreateSecurityProfileResponse instance
Creates a Device Defender security profile.
CreateStream
- Files => ArrayRef[Paws::IoT::StreamFile]
- RoleArn => Str
- StreamId => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::IoT::Tag]]
Each argument is described in detail in: Paws::IoT::CreateStream
Returns: a Paws::IoT::CreateStreamResponse instance
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.
CreateThing
- ThingName => Str
- [AttributePayload => Paws::IoT::AttributePayload]
- [BillingGroupName => Str]
- [ThingTypeName => Str]
Each argument is described in detail in: Paws::IoT::CreateThing
Returns: a Paws::IoT::CreateThingResponse instance
Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException
is thrown.
This is a control plane operation. See Authorization (https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) for information about authorizing control plane actions.
CreateThingGroup
- ThingGroupName => Str
- [ParentGroupName => Str]
- [Tags => ArrayRef[Paws::IoT::Tag]]
- [ThingGroupProperties => Paws::IoT::ThingGroupProperties]
Each argument is described in detail in: Paws::IoT::CreateThingGroup
Returns: a Paws::IoT::CreateThingGroupResponse instance
Create a thing group.
This is a control plane operation. See Authorization (https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html) for information about authorizing control plane actions.
CreateThingType
- ThingTypeName => Str
- [Tags => ArrayRef[Paws::IoT::Tag]]
- [ThingTypeProperties => Paws::IoT::ThingTypeProperties]
Each argument is described in detail in: Paws::IoT::CreateThingType
Returns: a Paws::IoT::CreateThingTypeResponse instance
Creates a new thing type.
CreateTopicRule
- RuleName => Str
- TopicRulePayload => Paws::IoT::TopicRulePayload
- [Tags => Str]
Each argument is described in detail in: Paws::IoT::CreateTopicRule
Returns: nothing
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.
DeleteAccountAuditConfiguration
Each argument is described in detail in: Paws::IoT::DeleteAccountAuditConfiguration
Returns: a Paws::IoT::DeleteAccountAuditConfigurationResponse instance
Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
DeleteAuthorizer
Each argument is described in detail in: Paws::IoT::DeleteAuthorizer
Returns: a Paws::IoT::DeleteAuthorizerResponse instance
Deletes an authorizer.
DeleteBillingGroup
Each argument is described in detail in: Paws::IoT::DeleteBillingGroup
Returns: a Paws::IoT::DeleteBillingGroupResponse instance
Deletes the billing group.
DeleteCACertificate
Each argument is described in detail in: Paws::IoT::DeleteCACertificate
Returns: a Paws::IoT::DeleteCACertificateResponse instance
Deletes a registered CA certificate.
DeleteCertificate
Each argument is described in detail in: Paws::IoT::DeleteCertificate
Returns: nothing
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.
DeleteDynamicThingGroup
Each argument is described in detail in: Paws::IoT::DeleteDynamicThingGroup
Returns: a Paws::IoT::DeleteDynamicThingGroupResponse instance
Deletes a dynamic thing group.
DeleteJob
Each argument is described in detail in: Paws::IoT::DeleteJob
Returns: nothing
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.
DeleteJobExecution
Each argument is described in detail in: Paws::IoT::DeleteJobExecution
Returns: nothing
Deletes a job execution.
DeleteOTAUpdate
Each argument is described in detail in: Paws::IoT::DeleteOTAUpdate
Returns: a Paws::IoT::DeleteOTAUpdateResponse instance
Delete an OTA update.
DeletePolicy
Each argument is described in detail in: Paws::IoT::DeletePolicy
Returns: nothing
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.
DeletePolicyVersion
Each argument is described in detail in: Paws::IoT::DeletePolicyVersion
Returns: nothing
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.
DeleteRegistrationCode
Each argument is described in detail in: Paws::IoT::DeleteRegistrationCode
Returns: a Paws::IoT::DeleteRegistrationCodeResponse instance
Deletes a CA certificate registration code.
DeleteRoleAlias
Each argument is described in detail in: Paws::IoT::DeleteRoleAlias
Returns: a Paws::IoT::DeleteRoleAliasResponse instance
Deletes a role alias
DeleteScheduledAudit
Each argument is described in detail in: Paws::IoT::DeleteScheduledAudit
Returns: a Paws::IoT::DeleteScheduledAuditResponse instance
Deletes a scheduled audit.
DeleteSecurityProfile
Each argument is described in detail in: Paws::IoT::DeleteSecurityProfile
Returns: a Paws::IoT::DeleteSecurityProfileResponse instance
Deletes a Device Defender security profile.
DeleteStream
Each argument is described in detail in: Paws::IoT::DeleteStream
Returns: a Paws::IoT::DeleteStreamResponse instance
Deletes a stream.
DeleteThing
Each argument is described in detail in: Paws::IoT::DeleteThing
Returns: a Paws::IoT::DeleteThingResponse instance
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
DeleteThingGroup
Each argument is described in detail in: Paws::IoT::DeleteThingGroup
Returns: a Paws::IoT::DeleteThingGroupResponse instance
Deletes a thing group.
DeleteThingType
Each argument is described in detail in: Paws::IoT::DeleteThingType
Returns: a Paws::IoT::DeleteThingTypeResponse instance
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.
DeleteTopicRule
Each argument is described in detail in: Paws::IoT::DeleteTopicRule
Returns: nothing
Deletes the rule.
DeleteV2LoggingLevel
Each argument is described in detail in: Paws::IoT::DeleteV2LoggingLevel
Returns: nothing
Deletes a logging level.
DeprecateThingType
Each argument is described in detail in: Paws::IoT::DeprecateThingType
Returns: a Paws::IoT::DeprecateThingTypeResponse instance
Deprecates a thing type. You can not associate new things with deprecated thing type.
DescribeAccountAuditConfiguration
Each argument is described in detail in: Paws::IoT::DescribeAccountAuditConfiguration
Returns: a Paws::IoT::DescribeAccountAuditConfigurationResponse instance
Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
DescribeAuditTask
Each argument is described in detail in: Paws::IoT::DescribeAuditTask
Returns: a Paws::IoT::DescribeAuditTaskResponse instance
Gets information about a Device Defender audit.
DescribeAuthorizer
Each argument is described in detail in: Paws::IoT::DescribeAuthorizer
Returns: a Paws::IoT::DescribeAuthorizerResponse instance
Describes an authorizer.
DescribeBillingGroup
Each argument is described in detail in: Paws::IoT::DescribeBillingGroup
Returns: a Paws::IoT::DescribeBillingGroupResponse instance
Returns information about a billing group.
DescribeCACertificate
Each argument is described in detail in: Paws::IoT::DescribeCACertificate
Returns: a Paws::IoT::DescribeCACertificateResponse instance
Describes a registered CA certificate.
DescribeCertificate
Each argument is described in detail in: Paws::IoT::DescribeCertificate
Returns: a Paws::IoT::DescribeCertificateResponse instance
Gets information about the specified certificate.
DescribeDefaultAuthorizer
Each argument is described in detail in: Paws::IoT::DescribeDefaultAuthorizer
Returns: a Paws::IoT::DescribeDefaultAuthorizerResponse instance
Describes the default authorizer.
DescribeEndpoint
Each argument is described in detail in: Paws::IoT::DescribeEndpoint
Returns: a Paws::IoT::DescribeEndpointResponse instance
Returns a unique endpoint specific to the AWS account making the call.
DescribeEventConfigurations
Each argument is described in detail in: Paws::IoT::DescribeEventConfigurations
Returns: a Paws::IoT::DescribeEventConfigurationsResponse instance
Describes event configurations.
DescribeIndex
Each argument is described in detail in: Paws::IoT::DescribeIndex
Returns: a Paws::IoT::DescribeIndexResponse instance
Describes a search index.
DescribeJob
Each argument is described in detail in: Paws::IoT::DescribeJob
Returns: a Paws::IoT::DescribeJobResponse instance
Describes a job.
DescribeJobExecution
Each argument is described in detail in: Paws::IoT::DescribeJobExecution
Returns: a Paws::IoT::DescribeJobExecutionResponse instance
Describes a job execution.
DescribeRoleAlias
Each argument is described in detail in: Paws::IoT::DescribeRoleAlias
Returns: a Paws::IoT::DescribeRoleAliasResponse instance
Describes a role alias.
DescribeScheduledAudit
Each argument is described in detail in: Paws::IoT::DescribeScheduledAudit
Returns: a Paws::IoT::DescribeScheduledAuditResponse instance
Gets information about a scheduled audit.
DescribeSecurityProfile
Each argument is described in detail in: Paws::IoT::DescribeSecurityProfile
Returns: a Paws::IoT::DescribeSecurityProfileResponse instance
Gets information about a Device Defender security profile.
DescribeStream
Each argument is described in detail in: Paws::IoT::DescribeStream
Returns: a Paws::IoT::DescribeStreamResponse instance
Gets information about a stream.
DescribeThing
Each argument is described in detail in: Paws::IoT::DescribeThing
Returns: a Paws::IoT::DescribeThingResponse instance
Gets information about the specified thing.
DescribeThingGroup
Each argument is described in detail in: Paws::IoT::DescribeThingGroup
Returns: a Paws::IoT::DescribeThingGroupResponse instance
Describe a thing group.
DescribeThingRegistrationTask
Each argument is described in detail in: Paws::IoT::DescribeThingRegistrationTask
Returns: a Paws::IoT::DescribeThingRegistrationTaskResponse instance
Describes a bulk thing provisioning task.
DescribeThingType
Each argument is described in detail in: Paws::IoT::DescribeThingType
Returns: a Paws::IoT::DescribeThingTypeResponse instance
Gets information about the specified thing type.
DetachPolicy
Each argument is described in detail in: Paws::IoT::DetachPolicy
Returns: nothing
Detaches a policy from the specified target.
DetachPrincipalPolicy
Each argument is described in detail in: Paws::IoT::DetachPrincipalPolicy
Returns: nothing
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
DetachSecurityProfile
Each argument is described in detail in: Paws::IoT::DetachSecurityProfile
Returns: a Paws::IoT::DetachSecurityProfileResponse instance
Disassociates a Device Defender security profile from a thing group or from this account.
DetachThingPrincipal
Each argument is described in detail in: Paws::IoT::DetachThingPrincipal
Returns: a Paws::IoT::DetachThingPrincipalResponse instance
Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
DisableTopicRule
Each argument is described in detail in: Paws::IoT::DisableTopicRule
Returns: nothing
Disables the rule.
EnableTopicRule
Each argument is described in detail in: Paws::IoT::EnableTopicRule
Returns: nothing
Enables the rule.
GetEffectivePolicies
Each argument is described in detail in: Paws::IoT::GetEffectivePolicies
Returns: a Paws::IoT::GetEffectivePoliciesResponse instance
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.
GetIndexingConfiguration
Each argument is described in detail in: Paws::IoT::GetIndexingConfiguration
Returns: a Paws::IoT::GetIndexingConfigurationResponse instance
Gets the search configuration.
GetJobDocument
Each argument is described in detail in: Paws::IoT::GetJobDocument
Returns: a Paws::IoT::GetJobDocumentResponse instance
Gets a job document.
GetLoggingOptions
Each argument is described in detail in: Paws::IoT::GetLoggingOptions
Returns: a Paws::IoT::GetLoggingOptionsResponse instance
Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions
instead.
GetOTAUpdate
Each argument is described in detail in: Paws::IoT::GetOTAUpdate
Returns: a Paws::IoT::GetOTAUpdateResponse instance
Gets an OTA update.
GetPolicy
Each argument is described in detail in: Paws::IoT::GetPolicy
Returns: a Paws::IoT::GetPolicyResponse instance
Gets information about the specified policy with the policy document of the default version.
GetPolicyVersion
Each argument is described in detail in: Paws::IoT::GetPolicyVersion
Returns: a Paws::IoT::GetPolicyVersionResponse instance
Gets information about the specified policy version.
GetRegistrationCode
Each argument is described in detail in: Paws::IoT::GetRegistrationCode
Returns: a Paws::IoT::GetRegistrationCodeResponse instance
Gets a registration code used to register a CA certificate with AWS IoT.
GetStatistics
Each argument is described in detail in: Paws::IoT::GetStatistics
Returns: a Paws::IoT::GetStatisticsResponse instance
Gets statistics about things that match the specified query.
GetTopicRule
Each argument is described in detail in: Paws::IoT::GetTopicRule
Returns: a Paws::IoT::GetTopicRuleResponse instance
Gets information about the rule.
GetV2LoggingOptions
Each argument is described in detail in: Paws::IoT::GetV2LoggingOptions
Returns: a Paws::IoT::GetV2LoggingOptionsResponse instance
Gets the fine grained logging options.
ListActiveViolations
Each argument is described in detail in: Paws::IoT::ListActiveViolations
Returns: a Paws::IoT::ListActiveViolationsResponse instance
Lists the active violations for a given Device Defender security profile.
ListAttachedPolicies
Each argument is described in detail in: Paws::IoT::ListAttachedPolicies
Returns: a Paws::IoT::ListAttachedPoliciesResponse instance
Lists the policies attached to the specified thing group.
ListAuditFindings
- [CheckName => Str]
- [EndTime => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [ResourceIdentifier => Paws::IoT::ResourceIdentifier]
- [StartTime => Str]
- [TaskId => Str]
Each argument is described in detail in: Paws::IoT::ListAuditFindings
Returns: a Paws::IoT::ListAuditFindingsResponse instance
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
ListAuditTasks
- EndTime => Str
- StartTime => Str
- [MaxResults => Int]
- [NextToken => Str]
- [TaskStatus => Str]
- [TaskType => Str]
Each argument is described in detail in: Paws::IoT::ListAuditTasks
Returns: a Paws::IoT::ListAuditTasksResponse instance
Lists the Device Defender audits that have been performed during a given time period.
ListAuthorizers
Each argument is described in detail in: Paws::IoT::ListAuthorizers
Returns: a Paws::IoT::ListAuthorizersResponse instance
Lists the authorizers registered in your account.
ListBillingGroups
Each argument is described in detail in: Paws::IoT::ListBillingGroups
Returns: a Paws::IoT::ListBillingGroupsResponse instance
Lists the billing groups you have created.
ListCACertificates
Each argument is described in detail in: Paws::IoT::ListCACertificates
Returns: a Paws::IoT::ListCACertificatesResponse instance
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.
ListCertificates
Each argument is described in detail in: Paws::IoT::ListCertificates
Returns: a Paws::IoT::ListCertificatesResponse instance
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.
ListCertificatesByCA
Each argument is described in detail in: Paws::IoT::ListCertificatesByCA
Returns: a Paws::IoT::ListCertificatesByCAResponse instance
List the device certificates signed by the specified CA certificate.
ListIndices
Each argument is described in detail in: Paws::IoT::ListIndices
Returns: a Paws::IoT::ListIndicesResponse instance
Lists the search indices.
ListJobExecutionsForJob
Each argument is described in detail in: Paws::IoT::ListJobExecutionsForJob
Returns: a Paws::IoT::ListJobExecutionsForJobResponse instance
Lists the job executions for a job.
ListJobExecutionsForThing
Each argument is described in detail in: Paws::IoT::ListJobExecutionsForThing
Returns: a Paws::IoT::ListJobExecutionsForThingResponse instance
Lists the job executions for the specified thing.
ListJobs
- [MaxResults => Int]
- [NextToken => Str]
- [Status => Str]
- [TargetSelection => Str]
- [ThingGroupId => Str]
- [ThingGroupName => Str]
Each argument is described in detail in: Paws::IoT::ListJobs
Returns: a Paws::IoT::ListJobsResponse instance
Lists jobs.
ListOTAUpdates
Each argument is described in detail in: Paws::IoT::ListOTAUpdates
Returns: a Paws::IoT::ListOTAUpdatesResponse instance
Lists OTA updates.
ListOutgoingCertificates
Each argument is described in detail in: Paws::IoT::ListOutgoingCertificates
Returns: a Paws::IoT::ListOutgoingCertificatesResponse instance
Lists certificates that are being transferred but not yet accepted.
ListPolicies
Each argument is described in detail in: Paws::IoT::ListPolicies
Returns: a Paws::IoT::ListPoliciesResponse instance
Lists your policies.
ListPolicyPrincipals
Each argument is described in detail in: Paws::IoT::ListPolicyPrincipals
Returns: a Paws::IoT::ListPolicyPrincipalsResponse instance
Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
ListPolicyVersions
Each argument is described in detail in: Paws::IoT::ListPolicyVersions
Returns: a Paws::IoT::ListPolicyVersionsResponse instance
Lists the versions of the specified policy and identifies the default version.
ListPrincipalPolicies
Each argument is described in detail in: Paws::IoT::ListPrincipalPolicies
Returns: a Paws::IoT::ListPrincipalPoliciesResponse instance
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax).
Note: This API is deprecated. Please use ListAttachedPolicies instead.
ListPrincipalThings
Each argument is described in detail in: Paws::IoT::ListPrincipalThings
Returns: a Paws::IoT::ListPrincipalThingsResponse instance
Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
ListRoleAliases
Each argument is described in detail in: Paws::IoT::ListRoleAliases
Returns: a Paws::IoT::ListRoleAliasesResponse instance
Lists the role aliases registered in your account.
ListScheduledAudits
Each argument is described in detail in: Paws::IoT::ListScheduledAudits
Returns: a Paws::IoT::ListScheduledAuditsResponse instance
Lists all of your scheduled audits.
ListSecurityProfiles
Each argument is described in detail in: Paws::IoT::ListSecurityProfiles
Returns: a Paws::IoT::ListSecurityProfilesResponse instance
Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
ListSecurityProfilesForTarget
Each argument is described in detail in: Paws::IoT::ListSecurityProfilesForTarget
Returns: a Paws::IoT::ListSecurityProfilesForTargetResponse instance
Lists the Device Defender security profiles attached to a target (thing group).
ListStreams
Each argument is described in detail in: Paws::IoT::ListStreams
Returns: a Paws::IoT::ListStreamsResponse instance
Lists all of the streams in your AWS account.
ListTagsForResource
Each argument is described in detail in: Paws::IoT::ListTagsForResource
Returns: a Paws::IoT::ListTagsForResourceResponse instance
Lists the tags (metadata) you have assigned to the resource.
ListTargetsForPolicy
Each argument is described in detail in: Paws::IoT::ListTargetsForPolicy
Returns: a Paws::IoT::ListTargetsForPolicyResponse instance
List targets for the specified policy.
ListTargetsForSecurityProfile
Each argument is described in detail in: Paws::IoT::ListTargetsForSecurityProfile
Returns: a Paws::IoT::ListTargetsForSecurityProfileResponse instance
Lists the targets (thing groups) associated with a given Device Defender security profile.
ListThingGroups
- [MaxResults => Int]
- [NamePrefixFilter => Str]
- [NextToken => Str]
- [ParentGroup => Str]
- [Recursive => Bool]
Each argument is described in detail in: Paws::IoT::ListThingGroups
Returns: a Paws::IoT::ListThingGroupsResponse instance
List the thing groups in your account.
ListThingGroupsForThing
Each argument is described in detail in: Paws::IoT::ListThingGroupsForThing
Returns: a Paws::IoT::ListThingGroupsForThingResponse instance
List the thing groups to which the specified thing belongs.
ListThingPrincipals
Each argument is described in detail in: Paws::IoT::ListThingPrincipals
Returns: a Paws::IoT::ListThingPrincipalsResponse instance
Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
ListThingRegistrationTaskReports
Each argument is described in detail in: Paws::IoT::ListThingRegistrationTaskReports
Returns: a Paws::IoT::ListThingRegistrationTaskReportsResponse instance
Information about the thing registration tasks.
ListThingRegistrationTasks
Each argument is described in detail in: Paws::IoT::ListThingRegistrationTasks
Returns: a Paws::IoT::ListThingRegistrationTasksResponse instance
List bulk thing provisioning tasks.
ListThings
- [AttributeName => Str]
- [AttributeValue => Str]
- [MaxResults => Int]
- [NextToken => Str]
- [ThingTypeName => Str]
Each argument is described in detail in: Paws::IoT::ListThings
Returns: a Paws::IoT::ListThingsResponse instance
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.
ListThingsInBillingGroup
Each argument is described in detail in: Paws::IoT::ListThingsInBillingGroup
Returns: a Paws::IoT::ListThingsInBillingGroupResponse instance
Lists the things you have added to the given billing group.
ListThingsInThingGroup
Each argument is described in detail in: Paws::IoT::ListThingsInThingGroup
Returns: a Paws::IoT::ListThingsInThingGroupResponse instance
Lists the things in the specified group.
ListThingTypes
Each argument is described in detail in: Paws::IoT::ListThingTypes
Returns: a Paws::IoT::ListThingTypesResponse instance
Lists the existing thing types.
ListTopicRules
Each argument is described in detail in: Paws::IoT::ListTopicRules
Returns: a Paws::IoT::ListTopicRulesResponse instance
Lists the rules for the specific topic.
ListV2LoggingLevels
Each argument is described in detail in: Paws::IoT::ListV2LoggingLevels
Returns: a Paws::IoT::ListV2LoggingLevelsResponse instance
Lists logging levels.
ListViolationEvents
- EndTime => Str
- StartTime => Str
- [MaxResults => Int]
- [NextToken => Str]
- [SecurityProfileName => Str]
- [ThingName => Str]
Each argument is described in detail in: Paws::IoT::ListViolationEvents
Returns: a Paws::IoT::ListViolationEventsResponse instance
Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior or thing (device).
RegisterCACertificate
- CaCertificate => Str
- VerificationCertificate => Str
- [AllowAutoRegistration => Bool]
- [RegistrationConfig => Paws::IoT::RegistrationConfig]
- [SetAsActive => Bool]
Each argument is described in detail in: Paws::IoT::RegisterCACertificate
Returns: a Paws::IoT::RegisterCACertificateResponse instance
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.
RegisterCertificate
Each argument is described in detail in: Paws::IoT::RegisterCertificate
Returns: a Paws::IoT::RegisterCertificateResponse instance
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.
RegisterThing
- TemplateBody => Str
- [Parameters => Paws::IoT::Parameters]
Each argument is described in detail in: Paws::IoT::RegisterThing
Returns: a Paws::IoT::RegisterThingResponse instance
Provisions a thing.
RejectCertificateTransfer
Each argument is described in detail in: Paws::IoT::RejectCertificateTransfer
Returns: nothing
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.
RemoveThingFromBillingGroup
Each argument is described in detail in: Paws::IoT::RemoveThingFromBillingGroup
Returns: a Paws::IoT::RemoveThingFromBillingGroupResponse instance
Removes the given thing from the billing group.
RemoveThingFromThingGroup
Each argument is described in detail in: Paws::IoT::RemoveThingFromThingGroup
Returns: a Paws::IoT::RemoveThingFromThingGroupResponse instance
Remove the specified thing from the specified group.
ReplaceTopicRule
- RuleName => Str
- TopicRulePayload => Paws::IoT::TopicRulePayload
Each argument is described in detail in: Paws::IoT::ReplaceTopicRule
Returns: nothing
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.
SearchIndex
Each argument is described in detail in: Paws::IoT::SearchIndex
Returns: a Paws::IoT::SearchIndexResponse instance
The query search index.
SetDefaultAuthorizer
Each argument is described in detail in: Paws::IoT::SetDefaultAuthorizer
Returns: a Paws::IoT::SetDefaultAuthorizerResponse instance
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
SetDefaultPolicyVersion
Each argument is described in detail in: Paws::IoT::SetDefaultPolicyVersion
Returns: nothing
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.
SetLoggingOptions
- LoggingOptionsPayload => Paws::IoT::LoggingOptionsPayload
Each argument is described in detail in: Paws::IoT::SetLoggingOptions
Returns: nothing
Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions
instead.
SetV2LoggingLevel
- LogLevel => Str
- LogTarget => Paws::IoT::LogTarget
Each argument is described in detail in: Paws::IoT::SetV2LoggingLevel
Returns: nothing
Sets the logging level.
SetV2LoggingOptions
Each argument is described in detail in: Paws::IoT::SetV2LoggingOptions
Returns: nothing
Sets the logging options for the V2 logging service.
StartOnDemandAuditTask
Each argument is described in detail in: Paws::IoT::StartOnDemandAuditTask
Returns: a Paws::IoT::StartOnDemandAuditTaskResponse instance
Starts an on-demand Device Defender audit.
StartThingRegistrationTask
Each argument is described in detail in: Paws::IoT::StartThingRegistrationTask
Returns: a Paws::IoT::StartThingRegistrationTaskResponse instance
Creates a bulk thing provisioning task.
StopThingRegistrationTask
Each argument is described in detail in: Paws::IoT::StopThingRegistrationTask
Returns: a Paws::IoT::StopThingRegistrationTaskResponse instance
Cancels a bulk thing provisioning task.
TagResource
- ResourceArn => Str
- Tags => ArrayRef[Paws::IoT::Tag]
Each argument is described in detail in: Paws::IoT::TagResource
Returns: a Paws::IoT::TagResourceResponse instance
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
TestAuthorization
- AuthInfos => ArrayRef[Paws::IoT::AuthInfo]
- [ClientId => Str]
- [CognitoIdentityPoolId => Str]
- [PolicyNamesToAdd => ArrayRef[Str|Undef]]
- [PolicyNamesToSkip => ArrayRef[Str|Undef]]
- [Principal => Str]
Each argument is described in detail in: Paws::IoT::TestAuthorization
Returns: a Paws::IoT::TestAuthorizationResponse instance
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.
TestInvokeAuthorizer
Each argument is described in detail in: Paws::IoT::TestInvokeAuthorizer
Returns: a Paws::IoT::TestInvokeAuthorizerResponse instance
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.
TransferCertificate
Each argument is described in detail in: Paws::IoT::TransferCertificate
Returns: a Paws::IoT::TransferCertificateResponse instance
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.
UntagResource
Each argument is described in detail in: Paws::IoT::UntagResource
Returns: a Paws::IoT::UntagResourceResponse instance
Removes the given tags (metadata) from the resource.
UpdateAccountAuditConfiguration
- [AuditCheckConfigurations => Paws::IoT::AuditCheckConfigurations]
- [AuditNotificationTargetConfigurations => Paws::IoT::AuditNotificationTargetConfigurations]
- [RoleArn => Str]
Each argument is described in detail in: Paws::IoT::UpdateAccountAuditConfiguration
Returns: a Paws::IoT::UpdateAccountAuditConfigurationResponse instance
Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
UpdateAuthorizer
- AuthorizerName => Str
- [AuthorizerFunctionArn => Str]
- [Status => Str]
- [TokenKeyName => Str]
- [TokenSigningPublicKeys => Paws::IoT::PublicKeyMap]
Each argument is described in detail in: Paws::IoT::UpdateAuthorizer
Returns: a Paws::IoT::UpdateAuthorizerResponse instance
Updates an authorizer.
UpdateBillingGroup
- BillingGroupName => Str
- BillingGroupProperties => Paws::IoT::BillingGroupProperties
- [ExpectedVersion => Int]
Each argument is described in detail in: Paws::IoT::UpdateBillingGroup
Returns: a Paws::IoT::UpdateBillingGroupResponse instance
Updates information about the billing group.
UpdateCACertificate
- CertificateId => Str
- [NewAutoRegistrationStatus => Str]
- [NewStatus => Str]
- [RegistrationConfig => Paws::IoT::RegistrationConfig]
- [RemoveAutoRegistration => Bool]
Each argument is described in detail in: Paws::IoT::UpdateCACertificate
Returns: nothing
Updates a registered CA certificate.
UpdateCertificate
Each argument is described in detail in: Paws::IoT::UpdateCertificate
Returns: nothing
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.
UpdateDynamicThingGroup
- ThingGroupName => Str
- ThingGroupProperties => Paws::IoT::ThingGroupProperties
- [ExpectedVersion => Int]
- [IndexName => Str]
- [QueryString => Str]
- [QueryVersion => Str]
Each argument is described in detail in: Paws::IoT::UpdateDynamicThingGroup
Returns: a Paws::IoT::UpdateDynamicThingGroupResponse instance
Updates a dynamic thing group.
UpdateEventConfigurations
- [EventConfigurations => Paws::IoT::EventConfigurations]
Each argument is described in detail in: Paws::IoT::UpdateEventConfigurations
Returns: a Paws::IoT::UpdateEventConfigurationsResponse instance
Updates the event configurations.
UpdateIndexingConfiguration
- [ThingGroupIndexingConfiguration => Paws::IoT::ThingGroupIndexingConfiguration]
- [ThingIndexingConfiguration => Paws::IoT::ThingIndexingConfiguration]
Each argument is described in detail in: Paws::IoT::UpdateIndexingConfiguration
Returns: a Paws::IoT::UpdateIndexingConfigurationResponse instance
Updates the search configuration.
UpdateJob
- JobId => Str
- [AbortConfig => Paws::IoT::AbortConfig]
- [Description => Str]
- [JobExecutionsRolloutConfig => Paws::IoT::JobExecutionsRolloutConfig]
- [PresignedUrlConfig => Paws::IoT::PresignedUrlConfig]
- [TimeoutConfig => Paws::IoT::TimeoutConfig]
Each argument is described in detail in: Paws::IoT::UpdateJob
Returns: nothing
Updates supported fields of the specified job.
UpdateRoleAlias
Each argument is described in detail in: Paws::IoT::UpdateRoleAlias
Returns: a Paws::IoT::UpdateRoleAliasResponse instance
Updates a role alias.
UpdateScheduledAudit
- ScheduledAuditName => Str
- [DayOfMonth => Str]
- [DayOfWeek => Str]
- [Frequency => Str]
- [TargetCheckNames => ArrayRef[Str|Undef]]
Each argument is described in detail in: Paws::IoT::UpdateScheduledAudit
Returns: a Paws::IoT::UpdateScheduledAuditResponse instance
Updates a scheduled audit, including what checks are performed and how often the audit takes place.
UpdateSecurityProfile
- SecurityProfileName => Str
- [AdditionalMetricsToRetain => ArrayRef[Str|Undef]]
- [AlertTargets => Paws::IoT::AlertTargets]
- [Behaviors => ArrayRef[Paws::IoT::Behavior]]
- [DeleteAdditionalMetricsToRetain => Bool]
- [DeleteAlertTargets => Bool]
- [DeleteBehaviors => Bool]
- [ExpectedVersion => Int]
- [SecurityProfileDescription => Str]
Each argument is described in detail in: Paws::IoT::UpdateSecurityProfile
Returns: a Paws::IoT::UpdateSecurityProfileResponse instance
Updates a Device Defender security profile.
UpdateStream
- StreamId => Str
- [Description => Str]
- [Files => ArrayRef[Paws::IoT::StreamFile]]
- [RoleArn => Str]
Each argument is described in detail in: Paws::IoT::UpdateStream
Returns: a Paws::IoT::UpdateStreamResponse instance
Updates an existing stream. The stream version will be incremented by one.
UpdateThing
- ThingName => Str
- [AttributePayload => Paws::IoT::AttributePayload]
- [ExpectedVersion => Int]
- [RemoveThingType => Bool]
- [ThingTypeName => Str]
Each argument is described in detail in: Paws::IoT::UpdateThing
Returns: a Paws::IoT::UpdateThingResponse instance
Updates the data for a thing.
UpdateThingGroup
- ThingGroupName => Str
- ThingGroupProperties => Paws::IoT::ThingGroupProperties
- [ExpectedVersion => Int]
Each argument is described in detail in: Paws::IoT::UpdateThingGroup
Returns: a Paws::IoT::UpdateThingGroupResponse instance
Update a thing group.
UpdateThingGroupsForThing
- [OverrideDynamicGroups => Bool]
- [ThingGroupsToAdd => ArrayRef[Str|Undef]]
- [ThingGroupsToRemove => ArrayRef[Str|Undef]]
- [ThingName => Str]
Each argument is described in detail in: Paws::IoT::UpdateThingGroupsForThing
Returns: a Paws::IoT::UpdateThingGroupsForThingResponse instance
Updates the groups to which the thing belongs.
ValidateSecurityProfileBehaviors
- Behaviors => ArrayRef[Paws::IoT::Behavior]
Each argument is described in detail in: Paws::IoT::ValidateSecurityProfileBehaviors
Returns: a Paws::IoT::ValidateSecurityProfileBehaviorsResponse instance
Validates a Device Defender security profile behaviors specification.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
ListAllActiveViolations(sub { },[MaxResults => Int, NextToken => Str, SecurityProfileName => Str, ThingName => Str])
ListAllActiveViolations([MaxResults => Int, NextToken => Str, SecurityProfileName => Str, ThingName => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- activeViolations, passing the object as the first parameter, and the string 'activeViolations' as the second parameter
If not, it will return a a Paws::IoT::ListActiveViolationsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAttachedPolicies(sub { },Target => Str, [Marker => Str, PageSize => Int, Recursive => Bool])
ListAllAttachedPolicies(Target => Str, [Marker => Str, PageSize => Int, Recursive => Bool])
If passed a sub as first parameter, it will call the sub for each element found in :
- policies, passing the object as the first parameter, and the string 'policies' as the second parameter
If not, it will return a a Paws::IoT::ListAttachedPoliciesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAuditFindings(sub { },[CheckName => Str, EndTime => Str, MaxResults => Int, NextToken => Str, ResourceIdentifier => Paws::IoT::ResourceIdentifier, StartTime => Str, TaskId => Str])
ListAllAuditFindings([CheckName => Str, EndTime => Str, MaxResults => Int, NextToken => Str, ResourceIdentifier => Paws::IoT::ResourceIdentifier, StartTime => Str, TaskId => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- findings, passing the object as the first parameter, and the string 'findings' as the second parameter
If not, it will return a a Paws::IoT::ListAuditFindingsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAuditTasks(sub { },EndTime => Str, StartTime => Str, [MaxResults => Int, NextToken => Str, TaskStatus => Str, TaskType => Str])
ListAllAuditTasks(EndTime => Str, StartTime => Str, [MaxResults => Int, NextToken => Str, TaskStatus => Str, TaskType => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- tasks, passing the object as the first parameter, and the string 'tasks' as the second parameter
If not, it will return a a Paws::IoT::ListAuditTasksResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAuthorizers(sub { },[AscendingOrder => Bool, Marker => Str, PageSize => Int, Status => Str])
ListAllAuthorizers([AscendingOrder => Bool, Marker => Str, PageSize => Int, Status => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- authorizers, passing the object as the first parameter, and the string 'authorizers' as the second parameter
If not, it will return a a Paws::IoT::ListAuthorizersResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllBillingGroups(sub { },[MaxResults => Int, NamePrefixFilter => Str, NextToken => Str])
ListAllBillingGroups([MaxResults => Int, NamePrefixFilter => Str, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- billingGroups, passing the object as the first parameter, and the string 'billingGroups' as the second parameter
If not, it will return a a Paws::IoT::ListBillingGroupsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllCACertificates(sub { },[AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllCACertificates([AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- certificates, passing the object as the first parameter, and the string 'certificates' as the second parameter
If not, it will return a a Paws::IoT::ListCACertificatesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllCertificates(sub { },[AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllCertificates([AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- certificates, passing the object as the first parameter, and the string 'certificates' as the second parameter
If not, it will return a a Paws::IoT::ListCertificatesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllCertificatesByCA(sub { },CaCertificateId => Str, [AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllCertificatesByCA(CaCertificateId => Str, [AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- certificates, passing the object as the first parameter, and the string 'certificates' as the second parameter
If not, it will return a a Paws::IoT::ListCertificatesByCAResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllIndices(sub { },[MaxResults => Int, NextToken => Str])
ListAllIndices([MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- indexNames, passing the object as the first parameter, and the string 'indexNames' as the second parameter
If not, it will return a a Paws::IoT::ListIndicesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllJobExecutionsForJob(sub { },JobId => Str, [MaxResults => Int, NextToken => Str, Status => Str])
ListAllJobExecutionsForJob(JobId => Str, [MaxResults => Int, NextToken => Str, Status => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- executionSummaries, passing the object as the first parameter, and the string 'executionSummaries' as the second parameter
If not, it will return a a Paws::IoT::ListJobExecutionsForJobResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllJobExecutionsForThing(sub { },ThingName => Str, [MaxResults => Int, NextToken => Str, Status => Str])
ListAllJobExecutionsForThing(ThingName => Str, [MaxResults => Int, NextToken => Str, Status => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- executionSummaries, passing the object as the first parameter, and the string 'executionSummaries' as the second parameter
If not, it will return a a Paws::IoT::ListJobExecutionsForThingResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllJobs(sub { },[MaxResults => Int, NextToken => Str, Status => Str, TargetSelection => Str, ThingGroupId => Str, ThingGroupName => Str])
ListAllJobs([MaxResults => Int, NextToken => Str, Status => Str, TargetSelection => Str, ThingGroupId => Str, ThingGroupName => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- jobs, passing the object as the first parameter, and the string 'jobs' as the second parameter
If not, it will return a a Paws::IoT::ListJobsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllOTAUpdates(sub { },[MaxResults => Int, NextToken => Str, OtaUpdateStatus => Str])
ListAllOTAUpdates([MaxResults => Int, NextToken => Str, OtaUpdateStatus => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- otaUpdates, passing the object as the first parameter, and the string 'otaUpdates' as the second parameter
If not, it will return a a Paws::IoT::ListOTAUpdatesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllOutgoingCertificates(sub { },[AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllOutgoingCertificates([AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- outgoingCertificates, passing the object as the first parameter, and the string 'outgoingCertificates' as the second parameter
If not, it will return a a Paws::IoT::ListOutgoingCertificatesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPolicies(sub { },[AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllPolicies([AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- policies, passing the object as the first parameter, and the string 'policies' as the second parameter
If not, it will return a a Paws::IoT::ListPoliciesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPolicyPrincipals(sub { },PolicyName => Str, [AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllPolicyPrincipals(PolicyName => Str, [AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- principals, passing the object as the first parameter, and the string 'principals' as the second parameter
If not, it will return a a Paws::IoT::ListPolicyPrincipalsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPrincipalPolicies(sub { },Principal => Str, [AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllPrincipalPolicies(Principal => Str, [AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- policies, passing the object as the first parameter, and the string 'policies' as the second parameter
If not, it will return a a Paws::IoT::ListPrincipalPoliciesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllPrincipalThings(sub { },Principal => Str, [MaxResults => Int, NextToken => Str])
ListAllPrincipalThings(Principal => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- things, passing the object as the first parameter, and the string 'things' as the second parameter
If not, it will return a a Paws::IoT::ListPrincipalThingsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllRoleAliases(sub { },[AscendingOrder => Bool, Marker => Str, PageSize => Int])
ListAllRoleAliases([AscendingOrder => Bool, Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- roleAliases, passing the object as the first parameter, and the string 'roleAliases' as the second parameter
If not, it will return a a Paws::IoT::ListRoleAliasesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllScheduledAudits(sub { },[MaxResults => Int, NextToken => Str])
ListAllScheduledAudits([MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- scheduledAudits, passing the object as the first parameter, and the string 'scheduledAudits' as the second parameter
If not, it will return a a Paws::IoT::ListScheduledAuditsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllSecurityProfiles(sub { },[MaxResults => Int, NextToken => Str])
ListAllSecurityProfiles([MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- securityProfileIdentifiers, passing the object as the first parameter, and the string 'securityProfileIdentifiers' as the second parameter
If not, it will return a a Paws::IoT::ListSecurityProfilesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllSecurityProfilesForTarget(sub { },SecurityProfileTargetArn => Str, [MaxResults => Int, NextToken => Str, Recursive => Bool])
ListAllSecurityProfilesForTarget(SecurityProfileTargetArn => Str, [MaxResults => Int, NextToken => Str, Recursive => Bool])
If passed a sub as first parameter, it will call the sub for each element found in :
- securityProfileTargetMappings, passing the object as the first parameter, and the string 'securityProfileTargetMappings' as the second parameter
If not, it will return a a Paws::IoT::ListSecurityProfilesForTargetResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllStreams(sub { },[AscendingOrder => Bool, MaxResults => Int, NextToken => Str])
ListAllStreams([AscendingOrder => Bool, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- streams, passing the object as the first parameter, and the string 'streams' as the second parameter
If not, it will return a a Paws::IoT::ListStreamsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllTagsForResource(sub { },ResourceArn => Str, [NextToken => Str])
ListAllTagsForResource(ResourceArn => Str, [NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- tags, passing the object as the first parameter, and the string 'tags' as the second parameter
If not, it will return a a Paws::IoT::ListTagsForResourceResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllTargetsForPolicy(sub { },PolicyName => Str, [Marker => Str, PageSize => Int])
ListAllTargetsForPolicy(PolicyName => Str, [Marker => Str, PageSize => Int])
If passed a sub as first parameter, it will call the sub for each element found in :
- targets, passing the object as the first parameter, and the string 'targets' as the second parameter
If not, it will return a a Paws::IoT::ListTargetsForPolicyResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllTargetsForSecurityProfile(sub { },SecurityProfileName => Str, [MaxResults => Int, NextToken => Str])
ListAllTargetsForSecurityProfile(SecurityProfileName => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- securityProfileTargets, passing the object as the first parameter, and the string 'securityProfileTargets' as the second parameter
If not, it will return a a Paws::IoT::ListTargetsForSecurityProfileResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllThingGroups(sub { },[MaxResults => Int, NamePrefixFilter => Str, NextToken => Str, ParentGroup => Str, Recursive => Bool])
ListAllThingGroups([MaxResults => Int, NamePrefixFilter => Str, NextToken => Str, ParentGroup => Str, Recursive => Bool])
If passed a sub as first parameter, it will call the sub for each element found in :
- thingGroups, passing the object as the first parameter, and the string 'thingGroups' as the second parameter
If not, it will return a a Paws::IoT::ListThingGroupsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllThingGroupsForThing(sub { },ThingName => Str, [MaxResults => Int, NextToken => Str])
ListAllThingGroupsForThing(ThingName => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- thingGroups, passing the object as the first parameter, and the string 'thingGroups' as the second parameter
If not, it will return a a Paws::IoT::ListThingGroupsForThingResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllThingRegistrationTasks(sub { },[MaxResults => Int, NextToken => Str, Status => Str])
ListAllThingRegistrationTasks([MaxResults => Int, NextToken => Str, Status => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- taskIds, passing the object as the first parameter, and the string 'taskIds' as the second parameter
If not, it will return a a Paws::IoT::ListThingRegistrationTasksResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllThings(sub { },[AttributeName => Str, AttributeValue => Str, MaxResults => Int, NextToken => Str, ThingTypeName => Str])
ListAllThings([AttributeName => Str, AttributeValue => Str, MaxResults => Int, NextToken => Str, ThingTypeName => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- things, passing the object as the first parameter, and the string 'things' as the second parameter
If not, it will return a a Paws::IoT::ListThingsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllThingsInBillingGroup(sub { },BillingGroupName => Str, [MaxResults => Int, NextToken => Str])
ListAllThingsInBillingGroup(BillingGroupName => Str, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- things, passing the object as the first parameter, and the string 'things' as the second parameter
If not, it will return a a Paws::IoT::ListThingsInBillingGroupResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllThingsInThingGroup(sub { },ThingGroupName => Str, [MaxResults => Int, NextToken => Str, Recursive => Bool])
ListAllThingsInThingGroup(ThingGroupName => Str, [MaxResults => Int, NextToken => Str, Recursive => Bool])
If passed a sub as first parameter, it will call the sub for each element found in :
- things, passing the object as the first parameter, and the string 'things' as the second parameter
If not, it will return a a Paws::IoT::ListThingsInThingGroupResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllThingTypes(sub { },[MaxResults => Int, NextToken => Str, ThingTypeName => Str])
ListAllThingTypes([MaxResults => Int, NextToken => Str, ThingTypeName => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- thingTypes, passing the object as the first parameter, and the string 'thingTypes' as the second parameter
If not, it will return a a Paws::IoT::ListThingTypesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllTopicRules(sub { },[MaxResults => Int, NextToken => Str, RuleDisabled => Bool, Topic => Str])
ListAllTopicRules([MaxResults => Int, NextToken => Str, RuleDisabled => Bool, Topic => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- rules, passing the object as the first parameter, and the string 'rules' as the second parameter
If not, it will return a a Paws::IoT::ListTopicRulesResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllV2LoggingLevels(sub { },[MaxResults => Int, NextToken => Str, TargetType => Str])
ListAllV2LoggingLevels([MaxResults => Int, NextToken => Str, TargetType => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- logTargetConfigurations, passing the object as the first parameter, and the string 'logTargetConfigurations' as the second parameter
If not, it will return a a Paws::IoT::ListV2LoggingLevelsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllViolationEvents(sub { },EndTime => Str, StartTime => Str, [MaxResults => Int, NextToken => Str, SecurityProfileName => Str, ThingName => Str])
ListAllViolationEvents(EndTime => Str, StartTime => Str, [MaxResults => Int, NextToken => Str, SecurityProfileName => Str, ThingName => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- violationEvents, passing the object as the first parameter, and the string 'violationEvents' as the second parameter
If not, it will return a a Paws::IoT::ListViolationEventsResponse instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues