iot

package module
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2015-05-28"
View Source
const ServiceID = "IoT"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AcceptCertificateTransferInput

type AcceptCertificateTransferInput struct {
	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string
	// Specifies whether the certificate is active.
	SetAsActive *bool
}

The input for the AcceptCertificateTransfer operation.

type AcceptCertificateTransferOutput

type AcceptCertificateTransferOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AddThingToBillingGroupInput

type AddThingToBillingGroupInput struct {
	// The ARN of the billing group.
	BillingGroupArn *string
	// The name of the thing to be added to the billing group.
	ThingName *string
	// The ARN of the thing to be added to the billing group.
	ThingArn *string
	// The name of the billing group.
	BillingGroupName *string
}

type AddThingToBillingGroupOutput

type AddThingToBillingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AddThingToThingGroupInput

type AddThingToThingGroupInput struct {
	// The name of the thing to add to a group.
	ThingName *string
	// The name of the group to which you are adding a thing.
	ThingGroupName *string
	// Override dynamic thing groups with static thing groups when 10-group limit is
	// reached. If a thing belongs to 10 thing groups, and one or more of those groups
	// are dynamic thing groups, adding a thing to a static group removes the thing
	// from the last dynamic group.
	OverrideDynamicGroups *bool
	// The ARN of the thing to add to a group.
	ThingArn *string
	// The ARN of the group to which you are adding a thing.
	ThingGroupArn *string
}

type AddThingToThingGroupOutput

type AddThingToThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateTargetsWithJobInput

type AssociateTargetsWithJobInput struct {
	// The unique identifier you assigned to this job when it was created.
	JobId *string
	// A list of thing group ARNs that define the targets of the job.
	Targets []*string
	// An optional comment string describing why the job was associated with the
	// targets.
	Comment *string
}

type AssociateTargetsWithJobOutput

type AssociateTargetsWithJobOutput struct {
	// An ARN identifying the job.
	JobArn *string
	// A short text description of the job.
	Description *string
	// The unique identifier you assigned to this job when it was created.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachPolicyInput

type AttachPolicyInput struct {
	// The identity
	// (https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html) to
	// which the policy is attached.
	Target *string
	// The name of the policy to attach.
	PolicyName *string
}

type AttachPolicyOutput

type AttachPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachPrincipalPolicyInput

type AttachPrincipalPolicyInput struct {
	// The policy name.
	PolicyName *string
	// The principal, which can be a certificate ARN (as returned from the
	// CreateCertificate operation) or an Amazon Cognito ID.
	Principal *string
}

The input for the AttachPrincipalPolicy operation.

type AttachPrincipalPolicyOutput

type AttachPrincipalPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachSecurityProfileInput

type AttachSecurityProfileInput struct {
	// The ARN of the target (thing group) to which the security profile is attached.
	SecurityProfileTargetArn *string
	// The security profile that is attached.
	SecurityProfileName *string
}

type AttachSecurityProfileOutput

type AttachSecurityProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AttachThingPrincipalInput

type AttachThingPrincipalInput struct {
	// The principal, which can be a certificate ARN (as returned from the
	// CreateCertificate operation) or an Amazon Cognito ID.
	Principal *string
	// The name of the thing.
	ThingName *string
}

The input for the AttachThingPrincipal operation.

type AttachThingPrincipalOutput

type AttachThingPrincipalOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the AttachThingPrincipal operation.

type CancelAuditMitigationActionsTaskInput

type CancelAuditMitigationActionsTaskInput struct {
	// The unique identifier for the task that you want to cancel.
	TaskId *string
}

type CancelAuditMitigationActionsTaskOutput

type CancelAuditMitigationActionsTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelAuditTaskInput

type CancelAuditTaskInput struct {
	// The ID of the audit you want to cancel. You can only cancel an audit that is
	// "IN_PROGRESS".
	TaskId *string
}

type CancelAuditTaskOutput

type CancelAuditTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelCertificateTransferInput

type CancelCertificateTransferInput struct {
	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string
}

The input for the CancelCertificateTransfer operation.

type CancelCertificateTransferOutput

type CancelCertificateTransferOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelJobExecutionInput

type CancelJobExecutionInput struct {
	// A collection of name/value pairs that describe the status of the job execution.
	// If not specified, the statusDetails are unchanged. You can specify at most 10
	// name/value pairs.
	StatusDetails map[string]*string
	// (Optional) If true the job execution will be canceled if it has status
	// IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it
	// has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS,
	// and you do not set force to true, then an InvalidStateTransitionException will
	// be thrown. The default is false. Canceling a job execution which is
	// "IN_PROGRESS", will cause the device to be unable to update the job execution
	// status. Use caution and ensure that the device is able to recover to a valid
	// state.
	Force *bool
	// (Optional) The expected current version of the job execution. Each time you
	// update the job execution, its version is incremented. If the version of the job
	// execution stored in Jobs does not match, the update is rejected with a
	// VersionMismatch error, and an ErrorResponse that contains the current job
	// execution status data is returned. (This makes it unnecessary to perform a
	// separate DescribeJobExecution request in order to obtain the job execution
	// status data.)
	ExpectedVersion *int64
	// The ID of the job to be canceled.
	JobId *string
	// The name of the thing whose execution of the job will be canceled.
	ThingName *string
}

type CancelJobExecutionOutput

type CancelJobExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CancelJobInput

type CancelJobInput struct {
	// The unique identifier you assigned to this job when it was created.
	JobId *string
	// An optional comment string describing why the job was canceled.
	Comment *string
	// (Optional)A reason code string that explains why the job was canceled.
	ReasonCode *string
	// (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are
	// canceled, otherwise only job executions with status "QUEUED" are canceled. The
	// default is false. Canceling a job which is "IN_PROGRESS", will cause a device
	// which is executing the job to be unable to update the job execution status. Use
	// caution and ensure that each device executing a job which is canceled is able to
	// recover to a valid state.
	Force *bool
}

type CancelJobOutput

type CancelJobOutput struct {
	// The unique identifier you assigned to this job when it was created.
	JobId *string
	// The job ARN.
	JobArn *string
	// A short text description of the job.
	Description *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ClearDefaultAuthorizerInput

type ClearDefaultAuthorizerInput struct {
}

type ClearDefaultAuthorizerOutput

type ClearDefaultAuthorizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

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. The service endpoints that expose this API are listed in AWS IoT Core Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/iot-core.html). You must use the endpoint for the region that has the resources you want to access. The service name used by AWS Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) to sign the request is: execute-api. 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).

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AcceptCertificateTransfer

func (c *Client) AcceptCertificateTransfer(ctx context.Context, params *AcceptCertificateTransferInput, optFns ...func(*Options)) (*AcceptCertificateTransferOutput, error)

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.

func (*Client) AddThingToBillingGroup

func (c *Client) AddThingToBillingGroup(ctx context.Context, params *AddThingToBillingGroupInput, optFns ...func(*Options)) (*AddThingToBillingGroupOutput, error)

Adds a thing to a billing group.

func (*Client) AddThingToThingGroup

func (c *Client) AddThingToThingGroup(ctx context.Context, params *AddThingToThingGroupInput, optFns ...func(*Options)) (*AddThingToThingGroupOutput, error)

Adds a thing to a thing group.

func (*Client) AssociateTargetsWithJob

func (c *Client) AssociateTargetsWithJob(ctx context.Context, params *AssociateTargetsWithJobInput, optFns ...func(*Options)) (*AssociateTargetsWithJobOutput, error)

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.

func (*Client) AttachPolicy

func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, optFns ...func(*Options)) (*AttachPolicyOutput, error)

Attaches a policy to the specified target.

func (*Client) AttachPrincipalPolicy

func (c *Client) AttachPrincipalPolicy(ctx context.Context, params *AttachPrincipalPolicyInput, optFns ...func(*Options)) (*AttachPrincipalPolicyOutput, error)

Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy () instead.

func (*Client) AttachSecurityProfile

func (c *Client) AttachSecurityProfile(ctx context.Context, params *AttachSecurityProfileInput, optFns ...func(*Options)) (*AttachSecurityProfileOutput, error)

Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.

func (*Client) AttachThingPrincipal

func (c *Client) AttachThingPrincipal(ctx context.Context, params *AttachThingPrincipalInput, optFns ...func(*Options)) (*AttachThingPrincipalOutput, error)

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.

func (*Client) CancelAuditMitigationActionsTask

func (c *Client) CancelAuditMitigationActionsTask(ctx context.Context, params *CancelAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*CancelAuditMitigationActionsTaskOutput, error)

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

func (*Client) CancelAuditTask

func (c *Client) CancelAuditTask(ctx context.Context, params *CancelAuditTaskInput, optFns ...func(*Options)) (*CancelAuditTaskOutput, error)

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.

func (*Client) CancelCertificateTransfer

func (c *Client) CancelCertificateTransfer(ctx context.Context, params *CancelCertificateTransferInput, optFns ...func(*Options)) (*CancelCertificateTransferOutput, error)

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.

func (*Client) CancelJob

func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error)

Cancels a job.

func (*Client) CancelJobExecution

func (c *Client) CancelJobExecution(ctx context.Context, params *CancelJobExecutionInput, optFns ...func(*Options)) (*CancelJobExecutionOutput, error)

Cancels the execution of a job for a given thing.

func (*Client) ClearDefaultAuthorizer

func (c *Client) ClearDefaultAuthorizer(ctx context.Context, params *ClearDefaultAuthorizerInput, optFns ...func(*Options)) (*ClearDefaultAuthorizerOutput, error)

Clears the default authorizer.

func (*Client) ConfirmTopicRuleDestination

func (c *Client) ConfirmTopicRuleDestination(ctx context.Context, params *ConfirmTopicRuleDestinationInput, optFns ...func(*Options)) (*ConfirmTopicRuleDestinationOutput, error)

Confirms a topic rule destination. When you create a rule requiring a destination, AWS IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

func (*Client) CreateAuthorizer

func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerInput, optFns ...func(*Options)) (*CreateAuthorizerOutput, error)

Creates an authorizer.

func (*Client) CreateBillingGroup

func (c *Client) CreateBillingGroup(ctx context.Context, params *CreateBillingGroupInput, optFns ...func(*Options)) (*CreateBillingGroupOutput, error)

Creates a billing group.

func (*Client) CreateCertificateFromCsr

func (c *Client) CreateCertificateFromCsr(ctx context.Context, params *CreateCertificateFromCsrInput, optFns ...func(*Options)) (*CreateCertificateFromCsrOutput, error)

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: <p>On Linux and OS X, the command is:</p> <p>$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>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.</p> <p>The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:</p> <p>$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}</p> <p>On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"</p>

func (*Client) CreateDimension

func (c *Client) CreateDimension(ctx context.Context, params *CreateDimensionInput, optFns ...func(*Options)) (*CreateDimensionOutput, error)

Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

func (*Client) CreateDomainConfiguration

func (c *Client) CreateDomainConfiguration(ctx context.Context, params *CreateDomainConfigurationInput, optFns ...func(*Options)) (*CreateDomainConfigurationOutput, error)

Creates a domain configuration. The domain configuration feature is in public preview and is subject to change.

func (*Client) CreateDynamicThingGroup

func (c *Client) CreateDynamicThingGroup(ctx context.Context, params *CreateDynamicThingGroupInput, optFns ...func(*Options)) (*CreateDynamicThingGroupOutput, error)

Creates a dynamic thing group.

func (*Client) CreateJob

func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)

Creates a job.

func (*Client) CreateKeysAndCertificate

func (c *Client) CreateKeysAndCertificate(ctx context.Context, params *CreateKeysAndCertificateInput, optFns ...func(*Options)) (*CreateKeysAndCertificateOutput, error)

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API (https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#provision-mqtt-api). 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.

func (*Client) CreateMitigationAction

func (c *Client) CreateMitigationAction(ctx context.Context, params *CreateMitigationActionInput, optFns ...func(*Options)) (*CreateMitigationActionOutput, error)

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.

func (*Client) CreateOTAUpdate

func (c *Client) CreateOTAUpdate(ctx context.Context, params *CreateOTAUpdateInput, optFns ...func(*Options)) (*CreateOTAUpdateOutput, error)

Creates an AWS IoT OTAUpdate on a target group of things or groups.

func (*Client) CreatePolicy

func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error)

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.

func (*Client) CreatePolicyVersion

func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVersionInput, optFns ...func(*Options)) (*CreatePolicyVersionOutput, error)

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

func (*Client) CreateProvisioningClaim

func (c *Client) CreateProvisioningClaim(ctx context.Context, params *CreateProvisioningClaimInput, optFns ...func(*Options)) (*CreateProvisioningClaimOutput, error)

Creates a provisioning claim.

func (*Client) CreateProvisioningTemplate

func (c *Client) CreateProvisioningTemplate(ctx context.Context, params *CreateProvisioningTemplateInput, optFns ...func(*Options)) (*CreateProvisioningTemplateOutput, error)

Creates a fleet provisioning template.

func (*Client) CreateProvisioningTemplateVersion

func (c *Client) CreateProvisioningTemplateVersion(ctx context.Context, params *CreateProvisioningTemplateVersionInput, optFns ...func(*Options)) (*CreateProvisioningTemplateVersionOutput, error)

Creates a new version of a fleet provisioning template.

func (*Client) CreateRoleAlias

func (c *Client) CreateRoleAlias(ctx context.Context, params *CreateRoleAliasInput, optFns ...func(*Options)) (*CreateRoleAliasOutput, error)

Creates a role alias.

func (*Client) CreateScheduledAudit

func (c *Client) CreateScheduledAudit(ctx context.Context, params *CreateScheduledAuditInput, optFns ...func(*Options)) (*CreateScheduledAuditOutput, error)

Creates a scheduled audit that is run at a specified time interval.

func (*Client) CreateSecurityProfile

func (c *Client) CreateSecurityProfile(ctx context.Context, params *CreateSecurityProfileInput, optFns ...func(*Options)) (*CreateSecurityProfileOutput, error)

Creates a Device Defender security profile.

func (*Client) CreateStream

func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error)

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.

func (*Client) CreateThing

func (c *Client) CreateThing(ctx context.Context, params *CreateThingInput, optFns ...func(*Options)) (*CreateThingOutput, error)

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/iot-authorization.html) for information about authorizing control plane actions.

func (*Client) CreateThingGroup

func (c *Client) CreateThingGroup(ctx context.Context, params *CreateThingGroupInput, optFns ...func(*Options)) (*CreateThingGroupOutput, error)

Create a thing group. This is a control plane operation. See Authorization (https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) for information about authorizing control plane actions.

func (*Client) CreateThingType

func (c *Client) CreateThingType(ctx context.Context, params *CreateThingTypeInput, optFns ...func(*Options)) (*CreateThingTypeOutput, error)

Creates a new thing type.

func (*Client) CreateTopicRule

func (c *Client) CreateTopicRule(ctx context.Context, params *CreateTopicRuleInput, optFns ...func(*Options)) (*CreateTopicRuleOutput, error)

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.

func (*Client) CreateTopicRuleDestination

func (c *Client) CreateTopicRuleDestination(ctx context.Context, params *CreateTopicRuleDestinationInput, optFns ...func(*Options)) (*CreateTopicRuleDestinationOutput, error)

Creates a topic rule destination. The destination must be confirmed prior to use.

func (*Client) DeleteAccountAuditConfiguration

func (c *Client) DeleteAccountAuditConfiguration(ctx context.Context, params *DeleteAccountAuditConfigurationInput, optFns ...func(*Options)) (*DeleteAccountAuditConfigurationOutput, error)

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.

func (*Client) DeleteAuthorizer

func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerInput, optFns ...func(*Options)) (*DeleteAuthorizerOutput, error)

Deletes an authorizer.

func (*Client) DeleteBillingGroup

func (c *Client) DeleteBillingGroup(ctx context.Context, params *DeleteBillingGroupInput, optFns ...func(*Options)) (*DeleteBillingGroupOutput, error)

Deletes the billing group.

func (*Client) DeleteCACertificate

func (c *Client) DeleteCACertificate(ctx context.Context, params *DeleteCACertificateInput, optFns ...func(*Options)) (*DeleteCACertificateOutput, error)

Deletes a registered CA certificate.

func (*Client) DeleteCertificate

func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificateInput, optFns ...func(*Options)) (*DeleteCertificateOutput, error)

Deletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing 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.

func (*Client) DeleteDimension

func (c *Client) DeleteDimension(ctx context.Context, params *DeleteDimensionInput, optFns ...func(*Options)) (*DeleteDimensionOutput, error)

Removes the specified dimension from your AWS account.

func (*Client) DeleteDomainConfiguration

func (c *Client) DeleteDomainConfiguration(ctx context.Context, params *DeleteDomainConfigurationInput, optFns ...func(*Options)) (*DeleteDomainConfigurationOutput, error)

Deletes the specified domain configuration. The domain configuration feature is in public preview and is subject to change.

func (*Client) DeleteDynamicThingGroup

func (c *Client) DeleteDynamicThingGroup(ctx context.Context, params *DeleteDynamicThingGroupInput, optFns ...func(*Options)) (*DeleteDynamicThingGroupOutput, error)

Deletes a dynamic thing group.

func (*Client) DeleteJob

func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns ...func(*Options)) (*DeleteJobOutput, error)

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.

func (*Client) DeleteJobExecution

func (c *Client) DeleteJobExecution(ctx context.Context, params *DeleteJobExecutionInput, optFns ...func(*Options)) (*DeleteJobExecutionOutput, error)

Deletes a job execution.

func (*Client) DeleteMitigationAction

func (c *Client) DeleteMitigationAction(ctx context.Context, params *DeleteMitigationActionInput, optFns ...func(*Options)) (*DeleteMitigationActionOutput, error)

Deletes a defined mitigation action from your AWS account.

func (*Client) DeleteOTAUpdate

func (c *Client) DeleteOTAUpdate(ctx context.Context, params *DeleteOTAUpdateInput, optFns ...func(*Options)) (*DeleteOTAUpdateOutput, error)

Delete an OTA update.

func (*Client) DeletePolicy

func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error)

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.

func (*Client) DeletePolicyVersion

func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVersionInput, optFns ...func(*Options)) (*DeletePolicyVersionOutput, error)

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.

func (*Client) DeleteProvisioningTemplate

func (c *Client) DeleteProvisioningTemplate(ctx context.Context, params *DeleteProvisioningTemplateInput, optFns ...func(*Options)) (*DeleteProvisioningTemplateOutput, error)

Deletes a fleet provisioning template.

func (*Client) DeleteProvisioningTemplateVersion

func (c *Client) DeleteProvisioningTemplateVersion(ctx context.Context, params *DeleteProvisioningTemplateVersionInput, optFns ...func(*Options)) (*DeleteProvisioningTemplateVersionOutput, error)

Deletes a fleet provisioning template version.

func (*Client) DeleteRegistrationCode

func (c *Client) DeleteRegistrationCode(ctx context.Context, params *DeleteRegistrationCodeInput, optFns ...func(*Options)) (*DeleteRegistrationCodeOutput, error)

Deletes a CA certificate registration code.

func (*Client) DeleteRoleAlias

func (c *Client) DeleteRoleAlias(ctx context.Context, params *DeleteRoleAliasInput, optFns ...func(*Options)) (*DeleteRoleAliasOutput, error)

Deletes a role alias

func (*Client) DeleteScheduledAudit

func (c *Client) DeleteScheduledAudit(ctx context.Context, params *DeleteScheduledAuditInput, optFns ...func(*Options)) (*DeleteScheduledAuditOutput, error)

Deletes a scheduled audit.

func (*Client) DeleteSecurityProfile

func (c *Client) DeleteSecurityProfile(ctx context.Context, params *DeleteSecurityProfileInput, optFns ...func(*Options)) (*DeleteSecurityProfileOutput, error)

Deletes a Device Defender security profile.

func (*Client) DeleteStream

func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, optFns ...func(*Options)) (*DeleteStreamOutput, error)

Deletes a stream.

func (*Client) DeleteThing

func (c *Client) DeleteThing(ctx context.Context, params *DeleteThingInput, optFns ...func(*Options)) (*DeleteThingOutput, error)

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

func (*Client) DeleteThingGroup

func (c *Client) DeleteThingGroup(ctx context.Context, params *DeleteThingGroupInput, optFns ...func(*Options)) (*DeleteThingGroupOutput, error)

Deletes a thing group.

func (*Client) DeleteThingType

func (c *Client) DeleteThingType(ctx context.Context, params *DeleteThingTypeInput, optFns ...func(*Options)) (*DeleteThingTypeOutput, error)

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.

func (*Client) DeleteTopicRule

func (c *Client) DeleteTopicRule(ctx context.Context, params *DeleteTopicRuleInput, optFns ...func(*Options)) (*DeleteTopicRuleOutput, error)

Deletes the rule.

func (*Client) DeleteTopicRuleDestination

func (c *Client) DeleteTopicRuleDestination(ctx context.Context, params *DeleteTopicRuleDestinationInput, optFns ...func(*Options)) (*DeleteTopicRuleDestinationOutput, error)

Deletes a topic rule destination.

func (*Client) DeleteV2LoggingLevel

func (c *Client) DeleteV2LoggingLevel(ctx context.Context, params *DeleteV2LoggingLevelInput, optFns ...func(*Options)) (*DeleteV2LoggingLevelOutput, error)

Deletes a logging level.

func (*Client) DeprecateThingType

func (c *Client) DeprecateThingType(ctx context.Context, params *DeprecateThingTypeInput, optFns ...func(*Options)) (*DeprecateThingTypeOutput, error)

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

func (*Client) DescribeAccountAuditConfiguration

func (c *Client) DescribeAccountAuditConfiguration(ctx context.Context, params *DescribeAccountAuditConfigurationInput, optFns ...func(*Options)) (*DescribeAccountAuditConfigurationOutput, error)

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.

func (*Client) DescribeAuditFinding

func (c *Client) DescribeAuditFinding(ctx context.Context, params *DescribeAuditFindingInput, optFns ...func(*Options)) (*DescribeAuditFindingOutput, error)

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.

func (*Client) DescribeAuditMitigationActionsTask

func (c *Client) DescribeAuditMitigationActionsTask(ctx context.Context, params *DescribeAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*DescribeAuditMitigationActionsTaskOutput, error)

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

func (*Client) DescribeAuditTask

func (c *Client) DescribeAuditTask(ctx context.Context, params *DescribeAuditTaskInput, optFns ...func(*Options)) (*DescribeAuditTaskOutput, error)

Gets information about a Device Defender audit.

func (*Client) DescribeAuthorizer

func (c *Client) DescribeAuthorizer(ctx context.Context, params *DescribeAuthorizerInput, optFns ...func(*Options)) (*DescribeAuthorizerOutput, error)

Describes an authorizer.

func (*Client) DescribeBillingGroup

func (c *Client) DescribeBillingGroup(ctx context.Context, params *DescribeBillingGroupInput, optFns ...func(*Options)) (*DescribeBillingGroupOutput, error)

Returns information about a billing group.

func (*Client) DescribeCACertificate

func (c *Client) DescribeCACertificate(ctx context.Context, params *DescribeCACertificateInput, optFns ...func(*Options)) (*DescribeCACertificateOutput, error)

Describes a registered CA certificate.

func (*Client) DescribeCertificate

func (c *Client) DescribeCertificate(ctx context.Context, params *DescribeCertificateInput, optFns ...func(*Options)) (*DescribeCertificateOutput, error)

Gets information about the specified certificate.

func (*Client) DescribeDefaultAuthorizer

func (c *Client) DescribeDefaultAuthorizer(ctx context.Context, params *DescribeDefaultAuthorizerInput, optFns ...func(*Options)) (*DescribeDefaultAuthorizerOutput, error)

Describes the default authorizer.

func (*Client) DescribeDimension

func (c *Client) DescribeDimension(ctx context.Context, params *DescribeDimensionInput, optFns ...func(*Options)) (*DescribeDimensionOutput, error)

Provides details about a dimension that is defined in your AWS account.

func (*Client) DescribeDomainConfiguration

func (c *Client) DescribeDomainConfiguration(ctx context.Context, params *DescribeDomainConfigurationInput, optFns ...func(*Options)) (*DescribeDomainConfigurationOutput, error)

Gets summary information about a domain configuration. The domain configuration feature is in public preview and is subject to change.

func (*Client) DescribeEndpoint

func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointInput, optFns ...func(*Options)) (*DescribeEndpointOutput, error)

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

func (*Client) DescribeEventConfigurations

func (c *Client) DescribeEventConfigurations(ctx context.Context, params *DescribeEventConfigurationsInput, optFns ...func(*Options)) (*DescribeEventConfigurationsOutput, error)

Describes event configurations.

func (*Client) DescribeIndex

func (c *Client) DescribeIndex(ctx context.Context, params *DescribeIndexInput, optFns ...func(*Options)) (*DescribeIndexOutput, error)

Describes a search index.

func (*Client) DescribeJob

func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error)

Describes a job.

func (*Client) DescribeJobExecution

func (c *Client) DescribeJobExecution(ctx context.Context, params *DescribeJobExecutionInput, optFns ...func(*Options)) (*DescribeJobExecutionOutput, error)

Describes a job execution.

func (*Client) DescribeMitigationAction

func (c *Client) DescribeMitigationAction(ctx context.Context, params *DescribeMitigationActionInput, optFns ...func(*Options)) (*DescribeMitigationActionOutput, error)

Gets information about a mitigation action.

func (*Client) DescribeProvisioningTemplate

func (c *Client) DescribeProvisioningTemplate(ctx context.Context, params *DescribeProvisioningTemplateInput, optFns ...func(*Options)) (*DescribeProvisioningTemplateOutput, error)

Returns information about a fleet provisioning template.

func (*Client) DescribeProvisioningTemplateVersion

func (c *Client) DescribeProvisioningTemplateVersion(ctx context.Context, params *DescribeProvisioningTemplateVersionInput, optFns ...func(*Options)) (*DescribeProvisioningTemplateVersionOutput, error)

Returns information about a fleet provisioning template version.

func (*Client) DescribeRoleAlias

func (c *Client) DescribeRoleAlias(ctx context.Context, params *DescribeRoleAliasInput, optFns ...func(*Options)) (*DescribeRoleAliasOutput, error)

Describes a role alias.

func (*Client) DescribeScheduledAudit

func (c *Client) DescribeScheduledAudit(ctx context.Context, params *DescribeScheduledAuditInput, optFns ...func(*Options)) (*DescribeScheduledAuditOutput, error)

Gets information about a scheduled audit.

func (*Client) DescribeSecurityProfile

func (c *Client) DescribeSecurityProfile(ctx context.Context, params *DescribeSecurityProfileInput, optFns ...func(*Options)) (*DescribeSecurityProfileOutput, error)

Gets information about a Device Defender security profile.

func (*Client) DescribeStream

func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput, optFns ...func(*Options)) (*DescribeStreamOutput, error)

Gets information about a stream.

func (*Client) DescribeThing

func (c *Client) DescribeThing(ctx context.Context, params *DescribeThingInput, optFns ...func(*Options)) (*DescribeThingOutput, error)

Gets information about the specified thing.

func (*Client) DescribeThingGroup

func (c *Client) DescribeThingGroup(ctx context.Context, params *DescribeThingGroupInput, optFns ...func(*Options)) (*DescribeThingGroupOutput, error)

Describe a thing group.

func (*Client) DescribeThingRegistrationTask

func (c *Client) DescribeThingRegistrationTask(ctx context.Context, params *DescribeThingRegistrationTaskInput, optFns ...func(*Options)) (*DescribeThingRegistrationTaskOutput, error)

Describes a bulk thing provisioning task.

func (*Client) DescribeThingType

func (c *Client) DescribeThingType(ctx context.Context, params *DescribeThingTypeInput, optFns ...func(*Options)) (*DescribeThingTypeOutput, error)

Gets information about the specified thing type.

func (*Client) DetachPolicy

func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, optFns ...func(*Options)) (*DetachPolicyOutput, error)

Detaches a policy from the specified target.

func (*Client) DetachPrincipalPolicy

func (c *Client) DetachPrincipalPolicy(ctx context.Context, params *DetachPrincipalPolicyInput, optFns ...func(*Options)) (*DetachPrincipalPolicyOutput, error)

Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy () instead.

func (*Client) DetachSecurityProfile

func (c *Client) DetachSecurityProfile(ctx context.Context, params *DetachSecurityProfileInput, optFns ...func(*Options)) (*DetachSecurityProfileOutput, error)

Disassociates a Device Defender security profile from a thing group or from this account.

func (*Client) DetachThingPrincipal

func (c *Client) DetachThingPrincipal(ctx context.Context, params *DetachThingPrincipalInput, optFns ...func(*Options)) (*DetachThingPrincipalOutput, error)

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.

func (*Client) DisableTopicRule

func (c *Client) DisableTopicRule(ctx context.Context, params *DisableTopicRuleInput, optFns ...func(*Options)) (*DisableTopicRuleOutput, error)

Disables the rule.

func (*Client) EnableTopicRule

func (c *Client) EnableTopicRule(ctx context.Context, params *EnableTopicRuleInput, optFns ...func(*Options)) (*EnableTopicRuleOutput, error)

Enables the rule.

func (*Client) GetCardinality

func (c *Client) GetCardinality(ctx context.Context, params *GetCardinalityInput, optFns ...func(*Options)) (*GetCardinalityOutput, error)

Returns the approximate count of unique values that match the query.

func (*Client) GetEffectivePolicies

func (c *Client) GetEffectivePolicies(ctx context.Context, params *GetEffectivePoliciesInput, optFns ...func(*Options)) (*GetEffectivePoliciesOutput, error)

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.

func (*Client) GetIndexingConfiguration

func (c *Client) GetIndexingConfiguration(ctx context.Context, params *GetIndexingConfigurationInput, optFns ...func(*Options)) (*GetIndexingConfigurationOutput, error)

Gets the indexing configuration.

func (*Client) GetJobDocument

func (c *Client) GetJobDocument(ctx context.Context, params *GetJobDocumentInput, optFns ...func(*Options)) (*GetJobDocumentOutput, error)

Gets a job document.

func (*Client) GetLoggingOptions

func (c *Client) GetLoggingOptions(ctx context.Context, params *GetLoggingOptionsInput, optFns ...func(*Options)) (*GetLoggingOptionsOutput, error)

Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

func (*Client) GetOTAUpdate

func (c *Client) GetOTAUpdate(ctx context.Context, params *GetOTAUpdateInput, optFns ...func(*Options)) (*GetOTAUpdateOutput, error)

Gets an OTA update.

func (*Client) GetPercentiles

func (c *Client) GetPercentiles(ctx context.Context, params *GetPercentilesInput, optFns ...func(*Options)) (*GetPercentilesOutput, error)

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

func (*Client) GetPolicy

func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error)

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

func (*Client) GetPolicyVersion

func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionInput, optFns ...func(*Options)) (*GetPolicyVersionOutput, error)

Gets information about the specified policy version.

func (*Client) GetRegistrationCode

func (c *Client) GetRegistrationCode(ctx context.Context, params *GetRegistrationCodeInput, optFns ...func(*Options)) (*GetRegistrationCodeOutput, error)

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

func (*Client) GetStatistics

func (c *Client) GetStatistics(ctx context.Context, params *GetStatisticsInput, optFns ...func(*Options)) (*GetStatisticsOutput, error)

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

func (*Client) GetTopicRule

func (c *Client) GetTopicRule(ctx context.Context, params *GetTopicRuleInput, optFns ...func(*Options)) (*GetTopicRuleOutput, error)

Gets information about the rule.

func (*Client) GetTopicRuleDestination

func (c *Client) GetTopicRuleDestination(ctx context.Context, params *GetTopicRuleDestinationInput, optFns ...func(*Options)) (*GetTopicRuleDestinationOutput, error)

Gets information about a topic rule destination.

func (*Client) GetV2LoggingOptions

func (c *Client) GetV2LoggingOptions(ctx context.Context, params *GetV2LoggingOptionsInput, optFns ...func(*Options)) (*GetV2LoggingOptionsOutput, error)

Gets the fine grained logging options.

func (*Client) ListActiveViolations

func (c *Client) ListActiveViolations(ctx context.Context, params *ListActiveViolationsInput, optFns ...func(*Options)) (*ListActiveViolationsOutput, error)

Lists the active violations for a given Device Defender security profile.

func (*Client) ListAttachedPolicies

func (c *Client) ListAttachedPolicies(ctx context.Context, params *ListAttachedPoliciesInput, optFns ...func(*Options)) (*ListAttachedPoliciesOutput, error)

Lists the policies attached to the specified thing group.

func (*Client) ListAuditFindings

func (c *Client) ListAuditFindings(ctx context.Context, params *ListAuditFindingsInput, optFns ...func(*Options)) (*ListAuditFindingsOutput, error)

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

func (*Client) ListAuditMitigationActionsExecutions

func (c *Client) ListAuditMitigationActionsExecutions(ctx context.Context, params *ListAuditMitigationActionsExecutionsInput, optFns ...func(*Options)) (*ListAuditMitigationActionsExecutionsOutput, error)

Gets the status of audit mitigation action tasks that were executed.

func (*Client) ListAuditMitigationActionsTasks

func (c *Client) ListAuditMitigationActionsTasks(ctx context.Context, params *ListAuditMitigationActionsTasksInput, optFns ...func(*Options)) (*ListAuditMitigationActionsTasksOutput, error)

Gets a list of audit mitigation action tasks that match the specified filters.

func (*Client) ListAuditTasks

func (c *Client) ListAuditTasks(ctx context.Context, params *ListAuditTasksInput, optFns ...func(*Options)) (*ListAuditTasksOutput, error)

Lists the Device Defender audits that have been performed during a given time period.

func (*Client) ListAuthorizers

func (c *Client) ListAuthorizers(ctx context.Context, params *ListAuthorizersInput, optFns ...func(*Options)) (*ListAuthorizersOutput, error)

Lists the authorizers registered in your account.

func (*Client) ListBillingGroups

func (c *Client) ListBillingGroups(ctx context.Context, params *ListBillingGroupsInput, optFns ...func(*Options)) (*ListBillingGroupsOutput, error)

Lists the billing groups you have created.

func (*Client) ListCACertificates

func (c *Client) ListCACertificates(ctx context.Context, params *ListCACertificatesInput, optFns ...func(*Options)) (*ListCACertificatesOutput, error)

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.

func (*Client) ListCertificates

func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesInput, optFns ...func(*Options)) (*ListCertificatesOutput, error)

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.

func (*Client) ListCertificatesByCA

func (c *Client) ListCertificatesByCA(ctx context.Context, params *ListCertificatesByCAInput, optFns ...func(*Options)) (*ListCertificatesByCAOutput, error)

List the device certificates signed by the specified CA certificate.

func (*Client) ListDimensions

func (c *Client) ListDimensions(ctx context.Context, params *ListDimensionsInput, optFns ...func(*Options)) (*ListDimensionsOutput, error)

List the set of dimensions that are defined for your AWS account.

func (*Client) ListDomainConfigurations

func (c *Client) ListDomainConfigurations(ctx context.Context, params *ListDomainConfigurationsInput, optFns ...func(*Options)) (*ListDomainConfigurationsOutput, error)

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. The domain configuration feature is in public preview and is subject to change.

func (*Client) ListIndices

func (c *Client) ListIndices(ctx context.Context, params *ListIndicesInput, optFns ...func(*Options)) (*ListIndicesOutput, error)

Lists the search indices.

func (*Client) ListJobExecutionsForJob

func (c *Client) ListJobExecutionsForJob(ctx context.Context, params *ListJobExecutionsForJobInput, optFns ...func(*Options)) (*ListJobExecutionsForJobOutput, error)

Lists the job executions for a job.

func (*Client) ListJobExecutionsForThing

func (c *Client) ListJobExecutionsForThing(ctx context.Context, params *ListJobExecutionsForThingInput, optFns ...func(*Options)) (*ListJobExecutionsForThingOutput, error)

Lists the job executions for the specified thing.

func (*Client) ListJobs

func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)

Lists jobs.

func (*Client) ListMitigationActions

func (c *Client) ListMitigationActions(ctx context.Context, params *ListMitigationActionsInput, optFns ...func(*Options)) (*ListMitigationActionsOutput, error)

Gets a list of all mitigation actions that match the specified filter criteria.

func (*Client) ListOTAUpdates

func (c *Client) ListOTAUpdates(ctx context.Context, params *ListOTAUpdatesInput, optFns ...func(*Options)) (*ListOTAUpdatesOutput, error)

Lists OTA updates.

func (*Client) ListOutgoingCertificates

func (c *Client) ListOutgoingCertificates(ctx context.Context, params *ListOutgoingCertificatesInput, optFns ...func(*Options)) (*ListOutgoingCertificatesOutput, error)

Lists certificates that are being transferred but not yet accepted.

func (*Client) ListPolicies

func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error)

Lists your policies.

func (*Client) ListPolicyPrincipals

func (c *Client) ListPolicyPrincipals(ctx context.Context, params *ListPolicyPrincipalsInput, optFns ...func(*Options)) (*ListPolicyPrincipalsOutput, error)

Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy () instead.

func (*Client) ListPolicyVersions

func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersionsInput, optFns ...func(*Options)) (*ListPolicyVersionsOutput, error)

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

func (*Client) ListPrincipalPolicies

func (c *Client) ListPrincipalPolicies(ctx context.Context, params *ListPrincipalPoliciesInput, optFns ...func(*Options)) (*ListPrincipalPoliciesOutput, error)

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.

func (*Client) ListPrincipalThings

func (c *Client) ListPrincipalThings(ctx context.Context, params *ListPrincipalThingsInput, optFns ...func(*Options)) (*ListPrincipalThingsOutput, error)

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.

func (*Client) ListProvisioningTemplateVersions

func (c *Client) ListProvisioningTemplateVersions(ctx context.Context, params *ListProvisioningTemplateVersionsInput, optFns ...func(*Options)) (*ListProvisioningTemplateVersionsOutput, error)

A list of fleet provisioning template versions.

func (*Client) ListProvisioningTemplates

func (c *Client) ListProvisioningTemplates(ctx context.Context, params *ListProvisioningTemplatesInput, optFns ...func(*Options)) (*ListProvisioningTemplatesOutput, error)

Lists the fleet provisioning templates in your AWS account.

func (*Client) ListRoleAliases

func (c *Client) ListRoleAliases(ctx context.Context, params *ListRoleAliasesInput, optFns ...func(*Options)) (*ListRoleAliasesOutput, error)

Lists the role aliases registered in your account.

func (*Client) ListScheduledAudits

func (c *Client) ListScheduledAudits(ctx context.Context, params *ListScheduledAuditsInput, optFns ...func(*Options)) (*ListScheduledAuditsOutput, error)

Lists all of your scheduled audits.

func (*Client) ListSecurityProfiles

func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityProfilesInput, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error)

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.

func (*Client) ListSecurityProfilesForTarget

func (c *Client) ListSecurityProfilesForTarget(ctx context.Context, params *ListSecurityProfilesForTargetInput, optFns ...func(*Options)) (*ListSecurityProfilesForTargetOutput, error)

Lists the Device Defender security profiles attached to a target (thing group).

func (*Client) ListStreams

func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error)

Lists all of the streams in your AWS account.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags (metadata) you have assigned to the resource.

func (*Client) ListTargetsForPolicy

func (c *Client) ListTargetsForPolicy(ctx context.Context, params *ListTargetsForPolicyInput, optFns ...func(*Options)) (*ListTargetsForPolicyOutput, error)

List targets for the specified policy.

func (*Client) ListTargetsForSecurityProfile

func (c *Client) ListTargetsForSecurityProfile(ctx context.Context, params *ListTargetsForSecurityProfileInput, optFns ...func(*Options)) (*ListTargetsForSecurityProfileOutput, error)

Lists the targets (thing groups) associated with a given Device Defender security profile.

func (*Client) ListThingGroups

func (c *Client) ListThingGroups(ctx context.Context, params *ListThingGroupsInput, optFns ...func(*Options)) (*ListThingGroupsOutput, error)

List the thing groups in your account.

func (*Client) ListThingGroupsForThing

func (c *Client) ListThingGroupsForThing(ctx context.Context, params *ListThingGroupsForThingInput, optFns ...func(*Options)) (*ListThingGroupsForThingOutput, error)

List the thing groups to which the specified thing belongs.

func (*Client) ListThingPrincipals

func (c *Client) ListThingPrincipals(ctx context.Context, params *ListThingPrincipalsInput, optFns ...func(*Options)) (*ListThingPrincipalsOutput, error)

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.

func (*Client) ListThingRegistrationTaskReports

func (c *Client) ListThingRegistrationTaskReports(ctx context.Context, params *ListThingRegistrationTaskReportsInput, optFns ...func(*Options)) (*ListThingRegistrationTaskReportsOutput, error)

Information about the thing registration tasks.

func (*Client) ListThingRegistrationTasks

func (c *Client) ListThingRegistrationTasks(ctx context.Context, params *ListThingRegistrationTasksInput, optFns ...func(*Options)) (*ListThingRegistrationTasksOutput, error)

List bulk thing provisioning tasks.

func (*Client) ListThingTypes

func (c *Client) ListThingTypes(ctx context.Context, params *ListThingTypesInput, optFns ...func(*Options)) (*ListThingTypesOutput, error)

Lists the existing thing types.

func (*Client) ListThings

func (c *Client) ListThings(ctx context.Context, params *ListThingsInput, optFns ...func(*Options)) (*ListThingsOutput, error)

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.

func (*Client) ListThingsInBillingGroup

func (c *Client) ListThingsInBillingGroup(ctx context.Context, params *ListThingsInBillingGroupInput, optFns ...func(*Options)) (*ListThingsInBillingGroupOutput, error)

Lists the things you have added to the given billing group.

func (*Client) ListThingsInThingGroup

func (c *Client) ListThingsInThingGroup(ctx context.Context, params *ListThingsInThingGroupInput, optFns ...func(*Options)) (*ListThingsInThingGroupOutput, error)

Lists the things in the specified group.

func (*Client) ListTopicRuleDestinations

func (c *Client) ListTopicRuleDestinations(ctx context.Context, params *ListTopicRuleDestinationsInput, optFns ...func(*Options)) (*ListTopicRuleDestinationsOutput, error)

Lists all the topic rule destinations in your AWS account.

func (*Client) ListTopicRules

func (c *Client) ListTopicRules(ctx context.Context, params *ListTopicRulesInput, optFns ...func(*Options)) (*ListTopicRulesOutput, error)

Lists the rules for the specific topic.

func (*Client) ListV2LoggingLevels

func (c *Client) ListV2LoggingLevels(ctx context.Context, params *ListV2LoggingLevelsInput, optFns ...func(*Options)) (*ListV2LoggingLevelsOutput, error)

Lists logging levels.

func (*Client) ListViolationEvents

func (c *Client) ListViolationEvents(ctx context.Context, params *ListViolationEventsInput, optFns ...func(*Options)) (*ListViolationEventsOutput, error)

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

func (*Client) RegisterCACertificate

func (c *Client) RegisterCACertificate(ctx context.Context, params *RegisterCACertificateInput, optFns ...func(*Options)) (*RegisterCACertificateOutput, error)

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.

func (*Client) RegisterCertificate

func (c *Client) RegisterCertificate(ctx context.Context, params *RegisterCertificateInput, optFns ...func(*Options)) (*RegisterCertificateOutput, error)

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.

func (*Client) RegisterCertificateWithoutCA

func (c *Client) RegisterCertificateWithoutCA(ctx context.Context, params *RegisterCertificateWithoutCAInput, optFns ...func(*Options)) (*RegisterCertificateWithoutCAOutput, error)

Register a certificate that does not have a certificate authority (CA).

func (*Client) RegisterThing

func (c *Client) RegisterThing(ctx context.Context, params *RegisterThingInput, optFns ...func(*Options)) (*RegisterThingOutput, error)

Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot) and cause throttle errors. Please contact AWS Customer Support (https://console.aws.amazon.com/support/home) to raise your throttling limits if necessary.

func (*Client) RejectCertificateTransfer

func (c *Client) RejectCertificateTransfer(ctx context.Context, params *RejectCertificateTransferInput, optFns ...func(*Options)) (*RejectCertificateTransferOutput, error)

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.

func (*Client) RemoveThingFromBillingGroup

func (c *Client) RemoveThingFromBillingGroup(ctx context.Context, params *RemoveThingFromBillingGroupInput, optFns ...func(*Options)) (*RemoveThingFromBillingGroupOutput, error)

Removes the given thing from the billing group.

func (*Client) RemoveThingFromThingGroup

func (c *Client) RemoveThingFromThingGroup(ctx context.Context, params *RemoveThingFromThingGroupInput, optFns ...func(*Options)) (*RemoveThingFromThingGroupOutput, error)

Remove the specified thing from the specified group. You must specify either a thingGroupArn or a thingGroupName to identify the thing group and either a thingArn or a thingName to identify the thing to remove from the thing group.

func (*Client) ReplaceTopicRule

func (c *Client) ReplaceTopicRule(ctx context.Context, params *ReplaceTopicRuleInput, optFns ...func(*Options)) (*ReplaceTopicRuleOutput, error)

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.

func (*Client) SearchIndex

func (c *Client) SearchIndex(ctx context.Context, params *SearchIndexInput, optFns ...func(*Options)) (*SearchIndexOutput, error)

The query search index.

func (*Client) SetDefaultAuthorizer

func (c *Client) SetDefaultAuthorizer(ctx context.Context, params *SetDefaultAuthorizerInput, optFns ...func(*Options)) (*SetDefaultAuthorizerOutput, error)

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

func (*Client) SetDefaultPolicyVersion

func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefaultPolicyVersionInput, optFns ...func(*Options)) (*SetDefaultPolicyVersionOutput, error)

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.

func (*Client) SetLoggingOptions

func (c *Client) SetLoggingOptions(ctx context.Context, params *SetLoggingOptionsInput, optFns ...func(*Options)) (*SetLoggingOptionsOutput, error)

Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

func (*Client) SetV2LoggingLevel

func (c *Client) SetV2LoggingLevel(ctx context.Context, params *SetV2LoggingLevelInput, optFns ...func(*Options)) (*SetV2LoggingLevelOutput, error)

Sets the logging level.

func (*Client) SetV2LoggingOptions

func (c *Client) SetV2LoggingOptions(ctx context.Context, params *SetV2LoggingOptionsInput, optFns ...func(*Options)) (*SetV2LoggingOptionsOutput, error)

Sets the logging options for the V2 logging service.

func (*Client) StartAuditMitigationActionsTask

func (c *Client) StartAuditMitigationActionsTask(ctx context.Context, params *StartAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*StartAuditMitigationActionsTaskOutput, error)

Starts a task that applies a set of mitigation actions to the specified target.

func (*Client) StartOnDemandAuditTask

func (c *Client) StartOnDemandAuditTask(ctx context.Context, params *StartOnDemandAuditTaskInput, optFns ...func(*Options)) (*StartOnDemandAuditTaskOutput, error)

Starts an on-demand Device Defender audit.

func (*Client) StartThingRegistrationTask

func (c *Client) StartThingRegistrationTask(ctx context.Context, params *StartThingRegistrationTaskInput, optFns ...func(*Options)) (*StartThingRegistrationTaskOutput, error)

Creates a bulk thing provisioning task.

func (*Client) StopThingRegistrationTask

func (c *Client) StopThingRegistrationTask(ctx context.Context, params *StopThingRegistrationTaskInput, optFns ...func(*Options)) (*StopThingRegistrationTaskOutput, error)

Cancels a bulk thing provisioning task.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

func (*Client) TestAuthorization

func (c *Client) TestAuthorization(ctx context.Context, params *TestAuthorizationInput, optFns ...func(*Options)) (*TestAuthorizationOutput, error)

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.

func (*Client) TestInvokeAuthorizer

func (c *Client) TestInvokeAuthorizer(ctx context.Context, params *TestInvokeAuthorizerInput, optFns ...func(*Options)) (*TestInvokeAuthorizerOutput, error)

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.

func (*Client) TransferCertificate

func (c *Client) TransferCertificate(ctx context.Context, params *TransferCertificateInput, optFns ...func(*Options)) (*TransferCertificateOutput, error)

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.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the given tags (metadata) from the resource.

func (*Client) UpdateAccountAuditConfiguration

func (c *Client) UpdateAccountAuditConfiguration(ctx context.Context, params *UpdateAccountAuditConfigurationInput, optFns ...func(*Options)) (*UpdateAccountAuditConfigurationOutput, error)

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.

func (*Client) UpdateAuthorizer

func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerInput, optFns ...func(*Options)) (*UpdateAuthorizerOutput, error)

Updates an authorizer.

func (*Client) UpdateBillingGroup

func (c *Client) UpdateBillingGroup(ctx context.Context, params *UpdateBillingGroupInput, optFns ...func(*Options)) (*UpdateBillingGroupOutput, error)

Updates information about the billing group.

func (*Client) UpdateCACertificate

func (c *Client) UpdateCACertificate(ctx context.Context, params *UpdateCACertificateInput, optFns ...func(*Options)) (*UpdateCACertificateOutput, error)

Updates a registered CA certificate.

func (*Client) UpdateCertificate

func (c *Client) UpdateCertificate(ctx context.Context, params *UpdateCertificateInput, optFns ...func(*Options)) (*UpdateCertificateOutput, error)

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.

func (*Client) UpdateDimension

func (c *Client) UpdateDimension(ctx context.Context, params *UpdateDimensionInput, optFns ...func(*Options)) (*UpdateDimensionOutput, error)

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and re-create it).

func (*Client) UpdateDomainConfiguration

func (c *Client) UpdateDomainConfiguration(ctx context.Context, params *UpdateDomainConfigurationInput, optFns ...func(*Options)) (*UpdateDomainConfigurationOutput, error)

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. The domain configuration feature is in public preview and is subject to change.

func (*Client) UpdateDynamicThingGroup

func (c *Client) UpdateDynamicThingGroup(ctx context.Context, params *UpdateDynamicThingGroupInput, optFns ...func(*Options)) (*UpdateDynamicThingGroupOutput, error)

Updates a dynamic thing group.

func (*Client) UpdateEventConfigurations

func (c *Client) UpdateEventConfigurations(ctx context.Context, params *UpdateEventConfigurationsInput, optFns ...func(*Options)) (*UpdateEventConfigurationsOutput, error)

Updates the event configurations.

func (*Client) UpdateIndexingConfiguration

func (c *Client) UpdateIndexingConfiguration(ctx context.Context, params *UpdateIndexingConfigurationInput, optFns ...func(*Options)) (*UpdateIndexingConfigurationOutput, error)

Updates the search configuration.

func (*Client) UpdateJob

func (c *Client) UpdateJob(ctx context.Context, params *UpdateJobInput, optFns ...func(*Options)) (*UpdateJobOutput, error)

Updates supported fields of the specified job.

func (*Client) UpdateMitigationAction

func (c *Client) UpdateMitigationAction(ctx context.Context, params *UpdateMitigationActionInput, optFns ...func(*Options)) (*UpdateMitigationActionOutput, error)

Updates the definition for the specified mitigation action.

func (*Client) UpdateProvisioningTemplate

func (c *Client) UpdateProvisioningTemplate(ctx context.Context, params *UpdateProvisioningTemplateInput, optFns ...func(*Options)) (*UpdateProvisioningTemplateOutput, error)

Updates a fleet provisioning template.

func (*Client) UpdateRoleAlias

func (c *Client) UpdateRoleAlias(ctx context.Context, params *UpdateRoleAliasInput, optFns ...func(*Options)) (*UpdateRoleAliasOutput, error)

Updates a role alias.

func (*Client) UpdateScheduledAudit

func (c *Client) UpdateScheduledAudit(ctx context.Context, params *UpdateScheduledAuditInput, optFns ...func(*Options)) (*UpdateScheduledAuditOutput, error)

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

func (*Client) UpdateSecurityProfile

func (c *Client) UpdateSecurityProfile(ctx context.Context, params *UpdateSecurityProfileInput, optFns ...func(*Options)) (*UpdateSecurityProfileOutput, error)

Updates a Device Defender security profile.

func (*Client) UpdateStream

func (c *Client) UpdateStream(ctx context.Context, params *UpdateStreamInput, optFns ...func(*Options)) (*UpdateStreamOutput, error)

Updates an existing stream. The stream version will be incremented by one.

func (*Client) UpdateThing

func (c *Client) UpdateThing(ctx context.Context, params *UpdateThingInput, optFns ...func(*Options)) (*UpdateThingOutput, error)

Updates the data for a thing.

func (*Client) UpdateThingGroup

func (c *Client) UpdateThingGroup(ctx context.Context, params *UpdateThingGroupInput, optFns ...func(*Options)) (*UpdateThingGroupOutput, error)

Update a thing group.

func (*Client) UpdateThingGroupsForThing

func (c *Client) UpdateThingGroupsForThing(ctx context.Context, params *UpdateThingGroupsForThingInput, optFns ...func(*Options)) (*UpdateThingGroupsForThingOutput, error)

Updates the groups to which the thing belongs.

func (*Client) UpdateTopicRuleDestination

func (c *Client) UpdateTopicRuleDestination(ctx context.Context, params *UpdateTopicRuleDestinationInput, optFns ...func(*Options)) (*UpdateTopicRuleDestinationOutput, error)

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

func (*Client) ValidateSecurityProfileBehaviors

func (c *Client) ValidateSecurityProfileBehaviors(ctx context.Context, params *ValidateSecurityProfileBehaviorsInput, optFns ...func(*Options)) (*ValidateSecurityProfileBehaviorsOutput, error)

Validates a Device Defender security profile behaviors specification.

type ConfirmTopicRuleDestinationInput

type ConfirmTopicRuleDestinationInput struct {
	// The token used to confirm ownership or access to the topic rule confirmation
	// URL.
	ConfirmationToken *string
}

type ConfirmTopicRuleDestinationOutput

type ConfirmTopicRuleDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateAuthorizerInput

type CreateAuthorizerInput struct {
	// The public keys used to verify the digital signature returned by your custom
	// authentication service.
	TokenSigningPublicKeys map[string]*string
	// The name of the token key used to extract the token from the HTTP headers.
	TokenKeyName *string
	// Specifies whether AWS IoT validates the token signature in an authorization
	// request.
	SigningDisabled *bool
	// The authorizer name.
	AuthorizerName *string
	// The status of the create authorizer request.
	Status types.AuthorizerStatus
	// The ARN of the authorizer's Lambda function.
	AuthorizerFunctionArn *string
	// Metadata which can be used to manage the custom authorizer. For URI Request
	// parameters use format: ...key1=value1&key2=value2... For the CLI command-line
	// parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json
	// file use format: "tags": "key1=value1&key2=value2..."
	Tags []*types.Tag
}

type CreateAuthorizerOutput

type CreateAuthorizerOutput struct {
	// The authorizer ARN.
	AuthorizerArn *string
	// The authorizer's name.
	AuthorizerName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateBillingGroupInput

type CreateBillingGroupInput struct {
	// Metadata which can be used to manage the billing group.
	Tags []*types.Tag
	// The properties of the billing group.
	BillingGroupProperties *types.BillingGroupProperties
	// The name you wish to give to the billing group.
	BillingGroupName *string
}

type CreateBillingGroupOutput

type CreateBillingGroupOutput struct {
	// The ID of the billing group.
	BillingGroupId *string
	// The name you gave to the billing group.
	BillingGroupName *string
	// The ARN of the billing group.
	BillingGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateCertificateFromCsrInput

type CreateCertificateFromCsrInput struct {
	// Specifies whether the certificate is active.
	SetAsActive *bool
	// The certificate signing request (CSR).
	CertificateSigningRequest *string
}

The input for the CreateCertificateFromCsr operation.

type CreateCertificateFromCsrOutput

type CreateCertificateFromCsrOutput struct {
	// The certificate data, in PEM format.
	CertificatePem *string
	// The ID of the certificate. Certificate management operations only take a
	// certificateId.
	CertificateId *string
	// The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a
	// principal for policy operations.
	CertificateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the CreateCertificateFromCsr operation.

type CreateDimensionInput

type CreateDimensionInput struct {
	// Specifies the value or list of values for the dimension. For TOPIC_FILTER
	// dimensions, this is a pattern used to match the MQTT topic (for example,
	// "admin/#").
	StringValues []*string
	// Metadata that can be used to manage the dimension.
	Tags []*types.Tag
	// Each dimension must have a unique client request token. If you try to create a
	// new dimension with the same token as a dimension that already exists, an
	// exception occurs. If you omit this value, AWS SDKs will automatically generate a
	// unique client request.
	ClientRequestToken *string
	// Specifies the type of dimension. Supported types: TOPIC_FILTER.
	Type types.DimensionType
	// A unique identifier for the dimension. Choose something that describes the type
	// and value to make it easy to remember what it does.
	Name *string
}

type CreateDimensionOutput

type CreateDimensionOutput struct {
	// A unique identifier for the dimension.
	Name *string
	// The ARN (Amazon resource name) of the created dimension.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDomainConfigurationInput

type CreateDomainConfigurationInput struct {
	// The name of the domain configuration. This value must be unique to a region.
	DomainConfigurationName *string
	// The name of the domain.
	DomainName *string
	// The certificate used to validate the server certificate and prove domain name
	// ownership. This certificate must be signed by a public certificate authority.
	// This value is not required for AWS-managed domains.
	ValidationCertificateArn *string
	// The ARNs of the certificates that AWS IoT passes to the device during the TLS
	// handshake. Currently you can specify only one certificate ARN. This value is not
	// required for AWS-managed domains.
	ServerCertificateArns []*string
	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *types.AuthorizerConfig
	// The type of service delivered by the endpoint. AWS IoT Core currently supports
	// only the DATA service type.
	ServiceType types.ServiceType
	// Metadata which can be used to manage the domain configuration. For URI Request
	// parameters use format: ...key1=value1&key2=value2... For the CLI command-line
	// parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json
	// file use format: "tags": "key1=value1&key2=value2..."
	Tags []*types.Tag
}

type CreateDomainConfigurationOutput

type CreateDomainConfigurationOutput struct {
	// The name of the domain configuration.
	DomainConfigurationName *string
	// The ARN of the domain configuration.
	DomainConfigurationArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateDynamicThingGroupInput

type CreateDynamicThingGroupInput struct {
	// The dynamic thing group query version. Currently one query version is supported:
	// "2017-09-30". If not specified, the query version defaults to this value.
	QueryVersion *string
	// The dynamic thing group index name. Currently one index is supported:
	// "AWS_Things".
	IndexName *string
	// The dynamic thing group properties.
	ThingGroupProperties *types.ThingGroupProperties
	// The dynamic thing group search query string. See Query Syntax
	// (https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html) for
	// information about query string syntax.
	QueryString *string
	// The dynamic thing group name to create.
	ThingGroupName *string
	// Metadata which can be used to manage the dynamic thing group.
	Tags []*types.Tag
}

type CreateDynamicThingGroupOutput

type CreateDynamicThingGroupOutput struct {
	// The dynamic thing group ARN.
	ThingGroupArn *string
	// The dynamic thing group search query string.
	QueryString *string
	// The dynamic thing group query version.
	QueryVersion *string
	// The dynamic thing group name.
	ThingGroupName *string
	// The dynamic thing group index name.
	IndexName *string
	// The dynamic thing group ID.
	ThingGroupId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateJobInput

type CreateJobInput struct {
	// The job document. If the job document resides in an S3 bucket, you must use a
	// placeholder link when specifying the document. The placeholder link is of the
	// following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
	// where bucket is your bucket name and key is the object in the bucket to which
	// you are linking.
	Document *string
	// A job identifier which must be unique for your AWS account. We recommend using a
	// UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
	JobId *string
	// Specifies the amount of time each device has to finish its execution of the job.
	// The timer is started when the job execution status is set to IN_PROGRESS. If the
	// job execution status is not set to another terminal state before the time
	// expires, it will be automatically set to TIMED_OUT.
	TimeoutConfig *types.TimeoutConfig
	// A list of things and thing groups to which the job should be sent.
	Targets []*string
	// Metadata which can be used to manage the job.
	Tags []*types.Tag
	// An S3 link to the job document.
	DocumentSource *string
	// Allows you to create criteria to abort a job.
	AbortConfig *types.AbortConfig
	// A short text description of the job.
	Description *string
	// Specifies whether the job will continue to run (CONTINUOUS), or will be complete
	// after all those things specified as targets have completed the job (SNAPSHOT).
	// If continuous, the job may also be run on a thing when a change is detected in a
	// target. For example, a job will run on a thing when the thing is added to a
	// target group, even after the job was completed by all things originally in the
	// group.
	TargetSelection types.TargetSelection
	// Allows you to create a staged rollout of the job.
	JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig
	// Configuration information for pre-signed S3 URLs.
	PresignedUrlConfig *types.PresignedUrlConfig
}

type CreateJobOutput

type CreateJobOutput struct {
	// The unique identifier you assigned to this job.
	JobId *string
	// The job description.
	Description *string
	// The job ARN.
	JobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateKeysAndCertificateInput

type CreateKeysAndCertificateInput struct {
	// Specifies whether the certificate is active.
	SetAsActive *bool
}

The input for the CreateKeysAndCertificate operation.

type CreateKeysAndCertificateOutput

type CreateKeysAndCertificateOutput struct {
	// The ARN of the certificate.
	CertificateArn *string
	// The generated key pair.
	KeyPair *types.KeyPair
	// The ID of the certificate. AWS IoT issues a default subject name for the
	// certificate (for example, AWS IoT Certificate).
	CertificateId *string
	// The certificate data, in PEM format.
	CertificatePem *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the CreateKeysAndCertificate operation.

type CreateMitigationActionInput

type CreateMitigationActionInput struct {
	// Metadata that can be used to manage the mitigation action.
	Tags []*types.Tag
	// A friendly name for the action. Choose a friendly name that accurately describes
	// the action (for example, EnableLoggingAction).
	ActionName *string
	// The ARN of the IAM role that is used to apply the mitigation action.
	RoleArn *string
	// Defines the type of action and the parameters for that action.
	ActionParams *types.MitigationActionParams
}

type CreateMitigationActionOutput

type CreateMitigationActionOutput struct {
	// A unique identifier for the new mitigation action.
	ActionId *string
	// The ARN for the new mitigation action.
	ActionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateOTAUpdateInput

type CreateOTAUpdateInput struct {
	// Configuration for the rollout of OTA updates.
	AwsJobExecutionsRolloutConfig *types.AwsJobExecutionsRolloutConfig
	// The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS
	// Code Signing resources to create an OTA update job.
	RoleArn *string
	// The devices targeted to receive OTA updates.
	Targets []*string
	// The protocol used to transfer the OTA update image. Valid values are [HTTP],
	// [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device
	// can choose the protocol.
	Protocols []types.Protocol
	// Configuration information for pre-signed URLs.
	AwsJobPresignedUrlConfig *types.AwsJobPresignedUrlConfig
	// The criteria that determine when and how a job abort takes place.
	AwsJobAbortConfig *types.AwsJobAbortConfig
	// A list of additional OTA update parameters which are name-value pairs.
	AdditionalParameters map[string]*string
	// The description of the OTA update.
	Description *string
	// Specifies the amount of time each device has to finish its execution of the job.
	// A timer is started when the job execution status is set to IN_PROGRESS. If the
	// job execution status is not set to another terminal state before the timer
	// expires, it will be automatically set to TIMED_OUT.
	AwsJobTimeoutConfig *types.AwsJobTimeoutConfig
	// The files to be streamed by the OTA update.
	Files []*types.OTAUpdateFile
	// Metadata which can be used to manage updates.
	Tags []*types.Tag
	// Specifies whether the update will continue to run (CONTINUOUS), or will be
	// complete after all the things specified as targets have completed the update
	// (SNAPSHOT). If continuous, the update may also be run on a thing when a change
	// is detected in a target. For example, an update will run on a thing when the
	// thing is added to a target group, even after the update was completed by all
	// things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
	TargetSelection types.TargetSelection
	// The ID of the OTA update to be created.
	OtaUpdateId *string
}

type CreateOTAUpdateOutput

type CreateOTAUpdateOutput struct {
	// The OTA update ID.
	OtaUpdateId *string
	// The AWS IoT job ID associated with the OTA update.
	AwsIotJobId *string
	// The OTA update ARN.
	OtaUpdateArn *string
	// The OTA update status.
	OtaUpdateStatus types.OTAUpdateStatus
	// The AWS IoT job ARN associated with the OTA update.
	AwsIotJobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreatePolicyInput

type CreatePolicyInput struct {
	// Metadata which can be used to manage the policy. For URI Request parameters use
	// format: ...key1=value1&key2=value2... For the CLI command-line parameter use
	// format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use
	// format: "tags": "key1=value1&key2=value2..."
	Tags []*types.Tag
	// The policy name.
	PolicyName *string
	// The JSON document that describes the policy. policyDocument must have a minimum
	// length of 1, with a maximum length of 2048, excluding whitespace.
	PolicyDocument *string
}

The input for the CreatePolicy operation.

type CreatePolicyOutput

type CreatePolicyOutput struct {
	// The JSON document that describes the policy.
	PolicyDocument *string
	// The policy name.
	PolicyName *string
	// The policy version ID.
	PolicyVersionId *string
	// The policy ARN.
	PolicyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the CreatePolicy operation.

type CreatePolicyVersionInput

type CreatePolicyVersionInput struct {
	// Specifies whether the policy version is set as the default. When this parameter
	// is true, the new policy version becomes the operative version (that is, the
	// version that is in effect for the certificates to which the policy is attached).
	SetAsDefault *bool
	// The JSON document that describes the policy. Minimum length of 1. Maximum length
	// of 2048, excluding whitespace.
	PolicyDocument *string
	// The policy name.
	PolicyName *string
}

The input for the CreatePolicyVersion operation.

type CreatePolicyVersionOutput

type CreatePolicyVersionOutput struct {
	// The JSON document that describes the policy.
	PolicyDocument *string
	// Specifies whether the policy version is the default.
	IsDefaultVersion *bool
	// The policy version ID.
	PolicyVersionId *string
	// The policy ARN.
	PolicyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the CreatePolicyVersion operation.

type CreateProvisioningClaimInput

type CreateProvisioningClaimInput struct {
	// The name of the provisioning template to use.
	TemplateName *string
}

type CreateProvisioningClaimOutput

type CreateProvisioningClaimOutput struct {
	// The provisioning claim certificate.
	CertificatePem *string
	// The provisioning claim expiration time.
	Expiration *time.Time
	// The ID of the certificate.
	CertificateId *string
	// The provisioning claim key pair.
	KeyPair *types.KeyPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProvisioningTemplateInput

type CreateProvisioningTemplateInput struct {
	// The description of the fleet provisioning template.
	Description *string
	// True to enable the fleet provisioning template, otherwise false.
	Enabled *bool
	// The role ARN for the role associated with the fleet provisioning template. This
	// IoT role grants permission to provision a device.
	ProvisioningRoleArn *string
	// Metadata which can be used to manage the fleet provisioning template. For URI
	// Request parameters use format: ...key1=value1&key2=value2... For the CLI
	// command-line parameter use format: &&tags "key1=value1&key2=value2..." For the
	// cli-input-json file use format: "tags": "key1=value1&key2=value2..."
	Tags []*types.Tag
	// Creates a pre-provisioning hook template.
	PreProvisioningHook *types.ProvisioningHook
	// The name of the fleet provisioning template.
	TemplateName *string
	// The JSON formatted contents of the fleet provisioning template.
	TemplateBody *string
}

type CreateProvisioningTemplateOutput

type CreateProvisioningTemplateOutput struct {
	// The name of the fleet provisioning template.
	TemplateName *string
	// The default version of the fleet provisioning template.
	DefaultVersionId *int32
	// The ARN that identifies the provisioning template.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProvisioningTemplateVersionInput

type CreateProvisioningTemplateVersionInput struct {
	// Sets a fleet provision template version as the default version.
	SetAsDefault *bool
	// The name of the fleet provisioning template.
	TemplateName *string
	// The JSON formatted contents of the fleet provisioning template.
	TemplateBody *string
}

type CreateProvisioningTemplateVersionOutput

type CreateProvisioningTemplateVersionOutput struct {
	// True if the fleet provisioning template version is the default version,
	// otherwise false.
	IsDefaultVersion *bool
	// The name of the fleet provisioning template.
	TemplateName *string
	// The version of the fleet provisioning template.
	VersionId *int32
	// The ARN that identifies the provisioning template.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRoleAliasInput

type CreateRoleAliasInput struct {
	// The role ARN.
	RoleArn *string
	// How long (in seconds) the credentials will be valid.
	CredentialDurationSeconds *int32
	// The role alias that points to a role ARN. This allows you to change the role
	// without having to update the device.
	RoleAlias *string
	// Metadata which can be used to manage the role alias. For URI Request parameters
	// use format: ...key1=value1&key2=value2... For the CLI command-line parameter use
	// format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use
	// format: "tags": "key1=value1&key2=value2..."
	Tags []*types.Tag
}

type CreateRoleAliasOutput

type CreateRoleAliasOutput struct {
	// The role alias ARN.
	RoleAliasArn *string
	// The role alias.
	RoleAlias *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateScheduledAuditInput

type CreateScheduledAuditInput struct {
	// The day of the week on which the scheduled audit takes place. Can be one of
	// "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if
	// the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
	DayOfWeek types.DayOfWeek
	// Metadata that can be used to manage the scheduled audit.
	Tags []*types.Tag
	// How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY",
	// "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the
	// system.
	Frequency types.AuditFrequency
	// The day of the month on which the scheduled audit takes place. Can be "1"
	// through "31" or "LAST". This field is required if the "frequency" parameter is
	// set to "MONTHLY". If days 29-31 are specified, and the month does not have that
	// many days, the audit takes place on the "LAST" day of the month.
	DayOfMonth *string
	// The name you want to give to the scheduled audit. (Max. 128 chars)
	ScheduledAuditName *string
	// Which checks are performed during the scheduled audit. Checks must be enabled
	// for your account. (Use DescribeAccountAuditConfiguration to see the list of all
	// checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	TargetCheckNames []*string
}

type CreateScheduledAuditOutput

type CreateScheduledAuditOutput struct {
	// The ARN of the scheduled audit.
	ScheduledAuditArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateSecurityProfileInput

type CreateSecurityProfileInput struct {
	// Specifies the destinations to which alerts are sent. (Alerts are always sent to
	// the console.) Alerts are generated when a device (thing) violates a behavior.
	AlertTargets map[string]*types.AlertTarget
	// Metadata that can be used to manage the security profile.
	Tags []*types.Tag
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for any
	// metric specified here. Note: This API field is deprecated. Please use
	// CreateSecurityProfileRequest$additionalMetricsToRetainV2 () instead.
	AdditionalMetricsToRetain []*string
	// The name you are giving to the security profile.
	SecurityProfileName *string
	// A description of the security profile.
	SecurityProfileDescription *string
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for any
	// metric specified here.
	AdditionalMetricsToRetainV2 []*types.MetricToRetain
	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	Behaviors []*types.Behavior
}

type CreateSecurityProfileOutput

type CreateSecurityProfileOutput struct {
	// The ARN of the security profile.
	SecurityProfileArn *string
	// The name you gave to the security profile.
	SecurityProfileName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateStreamInput

type CreateStreamInput struct {
	// The stream ID.
	StreamId *string
	// A description of the stream.
	Description *string
	// Metadata which can be used to manage streams.
	Tags []*types.Tag
	// An IAM role that allows the IoT service principal assumes to access your S3
	// files.
	RoleArn *string
	// The files to stream.
	Files []*types.StreamFile
}

type CreateStreamOutput

type CreateStreamOutput struct {
	// The stream ARN.
	StreamArn *string
	// The stream ID.
	StreamId *string
	// A description of the stream.
	Description *string
	// The version of the stream.
	StreamVersion *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateThingGroupInput

type CreateThingGroupInput struct {
	// The name of the parent thing group.
	ParentGroupName *string
	// Metadata which can be used to manage the thing group.
	Tags []*types.Tag
	// The thing group properties.
	ThingGroupProperties *types.ThingGroupProperties
	// The thing group name to create.
	ThingGroupName *string
}

type CreateThingGroupOutput

type CreateThingGroupOutput struct {
	// The thing group ID.
	ThingGroupId *string
	// The thing group ARN.
	ThingGroupArn *string
	// The thing group name.
	ThingGroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateThingInput

type CreateThingInput struct {
	// The name of the billing group the thing will be added to.
	BillingGroupName *string
	// The name of the thing to create. You can't change a thing's name after you
	// create it. To change a thing's name, you must create a new thing, give it the
	// new name, and then delete the old thing.
	ThingName *string
	// The name of the thing type associated with the new thing.
	ThingTypeName *string
	// The attribute payload, which consists of up to three name/value pairs in a JSON
	// document. For example: {\"attributes\":{\"string1\":\"string2\"}}
	AttributePayload *types.AttributePayload
}

The input for the CreateThing operation.

type CreateThingOutput

type CreateThingOutput struct {
	// The ARN of the new thing.
	ThingArn *string
	// The thing ID.
	ThingId *string
	// The name of the new thing.
	ThingName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the CreateThing operation.

type CreateThingTypeInput

type CreateThingTypeInput struct {
	// The ThingTypeProperties for the thing type to create. It contains information
	// about the new thing type including a description, and a list of searchable thing
	// attribute names.
	ThingTypeProperties *types.ThingTypeProperties
	// The name of the thing type.
	ThingTypeName *string
	// Metadata which can be used to manage the thing type.
	Tags []*types.Tag
}

The input for the CreateThingType operation.

type CreateThingTypeOutput

type CreateThingTypeOutput struct {
	// The thing type ID.
	ThingTypeId *string
	// The name of the thing type.
	ThingTypeName *string
	// The Amazon Resource Name (ARN) of the thing type.
	ThingTypeArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the CreateThingType operation.

type CreateTopicRuleDestinationInput

type CreateTopicRuleDestinationInput struct {
	// The topic rule destination configuration.
	DestinationConfiguration *types.TopicRuleDestinationConfiguration
}

type CreateTopicRuleDestinationOutput

type CreateTopicRuleDestinationOutput struct {
	// The topic rule destination.
	TopicRuleDestination *types.TopicRuleDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateTopicRuleInput

type CreateTopicRuleInput struct {
	// The rule payload.
	TopicRulePayload *types.TopicRulePayload
	// The name of the rule.
	RuleName *string
	// Metadata which can be used to manage the topic rule. For URI Request parameters
	// use format: ...key1=value1&key2=value2... For the CLI command-line parameter use
	// format: --tags "key1=value1&key2=value2..." For the cli-input-json file use
	// format: "tags": "key1=value1&key2=value2..."
	Tags *string
}

The input for the CreateTopicRule operation.

type CreateTopicRuleOutput

type CreateTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAccountAuditConfigurationInput

type DeleteAccountAuditConfigurationInput struct {
	// If true, all scheduled audits are deleted.
	DeleteScheduledAudits *bool
}

type DeleteAccountAuditConfigurationOutput

type DeleteAccountAuditConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteAuthorizerInput

type DeleteAuthorizerInput struct {
	// The name of the authorizer to delete.
	AuthorizerName *string
}

type DeleteAuthorizerOutput

type DeleteAuthorizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteBillingGroupInput

type DeleteBillingGroupInput struct {
	// The expected version of the billing group. If the version of the billing group
	// does not match the expected version specified in the request, the
	// DeleteBillingGroup request is rejected with a VersionConflictException.
	ExpectedVersion *int64
	// The name of the billing group.
	BillingGroupName *string
}

type DeleteBillingGroupOutput

type DeleteBillingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteCACertificateInput

type DeleteCACertificateInput struct {
	// The ID of the certificate to delete. (The last part of the certificate ARN
	// contains the certificate ID.)
	CertificateId *string
}

Input for the DeleteCACertificate operation.

type DeleteCACertificateOutput

type DeleteCACertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the DeleteCACertificate operation.

type DeleteCertificateInput

type DeleteCertificateInput struct {
	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string
	// Forces the deletion of a certificate if it is inactive and is not attached to an
	// IoT thing.
	ForceDelete *bool
}

The input for the DeleteCertificate operation.

type DeleteCertificateOutput

type DeleteCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDimensionInput

type DeleteDimensionInput struct {
	// The unique identifier for the dimension that you want to delete.
	Name *string
}

type DeleteDimensionOutput

type DeleteDimensionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDomainConfigurationInput

type DeleteDomainConfigurationInput struct {
	// The name of the domain configuration to be deleted.
	DomainConfigurationName *string
}

type DeleteDomainConfigurationOutput

type DeleteDomainConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDynamicThingGroupInput

type DeleteDynamicThingGroupInput struct {
	// The expected version of the dynamic thing group to delete.
	ExpectedVersion *int64
	// The name of the dynamic thing group to delete.
	ThingGroupName *string
}

type DeleteDynamicThingGroupOutput

type DeleteDynamicThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteJobExecutionInput

type DeleteJobExecutionInput struct {
	// The ID of the job whose execution on a particular device will be deleted.
	JobId *string
	// (Optional) When true, you can delete a job execution which is "IN_PROGRESS".
	// Otherwise, you can only delete a job execution which is in a terminal state
	// ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception
	// will occur. The default is false. Deleting a job execution which is
	// "IN_PROGRESS", will cause the device to be unable to access job information or
	// update the job execution status. Use caution and ensure that the device is able
	// to recover to a valid state.
	Force *bool
	// The name of the thing whose job execution will be deleted.
	ThingName *string
	// The ID of the job execution to be deleted. The executionNumber refers to the
	// execution of a particular job on a particular device. Note that once a job
	// execution is deleted, the executionNumber may be reused by IoT, so be sure you
	// get and use the correct value here.
	ExecutionNumber *int64
}

type DeleteJobExecutionOutput

type DeleteJobExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteJobInput

type DeleteJobInput struct {
	// (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise,
	// you can only delete a job which is in a terminal state ("COMPLETED" or
	// "CANCELED") or an exception will occur. The default is false. Deleting a job
	// which is "IN_PROGRESS", will cause a device which is executing the job to be
	// unable to access job information or update the job execution status. Use caution
	// and ensure that each device executing a job which is deleted is able to recover
	// to a valid state.
	Force *bool
	// The ID of the job to be deleted. After a job deletion is completed, you may
	// reuse this jobId when you create a new job. However, this is not recommended,
	// and you must ensure that your devices are not using the jobId to refer to the
	// deleted job.
	JobId *string
}

type DeleteJobOutput

type DeleteJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteMitigationActionInput

type DeleteMitigationActionInput struct {
	// The name of the mitigation action that you want to delete.
	ActionName *string
}

type DeleteMitigationActionOutput

type DeleteMitigationActionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteOTAUpdateInput

type DeleteOTAUpdateInput struct {
	// Specifies if the stream associated with an OTA update should be deleted when the
	// OTA update is deleted.
	DeleteStream *bool
	// Specifies if the AWS Job associated with the OTA update should be deleted when
	// the OTA update is deleted.
	ForceDeleteAWSJob *bool
	// The ID of the OTA update to delete.
	OtaUpdateId *string
}

type DeleteOTAUpdateOutput

type DeleteOTAUpdateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeletePolicyInput

type DeletePolicyInput struct {
	// The name of the policy to delete.
	PolicyName *string
}

The input for the DeletePolicy operation.

type DeletePolicyOutput

type DeletePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeletePolicyVersionInput

type DeletePolicyVersionInput struct {
	// The policy version ID.
	PolicyVersionId *string
	// The name of the policy.
	PolicyName *string
}

The input for the DeletePolicyVersion operation.

type DeletePolicyVersionOutput

type DeletePolicyVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProvisioningTemplateInput

type DeleteProvisioningTemplateInput struct {
	// The name of the fleet provision template to delete.
	TemplateName *string
}

type DeleteProvisioningTemplateOutput

type DeleteProvisioningTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProvisioningTemplateVersionInput

type DeleteProvisioningTemplateVersionInput struct {
	// The name of the fleet provisioning template version to delete.
	TemplateName *string
	// The fleet provisioning template version ID to delete.
	VersionId *int32
}

type DeleteProvisioningTemplateVersionOutput

type DeleteProvisioningTemplateVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRegistrationCodeInput

type DeleteRegistrationCodeInput struct {
}

The input for the DeleteRegistrationCode operation.

type DeleteRegistrationCodeOutput

type DeleteRegistrationCodeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the DeleteRegistrationCode operation.

type DeleteRoleAliasInput

type DeleteRoleAliasInput struct {
	// The role alias to delete.
	RoleAlias *string
}

type DeleteRoleAliasOutput

type DeleteRoleAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteScheduledAuditInput

type DeleteScheduledAuditInput struct {
	// The name of the scheduled audit you want to delete.
	ScheduledAuditName *string
}

type DeleteScheduledAuditOutput

type DeleteScheduledAuditOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteSecurityProfileInput

type DeleteSecurityProfileInput struct {
	// The expected version of the security profile. A new version is generated
	// whenever the security profile is updated. If you specify a value that is
	// different from the actual version, a VersionConflictException is thrown.
	ExpectedVersion *int64
	// The name of the security profile to be deleted.
	SecurityProfileName *string
}

type DeleteSecurityProfileOutput

type DeleteSecurityProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteStreamInput

type DeleteStreamInput struct {
	// The stream ID.
	StreamId *string
}

type DeleteStreamOutput

type DeleteStreamOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteThingGroupInput

type DeleteThingGroupInput struct {
	// The expected version of the thing group to delete.
	ExpectedVersion *int64
	// The name of the thing group to delete.
	ThingGroupName *string
}

type DeleteThingGroupOutput

type DeleteThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteThingInput

type DeleteThingInput struct {
	// The name of the thing to delete.
	ThingName *string
	// The expected version of the thing record in the registry. If the version of the
	// record in the registry does not match the expected version specified in the
	// request, the DeleteThing request is rejected with a VersionConflictException.
	ExpectedVersion *int64
}

The input for the DeleteThing operation.

type DeleteThingOutput

type DeleteThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the DeleteThing operation.

type DeleteThingTypeInput

type DeleteThingTypeInput struct {
	// The name of the thing type.
	ThingTypeName *string
}

The input for the DeleteThingType operation.

type DeleteThingTypeOutput

type DeleteThingTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the DeleteThingType operation.

type DeleteTopicRuleDestinationInput

type DeleteTopicRuleDestinationInput struct {
	// The ARN of the topic rule destination to delete.
	Arn *string
}

type DeleteTopicRuleDestinationOutput

type DeleteTopicRuleDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteTopicRuleInput

type DeleteTopicRuleInput struct {
	// The name of the rule.
	RuleName *string
}

The input for the DeleteTopicRule operation.

type DeleteTopicRuleOutput

type DeleteTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteV2LoggingLevelInput

type DeleteV2LoggingLevelInput struct {
	// The type of resource for which you are configuring logging. Must be THING_Group.
	TargetType types.LogTargetType
	// The name of the resource for which you are configuring logging.
	TargetName *string
}

type DeleteV2LoggingLevelOutput

type DeleteV2LoggingLevelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeprecateThingTypeInput

type DeprecateThingTypeInput struct {
	// Whether to undeprecate a deprecated thing type. If true, the thing type will not
	// be deprecated anymore and you can associate it with things.
	UndoDeprecate *bool
	// The name of the thing type to deprecate.
	ThingTypeName *string
}

The input for the DeprecateThingType operation.

type DeprecateThingTypeOutput

type DeprecateThingTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the DeprecateThingType operation.

type DescribeAccountAuditConfigurationInput

type DescribeAccountAuditConfigurationInput struct {
}

type DescribeAccountAuditConfigurationOutput

type DescribeAccountAuditConfigurationOutput struct {
	// The ARN of the role that grants permission to AWS IoT to access information
	// about your devices, policies, certificates, and other items as required when
	// performing an audit. On the first call to UpdateAccountAuditConfiguration, this
	// parameter is required.
	RoleArn *string
	// Which audit checks are enabled and disabled for this account.
	AuditCheckConfigurations map[string]*types.AuditCheckConfiguration
	// Information about the targets to which audit notifications are sent for this
	// account.
	AuditNotificationTargetConfigurations map[string]*types.AuditNotificationTarget

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAuditFindingInput

type DescribeAuditFindingInput struct {
	// A unique identifier for a single audit finding. You can use this identifier to
	// apply mitigation actions to the finding.
	FindingId *string
}

type DescribeAuditFindingOutput

type DescribeAuditFindingOutput struct {
	// The findings (results) of the audit.
	Finding *types.AuditFinding

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAuditMitigationActionsTaskInput

type DescribeAuditMitigationActionsTaskInput struct {
	// The unique identifier for the audit mitigation task.
	TaskId *string
}

type DescribeAuditMitigationActionsTaskOutput

type DescribeAuditMitigationActionsTaskOutput struct {
	// Specifies the mitigation actions that should be applied to specific audit
	// checks.
	AuditCheckToActionsMapping map[string][]*string
	// The date and time when the task was completed or canceled.
	EndTime *time.Time
	// Identifies the findings to which the mitigation actions are applied. This can be
	// by audit checks, by audit task, or a set of findings.
	Target *types.AuditMitigationActionsTaskTarget
	// Aggregate counts of the results when the mitigation tasks were applied to the
	// findings for this audit mitigation actions task.
	TaskStatistics map[string]*types.TaskStatisticsForAuditCheck
	// The current status of the task.
	TaskStatus types.AuditMitigationActionsTaskStatus
	// Specifies the mitigation actions and their parameters that are applied as part
	// of this task.
	ActionsDefinition []*types.MitigationAction
	// The date and time when the task was started.
	StartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAuditTaskInput

type DescribeAuditTaskInput struct {
	// The ID of the audit whose information you want to get.
	TaskId *string
}

type DescribeAuditTaskOutput

type DescribeAuditTaskOutput struct {
	// Detailed information about each check performed during this audit.
	AuditDetails map[string]*types.AuditCheckDetails
	// The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or
	// "CANCELED".
	TaskStatus types.AuditTaskStatus
	// The name of the scheduled audit (only if the audit was a scheduled audit).
	ScheduledAuditName *string
	// The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
	TaskType types.AuditTaskType
	// Statistical information about the audit.
	TaskStatistics *types.TaskStatistics
	// The time the audit started.
	TaskStartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAuthorizerInput

type DescribeAuthorizerInput struct {
	// The name of the authorizer to describe.
	AuthorizerName *string
}

type DescribeAuthorizerOutput

type DescribeAuthorizerOutput struct {
	// The authorizer description.
	AuthorizerDescription *types.AuthorizerDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeBillingGroupInput

type DescribeBillingGroupInput struct {
	// The name of the billing group.
	BillingGroupName *string
}

type DescribeBillingGroupOutput

type DescribeBillingGroupOutput struct {
	// The version of the billing group.
	Version *int64
	// The properties of the billing group.
	BillingGroupProperties *types.BillingGroupProperties
	// Additional information about the billing group.
	BillingGroupMetadata *types.BillingGroupMetadata
	// The ID of the billing group.
	BillingGroupId *string
	// The name of the billing group.
	BillingGroupName *string
	// The ARN of the billing group.
	BillingGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeCACertificateInput

type DescribeCACertificateInput struct {
	// The CA certificate identifier.
	CertificateId *string
}

The input for the DescribeCACertificate operation.

type DescribeCACertificateOutput

type DescribeCACertificateOutput struct {
	// Information about the registration configuration.
	RegistrationConfig *types.RegistrationConfig
	// The CA certificate description.
	CertificateDescription *types.CACertificateDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the DescribeCACertificate operation.

type DescribeCertificateInput

type DescribeCertificateInput struct {
	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string
}

The input for the DescribeCertificate operation.

type DescribeCertificateOutput

type DescribeCertificateOutput struct {
	// The description of the certificate.
	CertificateDescription *types.CertificateDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the DescribeCertificate operation.

type DescribeDefaultAuthorizerInput

type DescribeDefaultAuthorizerInput struct {
}

type DescribeDefaultAuthorizerOutput

type DescribeDefaultAuthorizerOutput struct {
	// The default authorizer's description.
	AuthorizerDescription *types.AuthorizerDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDimensionInput

type DescribeDimensionInput struct {
	// The unique identifier for the dimension.
	Name *string
}

type DescribeDimensionOutput

type DescribeDimensionOutput struct {
	// The date the dimension was last modified.
	LastModifiedDate *time.Time
	// The type of the dimension.
	Type types.DimensionType
	// The unique identifier for the dimension.
	Name *string
	// The date the dimension was created.
	CreationDate *time.Time
	// The ARN (Amazon resource name) for the dimension.
	Arn *string
	// The value or list of values used to scope the dimension. For example, for topic
	// filters, this is the pattern used to match the MQTT topic name.
	StringValues []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDomainConfigurationInput

type DescribeDomainConfigurationInput struct {
	// The name of the domain configuration.
	DomainConfigurationName *string
}

type DescribeDomainConfigurationOutput

type DescribeDomainConfigurationOutput struct {
	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *types.AuthorizerConfig
	// The name of the domain.
	DomainName *string
	// A Boolean value that specifies the current state of the domain configuration.
	DomainConfigurationStatus types.DomainConfigurationStatus
	// A list containing summary information about the server certificate included in
	// the domain configuration.
	ServerCertificates []*types.ServerCertificateSummary
	// The ARN of the domain configuration.
	DomainConfigurationArn *string
	// The type of the domain.
	DomainType types.DomainType
	// The type of service delivered by the endpoint.
	ServiceType types.ServiceType
	// The name of the domain configuration.
	DomainConfigurationName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeEndpointInput

type DescribeEndpointInput struct {
	// The endpoint type. Valid endpoint types include:
	//
	//     * iot:Data - Returns a
	// VeriSign signed data endpoint.
	//
	//     * iot:Data-ATS - Returns an ATS signed data
	// endpoint.
	//
	//     * iot:CredentialProvider - Returns an AWS IoT credentials
	// provider API endpoint.
	//
	//     * iot:Jobs - Returns an AWS IoT device management
	// Jobs API endpoint.
	//
	// We strongly recommend that customers use the newer
	// iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of
	// Symantec certificate authorities.
	EndpointType *string
}

The input for the DescribeEndpoint operation.

type DescribeEndpointOutput

type DescribeEndpointOutput struct {
	// The endpoint. The format of the endpoint is as follows:
	// identifier.iot.region.amazonaws.com.
	EndpointAddress *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the DescribeEndpoint operation.

type DescribeEventConfigurationsInput

type DescribeEventConfigurationsInput struct {
}

type DescribeEventConfigurationsOutput

type DescribeEventConfigurationsOutput struct {
	// The date the event configurations were last modified.
	LastModifiedDate *time.Time
	// The event configurations.
	EventConfigurations map[string]*types.Configuration
	// The creation date of the event configuration.
	CreationDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeIndexInput

type DescribeIndexInput struct {
	// The index name.
	IndexName *string
}

type DescribeIndexOutput

type DescribeIndexOutput struct {
	// The index status.
	IndexStatus types.IndexStatus
	// The index name.
	IndexName *string
	// Contains a value that specifies the type of indexing performed. Valid values
	// are:
	//
	//     * REGISTRY – Your thing index contains only registry data.
	//
	//     *
	// REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
	//
	//
	// * REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and
	// thing connectivity status data.
	//
	//     *
	// REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry
	// data, shadow data, and thing connectivity status data.
	Schema *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeJobExecutionInput

type DescribeJobExecutionInput struct {
	// The unique identifier you assigned to this job when it was created.
	JobId *string
	// The name of the thing on which the job execution is running.
	ThingName *string
	// A string (consisting of the digits "0" through "9" which is used to specify a
	// particular job execution on a particular device.
	ExecutionNumber *int64
}

type DescribeJobExecutionOutput

type DescribeJobExecutionOutput struct {
	// Information about the job execution.
	Execution *types.JobExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeJobInput

type DescribeJobInput struct {
	// The unique identifier you assigned to this job when it was created.
	JobId *string
}

type DescribeJobOutput

type DescribeJobOutput struct {
	// An S3 link to the job document.
	DocumentSource *string
	// Information about the job.
	Job *types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeMitigationActionInput

type DescribeMitigationActionInput struct {
	// The friendly name that uniquely identifies the mitigation action.
	ActionName *string
}

type DescribeMitigationActionOutput

type DescribeMitigationActionOutput struct {
	// The ARN of the IAM role used to apply this action.
	RoleArn *string
	// The ARN that identifies this migration action.
	ActionArn *string
	// The date and time when the mitigation action was last changed.
	LastModifiedDate *time.Time
	// Parameters that control how the mitigation action is applied, specific to the
	// type of mitigation action.
	ActionParams *types.MitigationActionParams
	// The friendly name that uniquely identifies the mitigation action.
	ActionName *string
	// The type of mitigation action.
	ActionType types.MitigationActionType
	// The date and time when the mitigation action was added to your AWS account.
	CreationDate *time.Time
	// A unique identifier for this action.
	ActionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeProvisioningTemplateInput

type DescribeProvisioningTemplateInput struct {
	// The name of the fleet provisioning template.
	TemplateName *string
}

type DescribeProvisioningTemplateOutput

type DescribeProvisioningTemplateOutput struct {
	// The description of the fleet provisioning template.
	Description *string
	// The date when the fleet provisioning template was last modified.
	LastModifiedDate *time.Time
	// The ARN of the fleet provisioning template.
	TemplateArn *string
	// The date when the fleet provisioning template was created.
	CreationDate *time.Time
	// The ARN of the role associated with the provisioning template. This IoT role
	// grants permission to provision a device.
	ProvisioningRoleArn *string
	// True if the fleet provisioning template is enabled, otherwise false.
	Enabled *bool
	// The name of the fleet provisioning template.
	TemplateName *string
	// Gets information about a pre-provisioned hook.
	PreProvisioningHook *types.ProvisioningHook
	// The JSON formatted contents of the fleet provisioning template.
	TemplateBody *string
	// The default fleet template version ID.
	DefaultVersionId *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeProvisioningTemplateVersionInput

type DescribeProvisioningTemplateVersionInput struct {
	// The template name.
	TemplateName *string
	// The fleet provisioning template version ID.
	VersionId *int32
}

type DescribeProvisioningTemplateVersionOutput

type DescribeProvisioningTemplateVersionOutput struct {
	// The JSON formatted contents of the fleet provisioning template version.
	TemplateBody *string
	// The date when the fleet provisioning template version was created.
	CreationDate *time.Time
	// True if the fleet provisioning template version is the default version.
	IsDefaultVersion *bool
	// The fleet provisioning template version ID.
	VersionId *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeRoleAliasInput

type DescribeRoleAliasInput struct {
	// The role alias to describe.
	RoleAlias *string
}

type DescribeRoleAliasOutput

type DescribeRoleAliasOutput struct {
	// The role alias description.
	RoleAliasDescription *types.RoleAliasDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeScheduledAuditInput

type DescribeScheduledAuditInput struct {
	// The name of the scheduled audit whose information you want to get.
	ScheduledAuditName *string
}

type DescribeScheduledAuditOutput

type DescribeScheduledAuditOutput struct {
	// How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY",
	// or "MONTHLY". The start time of each audit is determined by the system.
	Frequency types.AuditFrequency
	// The day of the week on which the scheduled audit takes place. One of "SUN",
	// "MON", "TUE", "WED", "THU", "FRI", or "SAT".
	DayOfWeek types.DayOfWeek
	// The ARN of the scheduled audit.
	ScheduledAuditArn *string
	// The day of the month on which the scheduled audit takes place. Will be "1"
	// through "31" or "LAST". If days 29-31 are specified, and the month does not have
	// that many days, the audit takes place on the "LAST" day of the month.
	DayOfMonth *string
	// The name of the scheduled audit.
	ScheduledAuditName *string
	// Which checks are performed during the scheduled audit. Checks must be enabled
	// for your account. (Use DescribeAccountAuditConfiguration to see the list of all
	// checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	TargetCheckNames []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSecurityProfileInput

type DescribeSecurityProfileInput struct {
	// The name of the security profile whose information you want to get.
	SecurityProfileName *string
}

type DescribeSecurityProfileOutput

type DescribeSecurityProfileOutput struct {
	// The name of the security profile.
	SecurityProfileName *string
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for any
	// metric specified here. Note: This API field is deprecated. Please use
	// DescribeSecurityProfileResponse$additionalMetricsToRetainV2 () instead.
	AdditionalMetricsToRetain []*string
	// A description of the security profile (associated with the security profile when
	// it was created or updated).
	SecurityProfileDescription *string
	// The version of the security profile. A new version is generated whenever the
	// security profile is updated.
	Version *int64
	// The time the security profile was created.
	CreationDate *time.Time
	// Where the alerts are sent. (Alerts are always sent to the console.)
	AlertTargets map[string]*types.AlertTarget
	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	Behaviors []*types.Behavior
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for any
	// metric specified here.
	AdditionalMetricsToRetainV2 []*types.MetricToRetain
	// The time the security profile was last modified.
	LastModifiedDate *time.Time
	// The ARN of the security profile.
	SecurityProfileArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeStreamInput

type DescribeStreamInput struct {
	// The stream ID.
	StreamId *string
}

type DescribeStreamOutput

type DescribeStreamOutput struct {
	// Information about the stream.
	StreamInfo *types.StreamInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeThingGroupInput

type DescribeThingGroupInput struct {
	// The name of the thing group.
	ThingGroupName *string
}

type DescribeThingGroupOutput

type DescribeThingGroupOutput struct {
	// The dynamic thing group query version.
	QueryVersion *string
	// The thing group ID.
	ThingGroupId *string
	// The dynamic thing group index name.
	IndexName *string
	// The thing group ARN.
	ThingGroupArn *string
	// The name of the thing group.
	ThingGroupName *string
	// Thing group metadata.
	ThingGroupMetadata *types.ThingGroupMetadata
	// The thing group properties.
	ThingGroupProperties *types.ThingGroupProperties
	// The dynamic thing group status.
	Status types.DynamicGroupStatus
	// The dynamic thing group search query string.
	QueryString *string
	// The version of the thing group.
	Version *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeThingInput

type DescribeThingInput struct {
	// The name of the thing.
	ThingName *string
}

The input for the DescribeThing operation.

type DescribeThingOutput

type DescribeThingOutput struct {
	// The ARN of the thing to describe.
	ThingArn *string
	// The thing type name.
	ThingTypeName *string
	// The name of the billing group the thing belongs to.
	BillingGroupName *string
	// The name of the thing.
	ThingName *string
	// The default MQTT client ID. For a typical device, the thing name is also used as
	// the default MQTT client ID. Although we don’t require a mapping between a
	// thing's registry name and its use of MQTT client IDs, certificates, or shadow
	// state, we recommend that you choose a thing name and use it as the MQTT client
	// ID for the registry and the Device Shadow service. This lets you better organize
	// your AWS IoT fleet without removing the flexibility of the underlying device
	// certificate model or shadows.
	DefaultClientId *string
	// The thing attributes.
	Attributes map[string]*string
	// The current version of the thing record in the registry. To avoid unintentional
	// changes to the information in the registry, you can pass the version information
	// in the expectedVersion parameter of the UpdateThing and DeleteThing calls.
	Version *int64
	// The ID of the thing to describe.
	ThingId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the DescribeThing operation.

type DescribeThingRegistrationTaskInput

type DescribeThingRegistrationTaskInput struct {
	// The task ID.
	TaskId *string
}

type DescribeThingRegistrationTaskOutput

type DescribeThingRegistrationTaskOutput struct {
	// The input file key.
	InputFileKey *string
	// The date when the task was last modified.
	LastModifiedDate *time.Time
	// The status of the bulk thing provisioning task.
	Status types.Status
	// The role ARN that grants access to the input file bucket.
	RoleArn *string
	// The number of things successfully provisioned.
	SuccessCount *int32
	// The S3 bucket that contains the input file.
	InputFileBucket *string
	// The task's template.
	TemplateBody *string
	// The message.
	Message *string
	// The number of things that failed to be provisioned.
	FailureCount *int32
	// The progress of the bulk provisioning task expressed as a percentage.
	PercentageProgress *int32
	// The task ID.
	TaskId *string
	// The task creation date.
	CreationDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeThingTypeInput

type DescribeThingTypeInput struct {
	// The name of the thing type.
	ThingTypeName *string
}

The input for the DescribeThingType operation.

type DescribeThingTypeOutput

type DescribeThingTypeOutput struct {
	// The thing type ID.
	ThingTypeId *string
	// The ThingTypeMetadata contains additional information about the thing type
	// including: creation date and time, a value indicating whether the thing type is
	// deprecated, and a date and time when it was deprecated.
	ThingTypeMetadata *types.ThingTypeMetadata
	// The name of the thing type.
	ThingTypeName *string
	// The thing type ARN.
	ThingTypeArn *string
	// The ThingTypeProperties contains information about the thing type including
	// description, and a list of searchable thing attribute names.
	ThingTypeProperties *types.ThingTypeProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the DescribeThingType operation.

type DetachPolicyInput

type DetachPolicyInput struct {
	// The target from which the policy will be detached.
	Target *string
	// The policy to detach.
	PolicyName *string
}

type DetachPolicyOutput

type DetachPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetachPrincipalPolicyInput

type DetachPrincipalPolicyInput struct {
	// The principal. If the principal is a certificate, specify the certificate ARN.
	// If the principal is an Amazon Cognito identity, specify the identity ID.
	Principal *string
	// The name of the policy to detach.
	PolicyName *string
}

The input for the DetachPrincipalPolicy operation.

type DetachPrincipalPolicyOutput

type DetachPrincipalPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetachSecurityProfileInput

type DetachSecurityProfileInput struct {
	// The security profile that is detached.
	SecurityProfileName *string
	// The ARN of the thing group from which the security profile is detached.
	SecurityProfileTargetArn *string
}

type DetachSecurityProfileOutput

type DetachSecurityProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetachThingPrincipalInput

type DetachThingPrincipalInput struct {
	// The name of the thing.
	ThingName *string
	// If the principal is a certificate, this value must be ARN of the certificate. If
	// the principal is an Amazon Cognito identity, this value must be the ID of the
	// Amazon Cognito identity.
	Principal *string
}

The input for the DetachThingPrincipal operation.

type DetachThingPrincipalOutput

type DetachThingPrincipalOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the DetachThingPrincipal operation.

type DisableTopicRuleInput

type DisableTopicRuleInput struct {
	// The name of the rule to disable.
	RuleName *string
}

The input for the DisableTopicRuleRequest operation.

type DisableTopicRuleOutput

type DisableTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EnableTopicRuleInput

type EnableTopicRuleInput struct {
	// The name of the topic rule to enable.
	RuleName *string
}

The input for the EnableTopicRuleRequest operation.

type EnableTopicRuleOutput

type EnableTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetCardinalityInput

type GetCardinalityInput struct {
	// The query version.
	QueryVersion *string
	// The search query.
	QueryString *string
	// The field to aggregate.
	AggregationField *string
	// The name of the index to search.
	IndexName *string
}

type GetCardinalityOutput

type GetCardinalityOutput struct {
	// The approximate count of unique values that match the query.
	Cardinality *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetEffectivePoliciesInput

type GetEffectivePoliciesInput struct {
	// The thing name.
	ThingName *string
	// The Cognito identity pool ID.
	CognitoIdentityPoolId *string
	// The principal.
	Principal *string
}

type GetEffectivePoliciesOutput

type GetEffectivePoliciesOutput struct {
	// The effective policies.
	EffectivePolicies []*types.EffectivePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetIndexingConfigurationInput

type GetIndexingConfigurationInput struct {
}

type GetIndexingConfigurationOutput

type GetIndexingConfigurationOutput struct {
	// Thing indexing configuration.
	ThingIndexingConfiguration *types.ThingIndexingConfiguration
	// The index configuration.
	ThingGroupIndexingConfiguration *types.ThingGroupIndexingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetJobDocumentInput

type GetJobDocumentInput struct {
	// The unique identifier you assigned to this job when it was created.
	JobId *string
}

type GetJobDocumentOutput

type GetJobDocumentOutput struct {
	// The job document content.
	Document *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLoggingOptionsInput

type GetLoggingOptionsInput struct {
}

The input for the GetLoggingOptions operation.

type GetLoggingOptionsOutput

type GetLoggingOptionsOutput struct {
	// The logging level.
	LogLevel types.LogLevel
	// The ARN of the IAM role that grants access.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the GetLoggingOptions operation.

type GetOTAUpdateInput

type GetOTAUpdateInput struct {
	// The OTA update ID.
	OtaUpdateId *string
}

type GetOTAUpdateOutput

type GetOTAUpdateOutput struct {
	// The OTA update info.
	OtaUpdateInfo *types.OTAUpdateInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetPercentilesInput

type GetPercentilesInput struct {
	// The percentile groups returned.
	Percents []*float64
	// The name of the index to search.
	IndexName *string
	// The query version.
	QueryVersion *string
	// The query string.
	QueryString *string
	// The field to aggregate.
	AggregationField *string
}

type GetPercentilesOutput

type GetPercentilesOutput struct {
	// The percentile values of the aggregated fields.
	Percentiles []*types.PercentPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetPolicyInput

type GetPolicyInput struct {
	// The name of the policy.
	PolicyName *string
}

The input for the GetPolicy operation.

type GetPolicyOutput

type GetPolicyOutput struct {
	// The date the policy was created.
	CreationDate *time.Time
	// The policy name.
	PolicyName *string
	// The date the policy was last modified.
	LastModifiedDate *time.Time
	// The policy ARN.
	PolicyArn *string
	// The generation ID of the policy.
	GenerationId *string
	// The default policy version ID.
	DefaultVersionId *string
	// The JSON document that describes the policy.
	PolicyDocument *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the GetPolicy operation.

type GetPolicyVersionInput

type GetPolicyVersionInput struct {
	// The policy version ID.
	PolicyVersionId *string
	// The name of the policy.
	PolicyName *string
}

The input for the GetPolicyVersion operation.

type GetPolicyVersionOutput

type GetPolicyVersionOutput struct {
	// The policy version ID.
	PolicyVersionId *string
	// The policy ARN.
	PolicyArn *string
	// The policy name.
	PolicyName *string
	// Specifies whether the policy version is the default.
	IsDefaultVersion *bool
	// The date the policy was last modified.
	LastModifiedDate *time.Time
	// The generation ID of the policy version.
	GenerationId *string
	// The JSON document that describes the policy.
	PolicyDocument *string
	// The date the policy was created.
	CreationDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the GetPolicyVersion operation.

type GetRegistrationCodeInput

type GetRegistrationCodeInput struct {
}

The input to the GetRegistrationCode operation.

type GetRegistrationCodeOutput

type GetRegistrationCodeOutput struct {
	// The CA certificate registration code.
	RegistrationCode *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the GetRegistrationCode operation.

type GetStatisticsInput

type GetStatisticsInput struct {
	// The name of the index to search. The default value is AWS_Things.
	IndexName *string
	// The query used to search. You can specify "*" for the query string to get the
	// count of all indexed things in your AWS account.
	QueryString *string
	// The version of the query used to search.
	QueryVersion *string
	// The aggregation field name.
	AggregationField *string
}

type GetStatisticsOutput

type GetStatisticsOutput struct {
	// The statistics returned by the Fleet Indexing service based on the query and
	// aggregation field.
	Statistics *types.Statistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetTopicRuleDestinationInput

type GetTopicRuleDestinationInput struct {
	// The ARN of the topic rule destination.
	Arn *string
}

type GetTopicRuleDestinationOutput

type GetTopicRuleDestinationOutput struct {
	// The topic rule destination.
	TopicRuleDestination *types.TopicRuleDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetTopicRuleInput

type GetTopicRuleInput struct {
	// The name of the rule.
	RuleName *string
}

The input for the GetTopicRule operation.

type GetTopicRuleOutput

type GetTopicRuleOutput struct {
	// The rule.
	Rule *types.TopicRule
	// The rule ARN.
	RuleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the GetTopicRule operation.

type GetV2LoggingOptionsInput

type GetV2LoggingOptionsInput struct {
}

type GetV2LoggingOptionsOutput

type GetV2LoggingOptionsOutput struct {
	// The default log level.
	DefaultLogLevel types.LogLevel
	// The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
	RoleArn *string
	// Disables all logs.
	DisableAllLogs *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListActiveViolationsInput

type ListActiveViolationsInput struct {
	// The name of the thing whose active violations are listed.
	ThingName *string
	// The maximum number of results to return at one time.
	MaxResults *int32
	// The token for the next set of results.
	NextToken *string
	// The name of the Device Defender security profile for which violations are
	// listed.
	SecurityProfileName *string
}

type ListActiveViolationsOutput

type ListActiveViolationsOutput struct {
	// The list of active violations.
	ActiveViolations []*types.ActiveViolation
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAttachedPoliciesInput

type ListAttachedPoliciesInput struct {
	// The token to retrieve the next set of results.
	Marker *string
	// When true, recursively list attached policies.
	Recursive *bool
	// The maximum number of results to be returned per request.
	PageSize *int32
	// The group or principal for which the policies will be listed.
	Target *string
}

type ListAttachedPoliciesOutput

type ListAttachedPoliciesOutput struct {
	// The policies.
	Policies []*types.Policy
	// The token to retrieve the next set of results, or “null“ if there are no more
	// results.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAuditFindingsInput

type ListAuditFindingsInput struct {
	// The token for the next set of results.
	NextToken *string
	// A filter to limit results to those found after the specified time. You must
	// specify either the startTime and endTime or the taskId, but not both.
	StartTime *time.Time
	// A filter to limit results to the findings for the specified audit check.
	CheckName *string
	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int32
	// A filter to limit results to the audit with the specified ID. You must specify
	// either the taskId or the startTime and endTime, but not both.
	TaskId *string
	// Information identifying the noncompliant resource.
	ResourceIdentifier *types.ResourceIdentifier
	// A filter to limit results to those found before the specified time. You must
	// specify either the startTime and endTime or the taskId, but not both.
	EndTime *time.Time
}

type ListAuditFindingsOutput

type ListAuditFindingsOutput struct {
	// The findings (results) of the audit.
	Findings []*types.AuditFinding
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAuditMitigationActionsExecutionsInput

type ListAuditMitigationActionsExecutionsInput struct {
	// Specify this filter to limit results to those that were applied to a specific
	// audit finding.
	FindingId *string
	// The token for the next set of results.
	NextToken *string
	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int32
	// Specify this filter to limit results to actions for a specific audit mitigation
	// actions task.
	TaskId *string
	// Specify this filter to limit results to those with a specific status.
	ActionStatus types.AuditMitigationActionsExecutionStatus
}

type ListAuditMitigationActionsExecutionsOutput

type ListAuditMitigationActionsExecutionsOutput struct {
	// The token for the next set of results.
	NextToken *string
	// A set of task execution results based on the input parameters. Details include
	// the mitigation action applied, start time, and task status.
	ActionsExecutions []*types.AuditMitigationActionExecutionMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAuditMitigationActionsTasksInput

type ListAuditMitigationActionsTasksInput struct {
	// Specify this filter to limit results to tasks that were applied to results for a
	// specific audit.
	AuditTaskId *string
	// Specify this filter to limit results to tasks that are in a specific state.
	TaskStatus types.AuditMitigationActionsTaskStatus
	// The token for the next set of results.
	NextToken *string
	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int32
	// Specify this filter to limit results to tasks that began on or after a specific
	// date and time.
	StartTime *time.Time
	// Specify this filter to limit results to tasks that were applied to a specific
	// audit finding.
	FindingId *string
	// Specify this filter to limit results to tasks that were completed or canceled on
	// or before a specific date and time.
	EndTime *time.Time
}

type ListAuditMitigationActionsTasksOutput

type ListAuditMitigationActionsTasksOutput struct {
	// The collection of audit mitigation tasks that matched the filter criteria.
	Tasks []*types.AuditMitigationActionsTaskMetadata
	// The token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAuditTasksInput

type ListAuditTasksInput struct {
	// A filter to limit the output to the specified type of audit: can be one of
	// "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
	TaskType types.AuditTaskType
	// The end of the time period.
	EndTime *time.Time
	// The beginning of the time period. Audit information is retained for a limited
	// time (180 days). Requesting a start time prior to what is retained results in an
	// "InvalidRequestException".
	StartTime *time.Time
	// A filter to limit the output to audits with the specified completion status: can
	// be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
	TaskStatus types.AuditTaskStatus
	// The token for the next set of results.
	NextToken *string
	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int32
}

type ListAuditTasksOutput

type ListAuditTasksOutput struct {
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string
	// The audits that were performed during the specified time period.
	Tasks []*types.AuditTaskMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAuthorizersInput

type ListAuthorizersInput struct {
	// The status of the list authorizers request.
	Status types.AuthorizerStatus
	// A marker used to get the next set of results.
	Marker *string
	// The maximum number of results to return at one time.
	PageSize *int32
	// Return the list of authorizers in ascending alphabetical order.
	AscendingOrder *bool
}

type ListAuthorizersOutput

type ListAuthorizersOutput struct {
	// The authorizers.
	Authorizers []*types.AuthorizerSummary
	// A marker used to get the next set of results.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListBillingGroupsInput

type ListBillingGroupsInput struct {
	// The maximum number of results to return per request.
	MaxResults *int32
	// Limit the results to billing groups whose names have the given prefix.
	NamePrefixFilter *string
	// The token to retrieve the next set of results.
	NextToken *string
}

type ListBillingGroupsOutput

type ListBillingGroupsOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The list of billing groups.
	BillingGroups []*types.GroupNameAndArn

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListCACertificatesInput

type ListCACertificatesInput struct {
	// Determines the order of the results.
	AscendingOrder *bool
	// The marker for the next set of results.
	Marker *string
	// The result page size.
	PageSize *int32
}

Input for the ListCACertificates operation.

type ListCACertificatesOutput

type ListCACertificatesOutput struct {
	// The CA certificates registered in your AWS account.
	Certificates []*types.CACertificate
	// The current position within the list of CA certificates.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListCACertificates operation.

type ListCertificatesByCAInput

type ListCertificatesByCAInput struct {
	// The result page size.
	PageSize *int32
	// The marker for the next set of results.
	Marker *string
	// Specifies the order for results. If True, the results are returned in ascending
	// order, based on the creation date.
	AscendingOrder *bool
	// The ID of the CA certificate. This operation will list all registered device
	// certificate that were signed by this CA certificate.
	CaCertificateId *string
}

The input to the ListCertificatesByCA operation.

type ListCertificatesByCAOutput

type ListCertificatesByCAOutput struct {
	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string
	// The device certificates signed by the specified CA certificate.
	Certificates []*types.Certificate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the ListCertificatesByCA operation.

type ListCertificatesInput

type ListCertificatesInput struct {
	// Specifies the order for results. If True, the results are returned in ascending
	// order, based on the creation date.
	AscendingOrder *bool
	// The result page size.
	PageSize *int32
	// The marker for the next set of results.
	Marker *string
}

The input for the ListCertificates operation.

type ListCertificatesOutput

type ListCertificatesOutput struct {
	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string
	// The descriptions of the certificates.
	Certificates []*types.Certificate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output of the ListCertificates operation.

type ListDimensionsInput

type ListDimensionsInput struct {
	// The token for the next set of results.
	NextToken *string
	// The maximum number of results to retrieve at one time.
	MaxResults *int32
}

type ListDimensionsOutput

type ListDimensionsOutput struct {
	// A list of the names of the defined dimensions. Use DescribeDimension to get
	// details for a dimension.
	DimensionNames []*string
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDomainConfigurationsInput

type ListDomainConfigurationsInput struct {
	// The marker for the next set of results.
	Marker *string
	// The type of service delivered by the endpoint.
	ServiceType types.ServiceType
	// The result page size.
	PageSize *int32
}

type ListDomainConfigurationsOutput

type ListDomainConfigurationsOutput struct {
	// The marker for the next set of results.
	NextMarker *string
	// A list of objects that contain summary information about the user's domain
	// configurations.
	DomainConfigurations []*types.DomainConfigurationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListIndicesInput

type ListIndicesInput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The maximum number of results to return at one time.
	MaxResults *int32
}

type ListIndicesOutput

type ListIndicesOutput struct {
	// The index names.
	IndexNames []*string
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListJobExecutionsForJobInput

type ListJobExecutionsForJobInput struct {
	// The maximum number of results to be returned per request.
	MaxResults *int32
	// The unique identifier you assigned to this job when it was created.
	JobId *string
	// The status of the job.
	Status types.JobExecutionStatus
	// The token to retrieve the next set of results.
	NextToken *string
}

type ListJobExecutionsForJobOutput

type ListJobExecutionsForJobOutput struct {
	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string
	// A list of job execution summaries.
	ExecutionSummaries []*types.JobExecutionSummaryForJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListJobExecutionsForThingInput

type ListJobExecutionsForThingInput struct {
	// The maximum number of results to be returned per request.
	MaxResults *int32
	// The token to retrieve the next set of results.
	NextToken *string
	// The thing name.
	ThingName *string
	// An optional filter that lets you search for jobs that have the specified status.
	Status types.JobExecutionStatus
}

type ListJobExecutionsForThingOutput

type ListJobExecutionsForThingOutput struct {
	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string
	// A list of job execution summaries.
	ExecutionSummaries []*types.JobExecutionSummaryForThing

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListJobsInput

type ListJobsInput struct {
	// An optional filter that lets you search for jobs that have the specified status.
	Status types.JobStatus
	// The token to retrieve the next set of results.
	NextToken *string
	// Specifies whether the job will continue to run (CONTINUOUS), or will be complete
	// after all those things specified as targets have completed the job (SNAPSHOT).
	// If continuous, the job may also be run on a thing when a change is detected in a
	// target. For example, a job will run on a thing when the thing is added to a
	// target group, even after the job was completed by all things originally in the
	// group.
	TargetSelection types.TargetSelection
	// The maximum number of results to return per request.
	MaxResults *int32
	// A filter that limits the returned jobs to those for the specified group.
	ThingGroupName *string
	// A filter that limits the returned jobs to those for the specified group.
	ThingGroupId *string
}

type ListJobsOutput

type ListJobsOutput struct {
	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string
	// A list of jobs.
	Jobs []*types.JobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListMitigationActionsInput

type ListMitigationActionsInput struct {
	// Specify a value to limit the result to mitigation actions with a specific action
	// type.
	ActionType types.MitigationActionType
	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int32
	// The token for the next set of results.
	NextToken *string
}

type ListMitigationActionsOutput

type ListMitigationActionsOutput struct {
	// A set of actions that matched the specified filter criteria.
	ActionIdentifiers []*types.MitigationActionIdentifier
	// The token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListOTAUpdatesInput

type ListOTAUpdatesInput struct {
	// The OTA update job status.
	OtaUpdateStatus types.OTAUpdateStatus
	// A token used to retrieve the next set of results.
	NextToken *string
	// The maximum number of results to return at one time.
	MaxResults *int32
}

type ListOTAUpdatesOutput

type ListOTAUpdatesOutput struct {
	// A token to use to get the next set of results.
	NextToken *string
	// A list of OTA update jobs.
	OtaUpdates []*types.OTAUpdateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListOutgoingCertificatesInput

type ListOutgoingCertificatesInput struct {
	// Specifies the order for results. If True, the results are returned in ascending
	// order, based on the creation date.
	AscendingOrder *bool
	// The marker for the next set of results.
	Marker *string
	// The result page size.
	PageSize *int32
}

The input to the ListOutgoingCertificates operation.

type ListOutgoingCertificatesOutput

type ListOutgoingCertificatesOutput struct {
	// The marker for the next set of results.
	NextMarker *string
	// The certificates that are being transferred but not yet accepted.
	OutgoingCertificates []*types.OutgoingCertificate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListOutgoingCertificates operation.

type ListPoliciesInput

type ListPoliciesInput struct {
	// The result page size.
	PageSize *int32
	// The marker for the next set of results.
	Marker *string
	// Specifies the order for results. If true, the results are returned in ascending
	// creation order.
	AscendingOrder *bool
}

The input for the ListPolicies operation.

type ListPoliciesOutput

type ListPoliciesOutput struct {
	// The descriptions of the policies.
	Policies []*types.Policy
	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListPolicies operation.

type ListPolicyPrincipalsInput

type ListPolicyPrincipalsInput struct {
	// The result page size.
	PageSize *int32
	// The policy name.
	PolicyName *string
	// Specifies the order for results. If true, the results are returned in ascending
	// creation order.
	AscendingOrder *bool
	// The marker for the next set of results.
	Marker *string
}

The input for the ListPolicyPrincipals operation.

type ListPolicyPrincipalsOutput

type ListPolicyPrincipalsOutput struct {
	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string
	// The descriptions of the principals.
	Principals []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListPolicyPrincipals operation.

type ListPolicyVersionsInput

type ListPolicyVersionsInput struct {
	// The policy name.
	PolicyName *string
}

The input for the ListPolicyVersions operation.

type ListPolicyVersionsOutput

type ListPolicyVersionsOutput struct {
	// The policy versions.
	PolicyVersions []*types.PolicyVersion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListPolicyVersions operation.

type ListPrincipalPoliciesInput

type ListPrincipalPoliciesInput struct {
	// The marker for the next set of results.
	Marker *string
	// The result page size.
	PageSize *int32
	// The principal.
	Principal *string
	// Specifies the order for results. If true, results are returned in ascending
	// creation order.
	AscendingOrder *bool
}

The input for the ListPrincipalPolicies operation.

type ListPrincipalPoliciesOutput

type ListPrincipalPoliciesOutput struct {
	// The policies.
	Policies []*types.Policy
	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListPrincipalPolicies operation.

type ListPrincipalThingsInput

type ListPrincipalThingsInput struct {
	// The principal.
	Principal *string
	// The maximum number of results to return in this operation.
	MaxResults *int32
	// The token to retrieve the next set of results.
	NextToken *string
}

The input for the ListPrincipalThings operation.

type ListPrincipalThingsOutput

type ListPrincipalThingsOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The things.
	Things []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListPrincipalThings operation.

type ListProvisioningTemplateVersionsInput

type ListProvisioningTemplateVersionsInput struct {
	// A token to retrieve the next set of results.
	NextToken *string
	// The name of the fleet provisioning template.
	TemplateName *string
	// The maximum number of results to return at one time.
	MaxResults *int32
}

type ListProvisioningTemplateVersionsOutput

type ListProvisioningTemplateVersionsOutput struct {
	// A token to retrieve the next set of results.
	NextToken *string
	// The list of fleet provisioning template versions.
	Versions []*types.ProvisioningTemplateVersionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListProvisioningTemplatesInput

type ListProvisioningTemplatesInput struct {
	// The maximum number of results to return at one time.
	MaxResults *int32
	// A token to retrieve the next set of results.
	NextToken *string
}

type ListProvisioningTemplatesOutput

type ListProvisioningTemplatesOutput struct {
	// A token to retrieve the next set of results.
	NextToken *string
	// A list of fleet provisioning templates
	Templates []*types.ProvisioningTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListRoleAliasesInput

type ListRoleAliasesInput struct {
	// Return the list of role aliases in ascending alphabetical order.
	AscendingOrder *bool
	// The maximum number of results to return at one time.
	PageSize *int32
	// A marker used to get the next set of results.
	Marker *string
}

type ListRoleAliasesOutput

type ListRoleAliasesOutput struct {
	// The role aliases.
	RoleAliases []*string
	// A marker used to get the next set of results.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListScheduledAuditsInput

type ListScheduledAuditsInput struct {
	// The token for the next set of results.
	NextToken *string
	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int32
}

type ListScheduledAuditsOutput

type ListScheduledAuditsOutput struct {
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string
	// The list of scheduled audits.
	ScheduledAudits []*types.ScheduledAuditMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSecurityProfilesForTargetInput

type ListSecurityProfilesForTargetInput struct {
	// The maximum number of results to return at one time.
	MaxResults *int32
	// If true, return child groups too.
	Recursive *bool
	// The token for the next set of results.
	NextToken *string
	// The ARN of the target (thing group) whose attached security profiles you want to
	// get.
	SecurityProfileTargetArn *string
}

type ListSecurityProfilesForTargetOutput

type ListSecurityProfilesForTargetOutput struct {
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string
	// A list of security profiles and their associated targets.
	SecurityProfileTargetMappings []*types.SecurityProfileTargetMapping

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSecurityProfilesInput

type ListSecurityProfilesInput struct {
	// The token for the next set of results.
	NextToken *string
	// The maximum number of results to return at one time.
	MaxResults *int32
	// A filter to limit results to the security profiles that use the defined
	// dimension.
	DimensionName *string
}

type ListSecurityProfilesOutput

type ListSecurityProfilesOutput struct {
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string
	// A list of security profile identifiers (names and ARNs).
	SecurityProfileIdentifiers []*types.SecurityProfileIdentifier

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListStreamsInput

type ListStreamsInput struct {
	// Set to true to return the list of streams in ascending order.
	AscendingOrder *bool
	// A token used to get the next set of results.
	NextToken *string
	// The maximum number of results to return at a time.
	MaxResults *int32
}

type ListStreamsOutput

type ListStreamsOutput struct {
	// A token used to get the next set of results.
	NextToken *string
	// A list of streams.
	Streams []*types.StreamSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// The token to retrieve the next set of results.
	NextToken *string
	// The ARN of the resource.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// The list of tags assigned to the resource.
	Tags []*types.Tag
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTargetsForPolicyInput

type ListTargetsForPolicyInput struct {
	// The policy name.
	PolicyName *string
	// The maximum number of results to return at one time.
	PageSize *int32
	// A marker used to get the next set of results.
	Marker *string
}

type ListTargetsForPolicyOutput

type ListTargetsForPolicyOutput struct {
	// The policy targets.
	Targets []*string
	// A marker used to get the next set of results.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTargetsForSecurityProfileInput

type ListTargetsForSecurityProfileInput struct {
	// The security profile.
	SecurityProfileName *string
	// The token for the next set of results.
	NextToken *string
	// The maximum number of results to return at one time.
	MaxResults *int32
}

type ListTargetsForSecurityProfileOutput

type ListTargetsForSecurityProfileOutput struct {
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string
	// The thing groups to which the security profile is attached.
	SecurityProfileTargets []*types.SecurityProfileTarget

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListThingGroupsForThingInput

type ListThingGroupsForThingInput struct {
	// The maximum number of results to return at one time.
	MaxResults *int32
	// The thing name.
	ThingName *string
	// The token to retrieve the next set of results.
	NextToken *string
}

type ListThingGroupsForThingOutput

type ListThingGroupsForThingOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The thing groups.
	ThingGroups []*types.GroupNameAndArn

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListThingGroupsInput

type ListThingGroupsInput struct {
	// The maximum number of results to return at one time.
	MaxResults *int32
	// The token to retrieve the next set of results.
	NextToken *string
	// A filter that limits the results to those with the specified name prefix.
	NamePrefixFilter *string
	// A filter that limits the results to those with the specified parent group.
	ParentGroup *string
	// If true, return child groups as well.
	Recursive *bool
}

type ListThingGroupsOutput

type ListThingGroupsOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The thing groups.
	ThingGroups []*types.GroupNameAndArn

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListThingPrincipalsInput

type ListThingPrincipalsInput struct {
	// The name of the thing.
	ThingName *string
}

The input for the ListThingPrincipal operation.

type ListThingPrincipalsOutput

type ListThingPrincipalsOutput struct {
	// The principals associated with the thing.
	Principals []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListThingPrincipals operation.

type ListThingRegistrationTaskReportsInput

type ListThingRegistrationTaskReportsInput struct {
	// The maximum number of results to return per request.
	MaxResults *int32
	// The token to retrieve the next set of results.
	NextToken *string
	// The id of the task.
	TaskId *string
	// The type of task report.
	ReportType types.ReportType
}

type ListThingRegistrationTaskReportsOutput

type ListThingRegistrationTaskReportsOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The type of task report.
	ReportType types.ReportType
	// Links to the task resources.
	ResourceLinks []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListThingRegistrationTasksInput

type ListThingRegistrationTasksInput struct {
	// The maximum number of results to return at one time.
	MaxResults *int32
	// The token to retrieve the next set of results.
	NextToken *string
	// The status of the bulk thing provisioning task.
	Status types.Status
}

type ListThingRegistrationTasksOutput

type ListThingRegistrationTasksOutput struct {
	// A list of bulk thing provisioning task IDs.
	TaskIds []*string
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListThingTypesInput

type ListThingTypesInput struct {
	// The name of the thing type.
	ThingTypeName *string
	// The token to retrieve the next set of results.
	NextToken *string
	// The maximum number of results to return in this operation.
	MaxResults *int32
}

The input for the ListThingTypes operation.

type ListThingTypesOutput

type ListThingTypesOutput struct {
	// The thing types.
	ThingTypes []*types.ThingTypeDefinition
	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output for the ListThingTypes operation.

type ListThingsInBillingGroupInput

type ListThingsInBillingGroupInput struct {
	// The name of the billing group.
	BillingGroupName *string
	// The token to retrieve the next set of results.
	NextToken *string
	// The maximum number of results to return per request.
	MaxResults *int32
}

type ListThingsInBillingGroupOutput

type ListThingsInBillingGroupOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// A list of things in the billing group.
	Things []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListThingsInThingGroupInput

type ListThingsInThingGroupInput struct {
	// The token to retrieve the next set of results.
	NextToken *string
	// When true, list things in this thing group and in all child groups as well.
	Recursive *bool
	// The thing group name.
	ThingGroupName *string
	// The maximum number of results to return at one time.
	MaxResults *int32
}

type ListThingsInThingGroupOutput

type ListThingsInThingGroupOutput struct {
	// The things in the specified thing group.
	Things []*string
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListThingsInput

type ListThingsInput struct {
	// The attribute value used to search for things.
	AttributeValue *string
	// The name of the thing type used to search for things.
	ThingTypeName *string
	// The maximum number of results to return in this operation.
	MaxResults *int32
	// The token to retrieve the next set of results.
	NextToken *string
	// The attribute name used to search for things.
	AttributeName *string
}

The input for the ListThings operation.

type ListThingsOutput

type ListThingsOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The things.
	Things []*types.ThingAttribute

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListThings operation.

type ListTopicRuleDestinationsInput

type ListTopicRuleDestinationsInput struct {
	// The token to retrieve the next set of results.
	NextToken *string
	// The maximum number of results to return at one time.
	MaxResults *int32
}

type ListTopicRuleDestinationsOutput

type ListTopicRuleDestinationsOutput struct {
	// Information about a topic rule destination.
	DestinationSummaries []*types.TopicRuleDestinationSummary
	// The token to retrieve the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTopicRulesInput

type ListTopicRulesInput struct {
	// The topic.
	Topic *string
	// A token used to retrieve the next value.
	NextToken *string
	// Specifies whether the rule is disabled.
	RuleDisabled *bool
	// The maximum number of results to return.
	MaxResults *int32
}

The input for the ListTopicRules operation.

type ListTopicRulesOutput

type ListTopicRulesOutput struct {
	// A token used to retrieve the next value.
	NextToken *string
	// The rules.
	Rules []*types.TopicRuleListItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the ListTopicRules operation.

type ListV2LoggingLevelsInput

type ListV2LoggingLevelsInput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The maximum number of results to return at one time.
	MaxResults *int32
	// The type of resource for which you are configuring logging. Must be THING_Group.
	TargetType types.LogTargetType
}

type ListV2LoggingLevelsOutput

type ListV2LoggingLevelsOutput struct {
	// The logging configuration for a target.
	LogTargetConfigurations []*types.LogTargetConfiguration
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListViolationEventsInput

type ListViolationEventsInput struct {
	// The maximum number of results to return at one time.
	MaxResults *int32
	// The end time for the alerts to be listed.
	EndTime *time.Time
	// A filter to limit results to those alerts generated by the specified security
	// profile.
	SecurityProfileName *string
	// A filter to limit results to those alerts caused by the specified thing.
	ThingName *string
	// The start time for the alerts to be listed.
	StartTime *time.Time
	// The token for the next set of results.
	NextToken *string
}

type ListViolationEventsOutput

type ListViolationEventsOutput struct {
	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string
	// The security profile violation alerts issued for this account during the given
	// time period, potentially filtered by security profile, behavior violated, or
	// thing (device) violating.
	ViolationEvents []*types.ViolationEvent

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetIdempotencyTokenProvider

func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type RegisterCACertificateInput

type RegisterCACertificateInput struct {
	// Metadata which can be used to manage the CA certificate. For URI Request
	// parameters use format: ...key1=value1&key2=value2... For the CLI command-line
	// parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json
	// file use format: "tags": "key1=value1&key2=value2..."
	Tags []*types.Tag
	// Information about the registration configuration.
	RegistrationConfig *types.RegistrationConfig
	// The CA certificate.
	CaCertificate *string
	// The private key verification certificate.
	VerificationCertificate *string
	// Allows this CA certificate to be used for auto registration of device
	// certificates.
	AllowAutoRegistration *bool
	// A boolean value that specifies if the CA certificate is set to active.
	SetAsActive *bool
}

The input to the RegisterCACertificate operation.

type RegisterCACertificateOutput

type RegisterCACertificateOutput struct {
	// The CA certificate ARN.
	CertificateArn *string
	// The CA certificate identifier.
	CertificateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the RegisterCACertificateResponse operation.

type RegisterCertificateInput

type RegisterCertificateInput struct {
	// The status of the register certificate request.
	Status types.CertificateStatus
	// A boolean value that specifies if the certificate is set to active.
	SetAsActive *bool
	// The CA certificate used to sign the device certificate being registered.
	CaCertificatePem *string
	// The certificate data, in PEM format.
	CertificatePem *string
}

The input to the RegisterCertificate operation.

type RegisterCertificateOutput

type RegisterCertificateOutput struct {
	// The certificate ARN.
	CertificateArn *string
	// The certificate identifier.
	CertificateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the RegisterCertificate operation.

type RegisterCertificateWithoutCAInput

type RegisterCertificateWithoutCAInput struct {
	// The certificate data, in PEM format.
	CertificatePem *string
	// The status of the register certificate request.
	Status types.CertificateStatus
}

type RegisterCertificateWithoutCAOutput

type RegisterCertificateWithoutCAOutput struct {
	// The ID of the registered certificate. (The last part of the certificate ARN
	// contains the certificate ID.
	CertificateId *string
	// The Amazon Resource Name (ARN) of the registered certificate.
	CertificateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RegisterThingInput

type RegisterThingInput struct {
	// The parameters for provisioning a thing. See Provisioning Templates
	// (https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html)
	// for more information.
	Parameters map[string]*string
	// The provisioning template. See Provisioning Devices That Have Device
	// Certificates
	// (https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html)
	// for more information.
	TemplateBody *string
}

type RegisterThingOutput

type RegisterThingOutput struct {
	// ARNs for the generated resources.
	ResourceArns map[string]*string
	// The certificate data, in PEM format.
	CertificatePem *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RejectCertificateTransferInput

type RejectCertificateTransferInput struct {
	// The reason the certificate transfer was rejected.
	RejectReason *string
	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string
}

The input for the RejectCertificateTransfer operation.

type RejectCertificateTransferOutput

type RejectCertificateTransferOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveThingFromBillingGroupInput

type RemoveThingFromBillingGroupInput struct {
	// The ARN of the thing to be removed from the billing group.
	ThingArn *string
	// The name of the thing to be removed from the billing group.
	ThingName *string
	// The ARN of the billing group.
	BillingGroupArn *string
	// The name of the billing group.
	BillingGroupName *string
}

type RemoveThingFromBillingGroupOutput

type RemoveThingFromBillingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RemoveThingFromThingGroupInput

type RemoveThingFromThingGroupInput struct {
	// The ARN of the thing to remove from the group.
	ThingArn *string
	// The name of the thing to remove from the group.
	ThingName *string
	// The group name.
	ThingGroupName *string
	// The group ARN.
	ThingGroupArn *string
}

type RemoveThingFromThingGroupOutput

type RemoveThingFromThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ReplaceTopicRuleInput

type ReplaceTopicRuleInput struct {
	// The rule payload.
	TopicRulePayload *types.TopicRulePayload
	// The name of the rule.
	RuleName *string
}

The input for the ReplaceTopicRule operation.

type ReplaceTopicRuleOutput

type ReplaceTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type SearchIndexInput

type SearchIndexInput struct {
	// The search query string.
	QueryString *string
	// The query version.
	QueryVersion *string
	// The search index name.
	IndexName *string
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The maximum number of results to return at one time.
	MaxResults *int32
}

type SearchIndexOutput

type SearchIndexOutput struct {
	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// The things that match the search query.
	Things []*types.ThingDocument
	// The thing groups that match the search query.
	ThingGroups []*types.ThingGroupDocument

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetDefaultAuthorizerInput

type SetDefaultAuthorizerInput struct {
	// The authorizer name.
	AuthorizerName *string
}

type SetDefaultAuthorizerOutput

type SetDefaultAuthorizerOutput struct {
	// The authorizer name.
	AuthorizerName *string
	// The authorizer ARN.
	AuthorizerArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetDefaultPolicyVersionInput

type SetDefaultPolicyVersionInput struct {
	// The policy name.
	PolicyName *string
	// The policy version ID.
	PolicyVersionId *string
}

The input for the SetDefaultPolicyVersion operation.

type SetDefaultPolicyVersionOutput

type SetDefaultPolicyVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetLoggingOptionsInput

type SetLoggingOptionsInput struct {
	// The logging options payload.
	LoggingOptionsPayload *types.LoggingOptionsPayload
}

The input for the SetLoggingOptions operation.

type SetLoggingOptionsOutput

type SetLoggingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetV2LoggingLevelInput

type SetV2LoggingLevelInput struct {
	// The log level.
	LogLevel types.LogLevel
	// The log target.
	LogTarget *types.LogTarget
}

type SetV2LoggingLevelOutput

type SetV2LoggingLevelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetV2LoggingOptionsInput

type SetV2LoggingOptionsInput struct {
	// The default logging level.
	DefaultLogLevel types.LogLevel
	// The ARN of the role that allows IoT to write to Cloudwatch logs.
	RoleArn *string
	// If true all logs are disabled. The default is false.
	DisableAllLogs *bool
}

type SetV2LoggingOptionsOutput

type SetV2LoggingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartAuditMitigationActionsTaskInput

type StartAuditMitigationActionsTaskInput struct {
	// Each audit mitigation task must have a unique client request token. If you try
	// to start a new task with the same token as a task that already exists, an
	// exception occurs. If you omit this value, a unique client request token is
	// generated automatically.
	ClientRequestToken *string
	// Specifies the audit findings to which the mitigation actions are applied. You
	// can apply them to a type of audit check, to all findings from an audit, or to a
	// speecific set of findings.
	Target *types.AuditMitigationActionsTaskTarget
	// A unique identifier for the task. You can use this identifier to check the
	// status of the task or to cancel it.
	TaskId *string
	// For an audit check, specifies which mitigation actions to apply. Those actions
	// must be defined in your AWS account.
	AuditCheckToActionsMapping map[string][]*string
}

type StartAuditMitigationActionsTaskOutput

type StartAuditMitigationActionsTaskOutput struct {
	// The unique identifier for the audit mitigation task. This matches the taskId
	// that you specified in the request.
	TaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartOnDemandAuditTaskInput

type StartOnDemandAuditTaskInput struct {
	// Which checks are performed during the audit. The checks you specify must be
	// enabled for your account or an exception occurs. Use
	// DescribeAccountAuditConfiguration to see the list of all checks, including those
	// that are enabled or UpdateAccountAuditConfiguration to select which checks are
	// enabled.
	TargetCheckNames []*string
}

type StartOnDemandAuditTaskOutput

type StartOnDemandAuditTaskOutput struct {
	// The ID of the on-demand audit you started.
	TaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartThingRegistrationTaskInput

type StartThingRegistrationTaskInput struct {
	// The IAM role ARN that grants permission the input file.
	RoleArn *string
	// The name of input file within the S3 bucket. This file contains a newline
	// delimited JSON file. Each line contains the parameter values to provision one
	// device (thing).
	InputFileKey *string
	// The S3 bucket that contains the input file.
	InputFileBucket *string
	// The provisioning template.
	TemplateBody *string
}

type StartThingRegistrationTaskOutput

type StartThingRegistrationTaskOutput struct {
	// The bulk thing provisioning task ID.
	TaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopThingRegistrationTaskInput

type StopThingRegistrationTaskInput struct {
	// The bulk thing provisioning task ID.
	TaskId *string
}

type StopThingRegistrationTaskOutput

type StopThingRegistrationTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput

type TagResourceInput struct {
	// The new or modified tags for the resource.
	Tags []*types.Tag
	// The ARN of the resource.
	ResourceArn *string
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TestAuthorizationInput

type TestAuthorizationInput struct {
	// When testing custom authorization, the policies specified here are treated as if
	// they are attached to the principal being authorized.
	PolicyNamesToAdd []*string
	// When testing custom authorization, the policies specified here are treated as if
	// they are not attached to the principal being authorized.
	PolicyNamesToSkip []*string
	// The principal.
	Principal *string
	// The Cognito identity pool ID.
	CognitoIdentityPoolId *string
	// The MQTT client ID.
	ClientId *string
	// A list of authorization info objects. Simulating authorization will create a
	// response for each authInfo object in the list.
	AuthInfos []*types.AuthInfo
}

type TestAuthorizationOutput

type TestAuthorizationOutput struct {
	// The authentication results.
	AuthResults []*types.AuthResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TestInvokeAuthorizerInput

type TestInvokeAuthorizerInput struct {
	// The token returned by your custom authentication service.
	Token *string
	// The signature made with the token and your custom authentication service's
	// private key. This value must be Base-64-encoded.
	TokenSignature *string
	// Specifies a test MQTT authorization request.
	MqttContext *types.MqttContext
	// The custom authorizer name.
	AuthorizerName *string
	// Specifies a test TLS authorization request.
	TlsContext *types.TlsContext
	// Specifies a test HTTP authorization request.
	HttpContext *types.HttpContext
}

type TestInvokeAuthorizerOutput

type TestInvokeAuthorizerOutput struct {
	// IAM policy documents.
	PolicyDocuments []*string
	// The number of seconds after which the temporary credentials are refreshed.
	RefreshAfterInSeconds *int32
	// True if the token is authenticated, otherwise false.
	IsAuthenticated *bool
	// The number of seconds after which the connection is terminated.
	DisconnectAfterInSeconds *int32
	// The principal ID.
	PrincipalId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TransferCertificateInput

type TransferCertificateInput struct {
	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string
	// The transfer message.
	TransferMessage *string
	// The AWS account.
	TargetAwsAccount *string
}

The input for the TransferCertificate operation.

type TransferCertificateOutput

type TransferCertificateOutput struct {
	// The ARN of the certificate.
	TransferredCertificateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the TransferCertificate operation.

type UntagResourceInput

type UntagResourceInput struct {
	// A list of the keys of the tags to be removed from the resource.
	TagKeys []*string
	// The ARN of the resource.
	ResourceArn *string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAccountAuditConfigurationInput

type UpdateAccountAuditConfigurationInput struct {
	// Specifies which audit checks are enabled and disabled for this account. Use
	// DescribeAccountAuditConfiguration to see the list of all checks, including those
	// that are currently enabled. Some data collection might start immediately when
	// certain checks are enabled. When a check is disabled, any data collected so far
	// in relation to the check is deleted. You cannot disable a check if it is used by
	// any scheduled audit. You must first delete the check from the scheduled audit or
	// delete the scheduled audit itself. On the first call to
	// UpdateAccountAuditConfiguration, this parameter is required and must specify at
	// least one enabled check.
	AuditCheckConfigurations map[string]*types.AuditCheckConfiguration
	// Information about the targets to which audit notifications are sent.
	AuditNotificationTargetConfigurations map[string]*types.AuditNotificationTarget
	// The ARN of the role that grants permission to AWS IoT to access information
	// about your devices, policies, certificates and other items as required when
	// performing an audit.
	RoleArn *string
}

type UpdateAccountAuditConfigurationOutput

type UpdateAccountAuditConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAuthorizerInput

type UpdateAuthorizerInput struct {
	// The ARN of the authorizer's Lambda function.
	AuthorizerFunctionArn *string
	// The key used to extract the token from the HTTP headers.
	TokenKeyName *string
	// The public keys used to verify the token signature.
	TokenSigningPublicKeys map[string]*string
	// The status of the update authorizer request.
	Status types.AuthorizerStatus
	// The authorizer name.
	AuthorizerName *string
}

type UpdateAuthorizerOutput

type UpdateAuthorizerOutput struct {
	// The authorizer name.
	AuthorizerName *string
	// The authorizer ARN.
	AuthorizerArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateBillingGroupInput

type UpdateBillingGroupInput struct {
	// The properties of the billing group.
	BillingGroupProperties *types.BillingGroupProperties
	// The expected version of the billing group. If the version of the billing group
	// does not match the expected version specified in the request, the
	// UpdateBillingGroup request is rejected with a VersionConflictException.
	ExpectedVersion *int64
	// The name of the billing group.
	BillingGroupName *string
}

type UpdateBillingGroupOutput

type UpdateBillingGroupOutput struct {
	// The latest version of the billing group.
	Version *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateCACertificateInput

type UpdateCACertificateInput struct {
	// If true, removes auto registration.
	RemoveAutoRegistration *bool
	// The CA certificate identifier.
	CertificateId *string
	// The updated status of the CA certificate. Note: The status value
	// REGISTER_INACTIVE is deprecated and should not be used.
	NewStatus types.CACertificateStatus
	// The new value for the auto registration status. Valid values are: "ENABLE" or
	// "DISABLE".
	NewAutoRegistrationStatus types.AutoRegistrationStatus
	// Information about the registration configuration.
	RegistrationConfig *types.RegistrationConfig
}

The input to the UpdateCACertificate operation.

type UpdateCACertificateOutput

type UpdateCACertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateCertificateInput

type UpdateCertificateInput struct {
	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	CertificateId *string
	// The new status. Note: Setting the status to PENDING_TRANSFER or
	// PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER
	// and PENDING_ACTIVATION are statuses used internally by AWS IoT. They are not
	// intended for developer use. Note: The status value REGISTER_INACTIVE is
	// deprecated and should not be used.
	NewStatus types.CertificateStatus
}

The input for the UpdateCertificate operation.

type UpdateCertificateOutput

type UpdateCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDimensionInput

type UpdateDimensionInput struct {
	// A unique identifier for the dimension. Choose something that describes the type
	// and value to make it easy to remember what it does.
	Name *string
	// Specifies the value or list of values for the dimension. For TOPIC_FILTER
	// dimensions, this is a pattern used to match the MQTT topic (for example,
	// "admin/#").
	StringValues []*string
}

type UpdateDimensionOutput

type UpdateDimensionOutput struct {
	// The value or list of values used to scope the dimension. For example, for topic
	// filters, this is the pattern used to match the MQTT topic name.
	StringValues []*string
	// The type of the dimension.
	Type types.DimensionType
	// The date and time, in milliseconds since epoch, when the dimension was initially
	// created.
	CreationDate *time.Time
	// A unique identifier for the dimension.
	Name *string
	// The ARN (Amazon resource name) of the created dimension.
	Arn *string
	// The date and time, in milliseconds since epoch, when the dimension was most
	// recently updated.
	LastModifiedDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDomainConfigurationInput

type UpdateDomainConfigurationInput struct {
	// The name of the domain configuration to be updated.
	DomainConfigurationName *string
	// The status to which the domain configuration should be updated.
	DomainConfigurationStatus types.DomainConfigurationStatus
	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *types.AuthorizerConfig
	// Removes the authorization configuration from a domain.
	RemoveAuthorizerConfig *bool
}

type UpdateDomainConfigurationOutput

type UpdateDomainConfigurationOutput struct {
	// The name of the domain configuration that was updated.
	DomainConfigurationName *string
	// The ARN of the domain configuration that was updated.
	DomainConfigurationArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDynamicThingGroupInput

type UpdateDynamicThingGroupInput struct {
	// The name of the dynamic thing group to update.
	ThingGroupName *string
	// The dynamic thing group properties to update.
	ThingGroupProperties *types.ThingGroupProperties
	// The expected version of the dynamic thing group to update.
	ExpectedVersion *int64
	// The dynamic thing group index to update. Currently one index is supported:
	// 'AWS_Things'.
	IndexName *string
	// The dynamic thing group search query string to update.
	QueryString *string
	// The dynamic thing group query version to update. Currently one query version is
	// supported: "2017-09-30". If not specified, the query version defaults to this
	// value.
	QueryVersion *string
}

type UpdateDynamicThingGroupOutput

type UpdateDynamicThingGroupOutput struct {
	// The dynamic thing group version.
	Version *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateEventConfigurationsInput

type UpdateEventConfigurationsInput struct {
	// The new event configuration values.
	EventConfigurations map[string]*types.Configuration
}

type UpdateEventConfigurationsOutput

type UpdateEventConfigurationsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateIndexingConfigurationInput

type UpdateIndexingConfigurationInput struct {
	// Thing indexing configuration.
	ThingIndexingConfiguration *types.ThingIndexingConfiguration
	// Thing group indexing configuration.
	ThingGroupIndexingConfiguration *types.ThingGroupIndexingConfiguration
}

type UpdateIndexingConfigurationOutput

type UpdateIndexingConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateJobInput

type UpdateJobInput struct {
	// The ID of the job to be updated.
	JobId *string
	// Configuration information for pre-signed S3 URLs.
	PresignedUrlConfig *types.PresignedUrlConfig
	// Specifies the amount of time each device has to finish its execution of the job.
	// The timer is started when the job execution status is set to IN_PROGRESS. If the
	// job execution status is not set to another terminal state before the time
	// expires, it will be automatically set to TIMED_OUT.
	TimeoutConfig *types.TimeoutConfig
	// A short text description of the job.
	Description *string
	// Allows you to create a staged rollout of the job.
	JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig
	// Allows you to create criteria to abort a job.
	AbortConfig *types.AbortConfig
}

type UpdateJobOutput

type UpdateJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateMitigationActionInput

type UpdateMitigationActionInput struct {
	// The ARN of the IAM role that is used to apply the mitigation action.
	RoleArn *string
	// Defines the type of action and the parameters for that action.
	ActionParams *types.MitigationActionParams
	// The friendly name for the mitigation action. You can't change the name by using
	// UpdateMitigationAction. Instead, you must delete and re-create the mitigation
	// action with the new name.
	ActionName *string
}

type UpdateMitigationActionOutput

type UpdateMitigationActionOutput struct {
	// A unique identifier for the mitigation action.
	ActionId *string
	// The ARN for the new mitigation action.
	ActionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateProvisioningTemplateInput

type UpdateProvisioningTemplateInput struct {
	// The name of the fleet provisioning template.
	TemplateName *string
	// True to enable the fleet provisioning template, otherwise false.
	Enabled *bool
	// Removes pre-provisioning hook template.
	RemovePreProvisioningHook *bool
	// Updates the pre-provisioning hook template.
	PreProvisioningHook *types.ProvisioningHook
	// The ID of the default provisioning template version.
	DefaultVersionId *int32
	// The description of the fleet provisioning template.
	Description *string
	// The ARN of the role associated with the provisioning template. This IoT role
	// grants permission to provision a device.
	ProvisioningRoleArn *string
}

type UpdateProvisioningTemplateOutput

type UpdateProvisioningTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRoleAliasInput

type UpdateRoleAliasInput struct {
	// The role ARN.
	RoleArn *string
	// The role alias to update.
	RoleAlias *string
	// The number of seconds the credential will be valid.
	CredentialDurationSeconds *int32
}

type UpdateRoleAliasOutput

type UpdateRoleAliasOutput struct {
	// The role alias ARN.
	RoleAliasArn *string
	// The role alias.
	RoleAlias *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateScheduledAuditInput

type UpdateScheduledAuditInput struct {
	// The day of the week on which the scheduled audit takes place. Can be one of
	// "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if
	// the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
	DayOfWeek types.DayOfWeek
	// The name of the scheduled audit. (Max. 128 chars)
	ScheduledAuditName *string
	// Which checks are performed during the scheduled audit. Checks must be enabled
	// for your account. (Use DescribeAccountAuditConfiguration to see the list of all
	// checks, including those that are enabled or use UpdateAccountAuditConfiguration
	// to select which checks are enabled.)
	TargetCheckNames []*string
	// The day of the month on which the scheduled audit takes place. Can be "1"
	// through "31" or "LAST". This field is required if the "frequency" parameter is
	// set to "MONTHLY". If days 29-31 are specified, and the month does not have that
	// many days, the audit takes place on the "LAST" day of the month.
	DayOfMonth *string
	// How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY",
	// "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the
	// system.
	Frequency types.AuditFrequency
}

type UpdateScheduledAuditOutput

type UpdateScheduledAuditOutput struct {
	// The ARN of the scheduled audit.
	ScheduledAuditArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateSecurityProfileInput

type UpdateSecurityProfileInput struct {
	// If true, delete all behaviors defined for this security profile. If any
	// behaviors are defined in the current invocation, an exception occurs.
	DeleteBehaviors *bool
	// A description of the security profile.
	SecurityProfileDescription *string
	// The expected version of the security profile. A new version is generated
	// whenever the security profile is updated. If you specify a value that is
	// different from the actual version, a VersionConflictException is thrown.
	ExpectedVersion *int64
	// The name of the security profile you want to update.
	SecurityProfileName *string
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for any
	// metric specified here. Note: This API field is deprecated. Please use
	// UpdateSecurityProfileRequest$additionalMetricsToRetainV2 () instead.
	AdditionalMetricsToRetain []*string
	// If true, delete all additionalMetricsToRetain defined for this security profile.
	// If any additionalMetricsToRetain are defined in the current invocation, an
	// exception occurs.
	DeleteAdditionalMetricsToRetain *bool
	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	Behaviors []*types.Behavior
	// If true, delete all alertTargets defined for this security profile. If any
	// alertTargets are defined in the current invocation, an exception occurs.
	DeleteAlertTargets *bool
	// Where the alerts are sent. (Alerts are always sent to the console.)
	AlertTargets map[string]*types.AlertTarget
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for any
	// metric specified here.
	AdditionalMetricsToRetainV2 []*types.MetricToRetain
}

type UpdateSecurityProfileOutput

type UpdateSecurityProfileOutput struct {
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the security profile's behaviors, but it is also retained
	// for any metric specified here. Note: This API field is deprecated. Please use
	// UpdateSecurityProfileResponse$additionalMetricsToRetainV2 () instead.
	AdditionalMetricsToRetain []*string
	// The time the security profile was created.
	CreationDate *time.Time
	// A list of metrics whose data is retained (stored). By default, data is retained
	// for any metric used in the profile's behaviors, but it is also retained for any
	// metric specified here.
	AdditionalMetricsToRetainV2 []*types.MetricToRetain
	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	Behaviors []*types.Behavior
	// The name of the security profile that was updated.
	SecurityProfileName *string
	// The description of the security profile.
	SecurityProfileDescription *string
	// The ARN of the security profile that was updated.
	SecurityProfileArn *string
	// The time the security profile was last modified.
	LastModifiedDate *time.Time
	// The updated version of the security profile.
	Version *int64
	// Where the alerts are sent. (Alerts are always sent to the console.)
	AlertTargets map[string]*types.AlertTarget

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateStreamInput

type UpdateStreamInput struct {
	// An IAM role that allows the IoT service principal assumes to access your S3
	// files.
	RoleArn *string
	// The files associated with the stream.
	Files []*types.StreamFile
	// The stream ID.
	StreamId *string
	// The description of the stream.
	Description *string
}

type UpdateStreamOutput

type UpdateStreamOutput struct {
	// The stream ID.
	StreamId *string
	// The stream ARN.
	StreamArn *string
	// A description of the stream.
	Description *string
	// The stream version.
	StreamVersion *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateThingGroupInput

type UpdateThingGroupInput struct {
	// The thing group to update.
	ThingGroupName *string
	// The expected version of the thing group. If this does not match the version of
	// the thing group being updated, the update will fail.
	ExpectedVersion *int64
	// The thing group properties.
	ThingGroupProperties *types.ThingGroupProperties
}

type UpdateThingGroupOutput

type UpdateThingGroupOutput struct {
	// The version of the updated thing group.
	Version *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateThingGroupsForThingInput

type UpdateThingGroupsForThingInput struct {
	// Override dynamic thing groups with static thing groups when 10-group limit is
	// reached. If a thing belongs to 10 thing groups, and one or more of those groups
	// are dynamic thing groups, adding a thing to a static group removes the thing
	// from the last dynamic group.
	OverrideDynamicGroups *bool
	// The groups from which the thing will be removed.
	ThingGroupsToRemove []*string
	// The thing whose group memberships will be updated.
	ThingName *string
	// The groups to which the thing will be added.
	ThingGroupsToAdd []*string
}

type UpdateThingGroupsForThingOutput

type UpdateThingGroupsForThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateThingInput

type UpdateThingInput struct {
	// The name of the thing type.
	ThingTypeName *string
	// The expected version of the thing record in the registry. If the version of the
	// record in the registry does not match the expected version specified in the
	// request, the UpdateThing request is rejected with a VersionConflictException.
	ExpectedVersion *int64
	// The name of the thing to update. You can't change a thing's name. To change a
	// thing's name, you must create a new thing, give it the new name, and then delete
	// the old thing.
	ThingName *string
	// A list of thing attributes, a JSON string containing name-value pairs. For
	// example: {\"attributes\":{\"name1\":\"value2\"}} This data is used to add new
	// attributes or update existing attributes.
	AttributePayload *types.AttributePayload
	// Remove a thing type association. If true, the association is removed.
	RemoveThingType *bool
}

The input for the UpdateThing operation.

type UpdateThingOutput

type UpdateThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The output from the UpdateThing operation.

type UpdateTopicRuleDestinationInput

type UpdateTopicRuleDestinationInput struct {
	// The ARN of the topic rule destination.
	Arn *string
	// The status of the topic rule destination. Valid values are: IN_PROGRESS A topic
	// rule destination was created but has not been confirmed. You can set status to
	// IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
	// UpdateTopicRuleDestination causes a new confirmation challenge to be sent to
	// your confirmation endpoint. ENABLED Confirmation was completed, and traffic to
	// this destination is allowed. You can set status to DISABLED by calling
	// UpdateTopicRuleDestination. DISABLED Confirmation was completed, and traffic to
	// this destination is not allowed. You can set status to ENABLED by calling
	// UpdateTopicRuleDestination. ERROR Confirmation could not be completed, for
	// example if the confirmation timed out. You can call GetTopicRuleDestination for
	// details about the error. You can set status to IN_PROGRESS by calling
	// UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new
	// confirmation challenge to be sent to your confirmation endpoint.
	Status types.TopicRuleDestinationStatus
}

type UpdateTopicRuleDestinationOutput

type UpdateTopicRuleDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ValidateSecurityProfileBehaviorsInput

type ValidateSecurityProfileBehaviorsInput struct {
	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	Behaviors []*types.Behavior
}

type ValidateSecurityProfileBehaviorsOutput

type ValidateSecurityProfileBehaviorsOutput struct {
	// True if the behaviors were valid.
	Valid *bool
	// The list of any errors found in the behaviors.
	ValidationErrors []*types.ValidationError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL