iot

package module
v1.61.0 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 47 Imported by: 65

Documentation

Overview

Package iot provides the API client, operations, and parameter types for AWS IoT.

IoT

IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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 Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.

For more information about how IoT works, see the Developer Guide.

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.

Index

Constants

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

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.39.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.44.1 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.44.1 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AcceptCertificateTransferInput 

type AcceptCertificateTransferInput struct {

	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	//
	// This member is required.
	CertificateId *string

	// Specifies whether the certificate is active.
	SetAsActive bool
	// contains filtered or unexported fields
}

The input for the AcceptCertificateTransfer operation.

type AcceptCertificateTransferOutput 

type AcceptCertificateTransferOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AddThingToBillingGroupInput 

type AddThingToBillingGroupInput struct {

	// The ARN of the billing group.
	BillingGroupArn *string

	// The name of the billing group.
	//
	// This call is asynchronous. It might take several seconds for the detachment to
	// propagate.
	BillingGroupName *string

	// The ARN of the thing to be added to the billing group.
	ThingArn *string

	// The name of the thing to be added to the billing group.
	ThingName *string
	// contains filtered or unexported fields
}

type AddThingToBillingGroupOutput 

type AddThingToBillingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AddThingToThingGroupInput 

type AddThingToThingGroupInput 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 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

	// The name of the group to which you are adding a thing.
	ThingGroupName *string

	// The name of the thing to add to a group.
	ThingName *string
	// contains filtered or unexported fields
}

type AddThingToThingGroupOutput 

type AddThingToThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateSbomWithPackageVersionInput added in v1.56.0 

type AssociateSbomWithPackageVersionInput struct {

	// The name of the new software package.
	//
	// This member is required.
	PackageName *string

	// A specific software bill of matrerials associated with a software package
	// version.
	//
	// This member is required.
	Sbom *types.Sbom

	// The name of the new package version.
	//
	// This member is required.
	VersionName *string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string
	// contains filtered or unexported fields
}

type AssociateSbomWithPackageVersionOutput added in v1.56.0 

type AssociateSbomWithPackageVersionOutput struct {

	// The name of the new software package.
	PackageName *string

	// A specific software bill of matrerials associated with a software package
	// version.
	Sbom *types.Sbom

	// The status of the initial validation for the software bill of materials against
	// the Software Package Data Exchange (SPDX) and CycloneDX industry standard
	// formats.
	SbomValidationStatus types.SbomValidationStatus

	// The name of the new package version.
	VersionName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateTargetsWithJobInput 

type AssociateTargetsWithJobInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// This member is required.
	JobId *string

	// A list of thing group ARNs that define the targets of the job.
	//
	// This member is required.
	Targets []string

	// An optional comment string describing why the job was associated with the
	// targets.
	Comment *string

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *string
	// contains filtered or unexported fields
}

type AssociateTargetsWithJobOutput 

type AssociateTargetsWithJobOutput struct {

	// A short text description of the job.
	Description *string

	// An ARN identifying the job.
	JobArn *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
	// contains filtered or unexported fields
}

type AttachPolicyInput 

type AttachPolicyInput struct {

	// The name of the policy to attach.
	//
	// This member is required.
	PolicyName *string

	// The [identity] to which the policy is attached. For example, a thing group or a
	// certificate.
	//
	// [identity]: https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html
	//
	// This member is required.
	Target *string
	// contains filtered or unexported fields
}

type AttachPolicyOutput 

type AttachPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AttachPrincipalPolicyInput 

type AttachPrincipalPolicyInput struct {

	// The policy name.
	//
	// This member is required.
	PolicyName *string

	// The principal, which can be a certificate ARN (as returned from the
	// CreateCertificate operation) or an Amazon Cognito ID.
	//
	// This member is required.
	Principal *string
	// contains filtered or unexported fields
}

The input for the AttachPrincipalPolicy operation.

type AttachPrincipalPolicyOutput 

type AttachPrincipalPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AttachSecurityProfileInput 

type AttachSecurityProfileInput struct {

	// The security profile that is attached.
	//
	// This member is required.
	SecurityProfileName *string

	// The ARN of the target (thing group) to which the security profile is attached.
	//
	// This member is required.
	SecurityProfileTargetArn *string
	// contains filtered or unexported fields
}

type AttachSecurityProfileOutput 

type AttachSecurityProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AttachThingPrincipalInput 

type AttachThingPrincipalInput struct {

	// The principal, which can be a certificate ARN (as returned from the
	// CreateCertificate operation) or an Amazon Cognito ID.
	//
	// This member is required.
	Principal *string

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The type of the relation you want to specify when you attach a principal to a
	// thing.
	//
	//   - EXCLUSIVE_THING - Attaches the specified principal to the specified thing,
	//   exclusively. The thing will be the only thing that’s attached to the principal.
	//
	//   - NON_EXCLUSIVE_THING - Attaches the specified principal to the specified
	//   thing. Multiple things can be attached to the principal.
	ThingPrincipalType types.ThingPrincipalType
	// contains filtered or unexported fields
}

The input for the AttachThingPrincipal operation.

type AttachThingPrincipalOutput 

type AttachThingPrincipalOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the AttachThingPrincipal operation.

type AuthResolverParameters added in v1.44.1 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.44.1 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelAuditMitigationActionsTaskInput 

type CancelAuditMitigationActionsTaskInput struct {

	// The unique identifier for the task that you want to cancel.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type CancelAuditMitigationActionsTaskOutput 

type CancelAuditMitigationActionsTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelAuditTaskInput 

type CancelAuditTaskInput struct {

	// The ID of the audit you want to cancel. You can only cancel an audit that is
	// "IN_PROGRESS".
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type CancelAuditTaskOutput 

type CancelAuditTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelCertificateTransferInput 

type CancelCertificateTransferInput struct {

	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	//
	// This member is required.
	CertificateId *string
	// contains filtered or unexported fields
}

The input for the CancelCertificateTransfer operation.

type CancelCertificateTransferOutput 

type CancelCertificateTransferOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelDetectMitigationActionsTaskInput added in v1.2.0 

type CancelDetectMitigationActionsTaskInput struct {

	//  The unique identifier of the task.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type CancelDetectMitigationActionsTaskOutput added in v1.2.0 

type CancelDetectMitigationActionsTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelJobExecutionInput 

type CancelJobExecutionInput struct {

	// The ID of the job to be canceled.
	//
	// This member is required.
	JobId *string

	// The name of the thing whose execution of the job will be canceled.
	//
	// This member is required.
	ThingName *string

	// (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

	// (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

	// 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
	// contains filtered or unexported fields
}

type CancelJobExecutionOutput 

type CancelJobExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelJobInput 

type CancelJobInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// This member is required.
	JobId *string

	// An optional comment string describing why the job was canceled.
	Comment *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

	// (Optional)A reason code string that explains why the job was canceled.
	ReasonCode *string
	// contains filtered or unexported fields
}

type CancelJobOutput 

type CancelJobOutput struct {

	// A short text description of the job.
	Description *string

	// The job ARN.
	JobArn *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
	// contains filtered or unexported fields
}

type ClearDefaultAuthorizerInput 

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

type ClearDefaultAuthorizerOutput 

type ClearDefaultAuthorizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

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

Client provides the API client to make operations call for AWS IoT.

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.

Requires permission to access the AcceptCertificateTransfer action.

func (*Client) AddThingToBillingGroup 

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

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

func (*Client) AddThingToThingGroup 

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

Adds a thing to a thing group.

Requires permission to access the AddThingToThingGroup action.

func (*Client) AssociateSbomWithPackageVersion added in v1.56.0 

func (c *Client) AssociateSbomWithPackageVersion(ctx context.Context, params *AssociateSbomWithPackageVersionInput, optFns ...func(*Options)) (*AssociateSbomWithPackageVersionOutput, error)

Associates the selected software bill of materials (SBOM) with a specific software package version.

Requires permission to access the AssociateSbomWithPackageVersion action.

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.

Requires permission to access the AssociateTargetsWithJob action.

func (*Client) AttachPolicy 

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

Attaches the specified policy to the specified principal (certificate or other credential).

Requires permission to access the AttachPolicy action.

func (*Client) AttachPrincipalPolicy deprecated 

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 action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicyinstead.

Requires permission to access the AttachPrincipalPolicy action.

Deprecated: This operation has been deprecated.

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.

Requires permission to access the AttachSecurityProfile action.

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, Amazon Cognito identities or federated identities.

Requires permission to access the AttachThingPrincipal action.

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.

Requires permission to access the CancelAuditMitigationActionsTask action.

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 isn't in progress, an "InvalidRequestException" occurs.

Requires permission to access the CancelAuditTask action.

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 RejectCertificateTransferinstead.) After transfer, 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.

Requires permission to access the CancelCertificateTransfer action.

func (*Client) CancelDetectMitigationActionsTask added in v1.2.0 

func (c *Client) CancelDetectMitigationActionsTask(ctx context.Context, params *CancelDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*CancelDetectMitigationActionsTaskOutput, error)
Cancels a Device Defender ML Detect mitigation action.

Requires permission to access the CancelDetectMitigationActionsTask action.

func (*Client) CancelJob 

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

Cancels a job.

Requires permission to access the CancelJob action.

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.

Requires permission to access the CancelJobExecution action.

func (*Client) ClearDefaultAuthorizer 

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

Clears the default authorizer.

Requires permission to access the ClearDefaultAuthorizer action.

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

Requires permission to access the ConfirmTopicRuleDestination action.

func (*Client) CreateAuditSuppression added in v0.29.0 

func (c *Client) CreateAuditSuppression(ctx context.Context, params *CreateAuditSuppressionInput, optFns ...func(*Options)) (*CreateAuditSuppressionOutput, error)
Creates a Device Defender audit suppression.

Requires permission to access the CreateAuditSuppression action.

func (*Client) CreateAuthorizer 

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

Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

func (*Client) CreateBillingGroup 

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

Creates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a ResourceAlreadyExistsException is thrown.

Requires permission to access the CreateBillingGroup action.

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.

Requires permission to access the CreateCertificateFromCsr action.

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, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.

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. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is: 

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the corresponding CSR.

You can also run the aws iot create-certificate-from-csr part of the command in parallel to speed up the certificate creation process: 

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: 

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr
--certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: 

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr
--certificate-signing-request file://@path"

func (*Client) CreateCertificateProvider added in v1.47.0 

func (c *Client) CreateCertificateProvider(ctx context.Context, params *CreateCertificateProviderInput, optFns ...func(*Options)) (*CreateCertificateProviderOutput, error)

Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate providerfrom Amazon Web Services IoT Core Developer Guide.

Requires permission to access the CreateCertificateProvider action.

After you create a certificate provider, the behavior of CreateCertificateFromCsr API for fleet provisioning CreateCertificateFromCsr will change and all API calls to CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can take up to a few minutes for this behavior to change after a certificate provider is created.

func (*Client) CreateCommand added in v1.61.0 

func (c *Client) CreateCommand(ctx context.Context, params *CreateCommandInput, optFns ...func(*Options)) (*CreateCommandOutput, error)

Creates a command. A command contains reusable configurations that can be applied before they are sent to the devices.

func (*Client) CreateCustomMetric added in v1.2.0 

func (c *Client) CreateCustomMetric(ctx context.Context, params *CreateCustomMetricInput, optFns ...func(*Options)) (*CreateCustomMetricOutput, error)
Use this API to define a Custom Metric published by your devices to Device

Defender.

Requires permission to access the CreateCustomMetric action.

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

Requires permission to access the CreateDimension action.

func (*Client) CreateDomainConfiguration 

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

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration action.

func (*Client) CreateDynamicThingGroup 

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

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

func (*Client) CreateFleetMetric added in v1.11.0 

func (c *Client) CreateFleetMetric(ctx context.Context, params *CreateFleetMetricInput, optFns ...func(*Options)) (*CreateFleetMetricOutput, error)

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

func (*Client) CreateJob 

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

Creates a job.

Requires permission to access the CreateJob action.

func (*Client) CreateJobTemplate added in v1.6.0 

func (c *Client) CreateJobTemplate(ctx context.Context, params *CreateJobTemplateInput, optFns ...func(*Options)) (*CreateJobTemplateOutput, error)

Creates a job template.

Requires permission to access the CreateJobTemplate action.

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.

Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.

Requires permission to access the CreateKeysAndCertificate action.

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. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

Requires permission to access the CreateMitigationAction action.

func (*Client) CreateOTAUpdate 

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

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

func (*Client) CreatePackage added in v1.38.0 

func (c *Client) CreatePackage(ctx context.Context, params *CreatePackageInput, optFns ...func(*Options)) (*CreatePackageOutput, error)

Creates an IoT software package that can be deployed to your fleet.

Requires permission to access the CreatePackage and GetIndexingConfiguration actions.

func (*Client) CreatePackageVersion added in v1.38.0 

func (c *Client) CreatePackageVersion(ctx context.Context, params *CreatePackageVersionInput, optFns ...func(*Options)) (*CreatePackageVersionOutput, error)

Creates a new version for an existing IoT software package.

Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.

func (*Client) CreatePolicy 

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

Creates an 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.

Requires permission to access the CreatePolicy action.

func (*Client) CreatePolicyVersion 

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

Creates a new version of the specified 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 DeletePolicyVersionto 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).

Requires permission to access the CreatePolicyVersion action.

func (*Client) CreateProvisioningClaim 

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

Creates a provisioning claim.

Requires permission to access the CreateProvisioningClaim action.

func (*Client) CreateProvisioningTemplate 

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

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

func (*Client) CreateProvisioningTemplateVersion 

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

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

func (*Client) CreateRoleAlias 

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

Creates a role alias.

Requires permission to access the CreateRoleAlias action.

The value of credentialDurationSecondscredentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API)from the Amazon Web Services Identity and Access Management User Guide.

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.

Requires permission to access the CreateScheduledAudit action.

func (*Client) CreateSecurityProfile 

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

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

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.

Requires permission to access the CreateStream action.

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 for information about authorizing control plane actions.

Requires permission to access the CreateThing action.

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 for information about authorizing control plane actions.

If the ThingGroup that you create has the exact same attributes as an existing ThingGroup , you will get a 200 success response.

Requires permission to access the CreateThingGroup action.

func (*Client) CreateThingType 

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

Creates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a ResourceAlreadyExistsException is thrown.

Requires permission to access the CreateThingType action.

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.

Requires permission to access the CreateTopicRule action.

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.

Requires permission to access the CreateTopicRuleDestination action.

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.

Requires permission to access the DeleteAccountAuditConfiguration action.

func (*Client) DeleteAuditSuppression added in v0.29.0 

func (c *Client) DeleteAuditSuppression(ctx context.Context, params *DeleteAuditSuppressionInput, optFns ...func(*Options)) (*DeleteAuditSuppressionOutput, error)
Deletes a Device Defender audit suppression.

Requires permission to access the DeleteAuditSuppression action.

func (*Client) DeleteAuthorizer 

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

Deletes an authorizer.

Requires permission to access the DeleteAuthorizer action.

func (*Client) DeleteBillingGroup 

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

Deletes the billing group.

Requires permission to access the DeleteBillingGroup action.

func (*Client) DeleteCACertificate 

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

Deletes a registered CA certificate.

Requires permission to access the DeleteCACertificate action.

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 DetachPolicy action to detach all policies. Next, use the UpdateCertificateaction to set the certificate to the INACTIVE status.

Requires permission to access the DeleteCertificate action.

func (*Client) DeleteCertificateProvider added in v1.47.0 

func (c *Client) DeleteCertificateProvider(ctx context.Context, params *DeleteCertificateProviderInput, optFns ...func(*Options)) (*DeleteCertificateProviderOutput, error)

Deletes a certificate provider.

Requires permission to access the DeleteCertificateProvider action.

If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).

func (*Client) DeleteCommand added in v1.61.0 

func (c *Client) DeleteCommand(ctx context.Context, params *DeleteCommandInput, optFns ...func(*Options)) (*DeleteCommandOutput, error)

Delete a command resource.

func (*Client) DeleteCommandExecution added in v1.61.0 

func (c *Client) DeleteCommandExecution(ctx context.Context, params *DeleteCommandExecutionInput, optFns ...func(*Options)) (*DeleteCommandExecutionOutput, error)

Delete a command execution.

Only command executions that enter a terminal state can be deleted from your account.

func (*Client) DeleteCustomMetric added in v1.2.0 

func (c *Client) DeleteCustomMetric(ctx context.Context, params *DeleteCustomMetricInput, optFns ...func(*Options)) (*DeleteCustomMetricOutput, error)
Deletes a Device Defender detect custom metric.

Requires permission to access the DeleteCustomMetric action.

Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a part of. The security profile associated with the custom metric can be found using the ListSecurityProfilesAPI with metricName set to your custom metric name.

func (*Client) DeleteDimension 

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

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension action.

func (*Client) DeleteDomainConfiguration 

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

Deletes the specified domain configuration.

Requires permission to access the DeleteDomainConfiguration action.

func (*Client) DeleteDynamicThingGroup 

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

Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup action.

func (*Client) DeleteFleetMetric added in v1.11.0 

func (c *Client) DeleteFleetMetric(ctx context.Context, params *DeleteFleetMetricInput, optFns ...func(*Options)) (*DeleteFleetMetricOutput, error)

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

Requires permission to access the DeleteFleetMetric action.

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.

Requires permission to access the DeleteJob action.

func (*Client) DeleteJobExecution 

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

Deletes a job execution.

Requires permission to access the DeleteJobExecution action.

func (*Client) DeleteJobTemplate added in v1.6.0 

func (c *Client) DeleteJobTemplate(ctx context.Context, params *DeleteJobTemplateInput, optFns ...func(*Options)) (*DeleteJobTemplateOutput, error)

Deletes the specified job template.

func (*Client) DeleteMitigationAction 

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

Deletes a defined mitigation action from your Amazon Web Services accounts.

Requires permission to access the DeleteMitigationAction action.

func (*Client) DeleteOTAUpdate 

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

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

func (*Client) DeletePackage added in v1.38.0 

func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error)

Deletes a specific version from a software package.

Note: All package versions must be deleted before deleting the software package.

Requires permission to access the DeletePackageVersion action.

func (*Client) DeletePackageVersion added in v1.38.0 

func (c *Client) DeletePackageVersion(ctx context.Context, params *DeletePackageVersionInput, optFns ...func(*Options)) (*DeletePackageVersionOutput, error)

Deletes a specific version from a software package.

Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackageaction.

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 action to delete all non-default versions of the policy; use the DetachPolicyaction to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DeletePolicy action.

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

Requires permission to access the DeletePolicyVersion action.

func (*Client) DeleteProvisioningTemplate 

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

Deletes a provisioning template.

Requires permission to access the DeleteProvisioningTemplate action.

func (*Client) DeleteProvisioningTemplateVersion 

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

Deletes a provisioning template version.

Requires permission to access the DeleteProvisioningTemplateVersion action.

func (*Client) DeleteRegistrationCode 

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

Deletes a CA certificate registration code.

Requires permission to access the DeleteRegistrationCode action.

func (*Client) DeleteRoleAlias 

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

Deletes a role alias

Requires permission to access the DeleteRoleAlias action.

func (*Client) DeleteScheduledAudit 

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

Deletes a scheduled audit.

Requires permission to access the DeleteScheduledAudit action.

func (*Client) DeleteSecurityProfile 

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

Deletes a Device Defender security profile.

Requires permission to access the DeleteSecurityProfile action.

func (*Client) DeleteStream 

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

Deletes a stream.

Requires permission to access the DeleteStream action.

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.

Requires permission to access the DeleteThing action.

func (*Client) DeleteThingGroup 

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

Deletes a thing group.

Requires permission to access the DeleteThingGroup action.

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 DeleteThingTypeto delete the thing type.

Requires permission to access the DeleteThingType action.

func (*Client) DeleteTopicRule 

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

Deletes the rule.

Requires permission to access the DeleteTopicRule action.

func (*Client) DeleteTopicRuleDestination 

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

Deletes a topic rule destination.

Requires permission to access the DeleteTopicRuleDestination action.

func (*Client) DeleteV2LoggingLevel 

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

Deletes a logging level.

Requires permission to access the DeleteV2LoggingLevel action.

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.

Requires permission to access the DeprecateThingType action.

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.

Requires permission to access the DescribeAccountAuditConfiguration action.

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 the start time when the audit that returned the finding.

Requires permission to access the DescribeAuditFinding action.

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) DescribeAuditSuppression added in v0.29.0 

func (c *Client) DescribeAuditSuppression(ctx context.Context, params *DescribeAuditSuppressionInput, optFns ...func(*Options)) (*DescribeAuditSuppressionOutput, error)

Gets information about a Device Defender audit suppression.

func (*Client) DescribeAuditTask 

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

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

func (*Client) DescribeAuthorizer 

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

Describes an authorizer.

Requires permission to access the DescribeAuthorizer action.

func (*Client) DescribeBillingGroup 

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

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

func (*Client) DescribeCACertificate 

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

Describes a registered CA certificate.

Requires permission to access the DescribeCACertificate action.

func (*Client) DescribeCertificate 

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

Gets information about the specified certificate.

Requires permission to access the DescribeCertificate action.

func (*Client) DescribeCertificateProvider added in v1.47.0 

func (c *Client) DescribeCertificateProvider(ctx context.Context, params *DescribeCertificateProviderInput, optFns ...func(*Options)) (*DescribeCertificateProviderOutput, error)

Describes a certificate provider.

Requires permission to access the DescribeCertificateProvider action.

func (*Client) DescribeCustomMetric added in v1.2.0 

func (c *Client) DescribeCustomMetric(ctx context.Context, params *DescribeCustomMetricInput, optFns ...func(*Options)) (*DescribeCustomMetricOutput, error)
Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

func (*Client) DescribeDefaultAuthorizer 

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

Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer action.

func (*Client) DescribeDetectMitigationActionsTask added in v1.2.0 

func (c *Client) DescribeDetectMitigationActionsTask(ctx context.Context, params *DescribeDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*DescribeDetectMitigationActionsTaskOutput, error)
Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

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 Amazon Web Services accounts.

Requires permission to access the DescribeDimension action.

func (*Client) DescribeDomainConfiguration 

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

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

func (*Client) DescribeEndpoint 

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

Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.

The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint.

Requires permission to access the DescribeEndpoint action.

func (*Client) DescribeEventConfigurations 

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

Describes event configurations.

Requires permission to access the DescribeEventConfigurations action.

func (*Client) DescribeFleetMetric added in v1.11.0 

func (c *Client) DescribeFleetMetric(ctx context.Context, params *DescribeFleetMetricInput, optFns ...func(*Options)) (*DescribeFleetMetricOutput, error)

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

func (*Client) DescribeIndex 

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

Describes a search index.

Requires permission to access the DescribeIndex action.

func (*Client) DescribeJob 

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

Describes a job.

Requires permission to access the DescribeJob action.

func (*Client) DescribeJobExecution 

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

Describes a job execution.

Requires permission to access the DescribeJobExecution action.

func (*Client) DescribeJobTemplate added in v1.6.0 

func (c *Client) DescribeJobTemplate(ctx context.Context, params *DescribeJobTemplateInput, optFns ...func(*Options)) (*DescribeJobTemplateOutput, error)

Returns information about a job template.

func (*Client) DescribeManagedJobTemplate added in v1.17.0 

func (c *Client) DescribeManagedJobTemplate(ctx context.Context, params *DescribeManagedJobTemplateInput, optFns ...func(*Options)) (*DescribeManagedJobTemplateOutput, error)

View details of a managed job template.

func (*Client) DescribeMitigationAction 

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

Gets information about a mitigation action.

Requires permission to access the DescribeMitigationAction action.

func (*Client) DescribeProvisioningTemplate 

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

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

func (*Client) DescribeProvisioningTemplateVersion 

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

Returns information about a provisioning template version.

Requires permission to access the DescribeProvisioningTemplateVersion action.

func (*Client) DescribeRoleAlias 

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

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

func (*Client) DescribeScheduledAudit 

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

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit action.

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.

Requires permission to access the DescribeSecurityProfile action.

func (*Client) DescribeStream 

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

Gets information about a stream.

Requires permission to access the DescribeStream action.

func (*Client) DescribeThing 

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

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

func (*Client) DescribeThingGroup 

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

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

func (*Client) DescribeThingRegistrationTask 

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

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

func (*Client) DescribeThingType 

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

Gets information about the specified thing type.

Requires permission to access the DescribeThingType action.

func (*Client) DetachPolicy 

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

Detaches a policy from the specified target.

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DetachPolicy action.

func (*Client) DetachPrincipalPolicy deprecated 

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

Removes the specified policy from the specified certificate.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicyinstead.

Requires permission to access the DetachPrincipalPolicy action.

Deprecated: This operation has been deprecated.

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.

Requires permission to access the DetachSecurityProfile action.

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.

Requires permission to access the DetachThingPrincipal action.

func (*Client) DisableTopicRule 

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

Disables the rule.

Requires permission to access the DisableTopicRule action.

func (*Client) DisassociateSbomFromPackageVersion added in v1.56.0 

func (c *Client) DisassociateSbomFromPackageVersion(ctx context.Context, params *DisassociateSbomFromPackageVersionInput, optFns ...func(*Options)) (*DisassociateSbomFromPackageVersionOutput, error)

Disassociates the selected software bill of materials (SBOM) from a specific software package version.

Requires permission to access the DisassociateSbomWithPackageVersion action.

func (*Client) EnableTopicRule 

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

Enables the rule.

Requires permission to access the EnableTopicRule action.

func (*Client) GetBehaviorModelTrainingSummaries added in v1.2.0 

func (c *Client) GetBehaviorModelTrainingSummaries(ctx context.Context, params *GetBehaviorModelTrainingSummariesInput, optFns ...func(*Options)) (*GetBehaviorModelTrainingSummariesOutput, error)
Returns a Device Defender's ML Detect Security Profile training model's

status.

Requires permission to access the GetBehaviorModelTrainingSummaries action.

func (*Client) GetBucketsAggregation added in v1.11.0 

func (c *Client) GetBucketsAggregation(ctx context.Context, params *GetBucketsAggregationInput, optFns ...func(*Options)) (*GetBucketsAggregationOutput, error)

Aggregates on indexed data with search queries pertaining to particular fields.

Requires permission to access the GetBucketsAggregation action.

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.

Requires permission to access the GetCardinality action.

func (*Client) GetCommand added in v1.61.0 

func (c *Client) GetCommand(ctx context.Context, params *GetCommandInput, optFns ...func(*Options)) (*GetCommandOutput, error)

Gets information about the specified command.

func (*Client) GetCommandExecution added in v1.61.0 

func (c *Client) GetCommandExecution(ctx context.Context, params *GetCommandExecutionInput, optFns ...func(*Options)) (*GetCommandExecutionOutput, error)

Gets information about the specific command execution on a single device.

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 IoT device gateway.

Requires permission to access the GetEffectivePolicies action.

func (*Client) GetIndexingConfiguration 

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

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

func (*Client) GetJobDocument 

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

Gets a job document.

Requires permission to access the GetJobDocument action.

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.

Requires permission to access the GetLoggingOptions action.

func (*Client) GetOTAUpdate 

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

Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

func (*Client) GetPackage added in v1.38.0 

func (c *Client) GetPackage(ctx context.Context, params *GetPackageInput, optFns ...func(*Options)) (*GetPackageOutput, error)

Gets information about the specified software package.

Requires permission to access the GetPackage action.

func (*Client) GetPackageConfiguration added in v1.38.0 

func (c *Client) GetPackageConfiguration(ctx context.Context, params *GetPackageConfigurationInput, optFns ...func(*Options)) (*GetPackageConfigurationOutput, error)

Gets information about the specified software package's configuration.

Requires permission to access the GetPackageConfiguration action.

func (*Client) GetPackageVersion added in v1.38.0 

func (c *Client) GetPackageVersion(ctx context.Context, params *GetPackageVersionInput, optFns ...func(*Options)) (*GetPackageVersionOutput, error)

Gets information about the specified package version.

Requires permission to access the GetPackageVersion action.

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.

Requires permission to access the GetPercentiles action.

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.

Requires permission to access the GetPolicy action.

func (*Client) GetPolicyVersion 

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

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

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

IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code.

Requires permission to access the GetRegistrationCode action.

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.

Requires permission to access the GetStatistics action.

func (*Client) GetTopicRule 

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

Gets information about the rule.

Requires permission to access the GetTopicRule action.

func (*Client) GetTopicRuleDestination 

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

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

func (*Client) GetV2LoggingOptions 

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

Gets the fine grained logging options.

Requires permission to access the GetV2LoggingOptions action.

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.

Requires permission to access the ListActiveViolations action.

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.

Requires permission to access the ListAttachedPolicies action.

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

Requires permission to access the ListAuditFindings action.

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.

Requires permission to access the ListAuditMitigationActionsExecutions action.

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.

Requires permission to access the ListAuditMitigationActionsTasks action.

func (*Client) ListAuditSuppressions added in v0.29.0 

func (c *Client) ListAuditSuppressions(ctx context.Context, params *ListAuditSuppressionsInput, optFns ...func(*Options)) (*ListAuditSuppressionsOutput, error)
Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

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.

Requires permission to access the ListAuditTasks action.

func (*Client) ListAuthorizers 

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

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

func (*Client) ListBillingGroups 

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

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

func (*Client) ListCACertificates 

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

Lists the CA certificates registered for your Amazon Web Services account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Requires permission to access the ListCACertificates action.

func (*Client) ListCertificateProviders added in v1.47.0 

func (c *Client) ListCertificateProviders(ctx context.Context, params *ListCertificateProvidersInput, optFns ...func(*Options)) (*ListCertificateProvidersOutput, error)

Lists all your certificate providers in your Amazon Web Services account.

Requires permission to access the ListCertificateProviders action.

func (*Client) ListCertificates 

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

Lists the certificates registered in your Amazon Web Services account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Requires permission to access the ListCertificates action.

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.

Requires permission to access the ListCertificatesByCA action.

func (*Client) ListCommandExecutions added in v1.61.0 

func (c *Client) ListCommandExecutions(ctx context.Context, params *ListCommandExecutionsInput, optFns ...func(*Options)) (*ListCommandExecutionsOutput, error)

List all command executions.

You must provide only the startedTimeFilter or the completedTimeFilter information. If you provide both time filters, the API will generate an error. You can use this information to find command executions that started within a specific timeframe.

func (*Client) ListCommands added in v1.61.0 

func (c *Client) ListCommands(ctx context.Context, params *ListCommandsInput, optFns ...func(*Options)) (*ListCommandsOutput, error)

List all commands in your account.

func (*Client) ListCustomMetrics added in v1.2.0 

func (c *Client) ListCustomMetrics(ctx context.Context, params *ListCustomMetricsInput, optFns ...func(*Options)) (*ListCustomMetricsOutput, error)
Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

func (*Client) ListDetectMitigationActionsExecutions added in v1.2.0 

func (c *Client) ListDetectMitigationActionsExecutions(ctx context.Context, params *ListDetectMitigationActionsExecutionsInput, optFns ...func(*Options)) (*ListDetectMitigationActionsExecutionsOutput, error)
Lists mitigation actions executions for a Device Defender ML Detect Security

Profile.

Requires permission to access the ListDetectMitigationActionsExecutions action.

func (*Client) ListDetectMitigationActionsTasks added in v1.2.0 

func (c *Client) ListDetectMitigationActionsTasks(ctx context.Context, params *ListDetectMitigationActionsTasksInput, optFns ...func(*Options)) (*ListDetectMitigationActionsTasksOutput, error)
List of Device Defender ML Detect mitigation actions tasks.

Requires permission to access the ListDetectMitigationActionsTasks action.

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 Amazon Web Services accounts.

Requires permission to access the ListDimensions action.

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.

Requires permission to access the ListDomainConfigurations action.

func (*Client) ListFleetMetrics added in v1.11.0 

func (c *Client) ListFleetMetrics(ctx context.Context, params *ListFleetMetricsInput, optFns ...func(*Options)) (*ListFleetMetricsOutput, error)

Lists all your fleet metrics.

Requires permission to access the ListFleetMetrics action.

func (*Client) ListIndices 

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

Lists the search indices.

Requires permission to access the ListIndices action.

func (*Client) ListJobExecutionsForJob 

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

Lists the job executions for a job.

Requires permission to access the ListJobExecutionsForJob action.

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.

Requires permission to access the ListJobExecutionsForThing action.

func (*Client) ListJobTemplates added in v1.6.0 

func (c *Client) ListJobTemplates(ctx context.Context, params *ListJobTemplatesInput, optFns ...func(*Options)) (*ListJobTemplatesOutput, error)

Returns a list of job templates.

Requires permission to access the ListJobTemplates action.

func (*Client) ListJobs 

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

Lists jobs.

Requires permission to access the ListJobs action.

func (*Client) ListManagedJobTemplates added in v1.17.0 

func (c *Client) ListManagedJobTemplates(ctx context.Context, params *ListManagedJobTemplatesInput, optFns ...func(*Options)) (*ListManagedJobTemplatesOutput, error)

Returns a list of managed job templates.

func (*Client) ListMetricValues added in v1.24.0 

func (c *Client) ListMetricValues(ctx context.Context, params *ListMetricValuesInput, optFns ...func(*Options)) (*ListMetricValuesOutput, error)

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

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.

Requires permission to access the ListMitigationActions action.

func (*Client) ListOTAUpdates 

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

Lists OTA updates.

Requires permission to access the ListOTAUpdates action.

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.

Requires permission to access the ListOutgoingCertificates action.

func (*Client) ListPackageVersions added in v1.38.0 

func (c *Client) ListPackageVersions(ctx context.Context, params *ListPackageVersionsInput, optFns ...func(*Options)) (*ListPackageVersionsOutput, error)

Lists the software package versions associated to the account.

Requires permission to access the ListPackageVersions action.

func (*Client) ListPackages added in v1.38.0 

func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, optFns ...func(*Options)) (*ListPackagesOutput, error)

Lists the software packages associated to the account.

Requires permission to access the ListPackages action.

func (*Client) ListPolicies 

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

Lists your policies.

Requires permission to access the ListPolicies action.

func (*Client) ListPolicyPrincipals deprecated 

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

Lists the principals associated with the specified policy.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicyinstead.

Requires permission to access the ListPolicyPrincipals action.

Deprecated: This operation has been deprecated.

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.

Requires permission to access the ListPolicyVersions action.

func (*Client) ListPrincipalPolicies deprecated 

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.

Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPoliciesinstead.

Requires permission to access the ListPrincipalPolicies action.

Deprecated: This operation has been deprecated.

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.

Requires permission to access the ListPrincipalThings action.

func (*Client) ListPrincipalThingsV2 added in v1.60.0 

func (c *Client) ListPrincipalThingsV2(ctx context.Context, params *ListPrincipalThingsV2Input, optFns ...func(*Options)) (*ListPrincipalThingsV2Output, error)

Lists the things associated with the specified principal. A principal can be an X.509 certificate or an Amazon Cognito ID.

Requires permission to access the ListPrincipalThings action.

func (*Client) ListProvisioningTemplateVersions 

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

A list of provisioning template versions.

Requires permission to access the ListProvisioningTemplateVersions action.

func (*Client) ListProvisioningTemplates 

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

Lists the provisioning templates in your Amazon Web Services account.

Requires permission to access the ListProvisioningTemplates action.

func (*Client) ListRelatedResourcesForAuditFinding added in v1.31.0 

func (c *Client) ListRelatedResourcesForAuditFinding(ctx context.Context, params *ListRelatedResourcesForAuditFindingInput, optFns ...func(*Options)) (*ListRelatedResourcesForAuditFindingOutput, error)

The related resources of an Audit finding. The following resources can be returned from calling this API:

  • DEVICE_CERTIFICATE

  • CA_CERTIFICATE

  • IOT_POLICY

  • COGNITO_IDENTITY_POOL

  • CLIENT_ID

  • ACCOUNT_SETTINGS

  • ROLE_ALIAS

  • IAM_ROLE

  • ISSUER_CERTIFICATE

This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFindingfor the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

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.

Requires permission to access the ListRoleAliases action.

func (*Client) ListSbomValidationResults added in v1.56.0 

func (c *Client) ListSbomValidationResults(ctx context.Context, params *ListSbomValidationResultsInput, optFns ...func(*Options)) (*ListSbomValidationResultsOutput, error)

The validation results for all software bill of materials (SBOM) attached to a specific software package version.

Requires permission to access the ListSbomValidationResults action.

func (*Client) ListScheduledAudits 

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

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

func (*Client) ListSecurityProfiles 

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

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

Requires permission to access the ListSecurityProfiles action.

dimensionName and metricName cannot be used in the same request.

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

Requires permission to access the ListSecurityProfilesForTarget action.

func (*Client) ListStreams 

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

Lists all of the streams in your Amazon Web Services account.

Requires permission to access the ListStreams action.

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.

Requires permission to access the ListTagsForResource action.

func (*Client) ListTargetsForPolicy 

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

List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy action.

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.

Requires permission to access the ListTargetsForSecurityProfile action.

func (*Client) ListThingGroups 

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

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

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.

Requires permission to access the ListThingGroupsForThing action.

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.

Requires permission to access the ListThingPrincipals action.

func (*Client) ListThingPrincipalsV2 added in v1.60.0 

func (c *Client) ListThingPrincipalsV2(ctx context.Context, params *ListThingPrincipalsV2Input, optFns ...func(*Options)) (*ListThingPrincipalsV2Output, error)

Lists the principals associated with the specified thing. A principal can be an X.509 certificate or an Amazon Cognito ID.

Requires permission to access the ListThingPrincipals action.

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.

Requires permission to access the ListThingRegistrationTasks action.

func (*Client) ListThingTypes 

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

Lists the existing thing types.

Requires permission to access the ListThingTypes action.

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. For more information, see List Thingsfrom the Amazon Web Services IoT Core Developer Guide.

Requires permission to access the ListThings action.

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

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.

Requires permission to access the ListThingsInBillingGroup action.

func (*Client) ListThingsInThingGroup 

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

Lists the things in the specified group.

Requires permission to access the ListThingsInThingGroup action.

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 Amazon Web Services account.

Requires permission to access the ListTopicRuleDestinations action.

func (*Client) ListTopicRules 

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

Lists the rules for the specific topic.

Requires permission to access the ListTopicRules action.

func (*Client) ListV2LoggingLevels 

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

Lists logging levels.

Requires permission to access the ListV2LoggingLevels action.

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

Requires permission to access the ListViolationEvents action.

func (*Client) Options added in v1.46.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutVerificationStateOnViolation added in v1.13.0 

func (c *Client) PutVerificationStateOnViolation(ctx context.Context, params *PutVerificationStateOnViolationInput, optFns ...func(*Options)) (*PutVerificationStateOnViolationOutput, error)

Set a verification state and provide a description of that verification state on a violation (detect alarm).

func (*Client) RegisterCACertificate 

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

Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

Requires permission to access the RegisterCACertificate action.

func (*Client) RegisterCertificate 

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

Registers a device certificate with IoT in the same certificate mode as the signing CA. 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.

Requires permission to access the RegisterCertificate action.

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). For supported certificates, consult Certificate signing algorithms supported by IoT.

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 IoT control plane APIs. These calls might exceed your account level IoT Throttling Limitsand cause throttle errors. Please contact Amazon Web Services Customer Supportto raise your throttling limits if necessary.

Requires permission to access the RegisterThing action.

func (*Client) RejectCertificateTransfer 

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

Rejects a pending certificate transfer. After 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.

Requires permission to access the RejectCertificateTransfer action.

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.

Requires permission to access the RemoveThingFromBillingGroup action.

This call is asynchronous. It might take several seconds for the detachment to propagate.

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.

Requires permission to access the RemoveThingFromThingGroup action.

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.

Requires permission to access the ReplaceTopicRule action.

func (*Client) SearchIndex 

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

The query search index.

Requires permission to access the SearchIndex action.

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.

Requires permission to access the SetDefaultAuthorizer action.

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

Requires permission to access the SetDefaultPolicyVersion action.

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.

Requires permission to access the SetLoggingOptions action.

func (*Client) SetV2LoggingLevel 

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

Sets the logging level.

Requires permission to access the SetV2LoggingLevel action.

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.

Requires permission to access the SetV2LoggingOptions action.

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.

Requires permission to access the StartAuditMitigationActionsTask action.

func (*Client) StartDetectMitigationActionsTask added in v1.2.0 

func (c *Client) StartDetectMitigationActionsTask(ctx context.Context, params *StartDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*StartDetectMitigationActionsTaskOutput, error)
Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

func (*Client) StartOnDemandAuditTask 

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

Starts an on-demand Device Defender audit.

Requires permission to access the StartOnDemandAuditTask action.

func (*Client) StartThingRegistrationTask 

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

Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask action.

func (*Client) StopThingRegistrationTask 

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

Cancels a bulk thing provisioning task.

Requires permission to access the StopThingRegistrationTask action.

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.

Requires permission to access the TagResource action.

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 IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

Requires permission to access the TestAuthorization action.

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 IoT device gateway.

Requires permission to access the TestInvokeAuthorizer action.

func (*Client) TransferCertificate 

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

Transfers the specified certificate to the specified Amazon Web Services account.

Requires permission to access the TransferCertificate action.

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 UpdateCertificateaction to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPolicy action 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.

Requires permission to access the UntagResource action.

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.

Requires permission to access the UpdateAccountAuditConfiguration action.

func (*Client) UpdateAuditSuppression added in v0.29.0 

func (c *Client) UpdateAuditSuppression(ctx context.Context, params *UpdateAuditSuppressionInput, optFns ...func(*Options)) (*UpdateAuditSuppressionOutput, error)

Updates a Device Defender audit suppression.

func (*Client) UpdateAuthorizer 

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

Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

func (*Client) UpdateBillingGroup 

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

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

func (*Client) UpdateCACertificate 

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

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

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.

Requires permission to access the UpdateCertificate action.

Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

func (*Client) UpdateCertificateProvider added in v1.47.0 

func (c *Client) UpdateCertificateProvider(ctx context.Context, params *UpdateCertificateProviderInput, optFns ...func(*Options)) (*UpdateCertificateProviderOutput, error)

Updates a certificate provider.

Requires permission to access the UpdateCertificateProvider action.

func (*Client) UpdateCommand added in v1.61.0 

func (c *Client) UpdateCommand(ctx context.Context, params *UpdateCommandInput, optFns ...func(*Options)) (*UpdateCommandOutput, error)

Update information about a command or mark a command for deprecation.

func (*Client) UpdateCustomMetric added in v1.2.0 

func (c *Client) UpdateCustomMetric(ctx context.Context, params *UpdateCustomMetricInput, optFns ...func(*Options)) (*UpdateCustomMetricOutput, error)

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

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

Requires permission to access the UpdateDimension action.

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.

Requires permission to access the UpdateDomainConfiguration action.

func (*Client) UpdateDynamicThingGroup 

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

Updates a dynamic thing group.

Requires permission to access the UpdateDynamicThingGroup action.

func (*Client) UpdateEventConfigurations 

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

Updates the event configurations.

Requires permission to access the UpdateEventConfigurations action.

func (*Client) UpdateFleetMetric added in v1.11.0 

func (c *Client) UpdateFleetMetric(ctx context.Context, params *UpdateFleetMetricInput, optFns ...func(*Options)) (*UpdateFleetMetricOutput, error)

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

func (*Client) UpdateIndexingConfiguration 

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

Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration action.

func (*Client) UpdateJob 

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

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

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.

Requires permission to access the UpdateMitigationAction action.

func (*Client) UpdatePackage added in v1.38.0 

func (c *Client) UpdatePackage(ctx context.Context, params *UpdatePackageInput, optFns ...func(*Options)) (*UpdatePackageOutput, error)

Updates the supported fields for a specific software package.

Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.

func (*Client) UpdatePackageConfiguration added in v1.38.0 

func (c *Client) UpdatePackageConfiguration(ctx context.Context, params *UpdatePackageConfigurationInput, optFns ...func(*Options)) (*UpdatePackageConfigurationOutput, error)

Updates the software package configuration.

Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.

func (*Client) UpdatePackageVersion added in v1.38.0 

func (c *Client) UpdatePackageVersion(ctx context.Context, params *UpdatePackageVersionInput, optFns ...func(*Options)) (*UpdatePackageVersionOutput, error)

Updates the supported fields for a specific package version.

Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

func (*Client) UpdateProvisioningTemplate 

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

Updates a provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

func (*Client) UpdateRoleAlias 

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

Updates a role alias.

Requires permission to access the UpdateRoleAlias action.

The value of credentialDurationSecondscredentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API)from the Amazon Web Services Identity and Access Management User Guide.

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.

Requires permission to access the UpdateScheduledAudit action.

func (*Client) UpdateSecurityProfile 

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

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

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.

Requires permission to access the UpdateStream action.

func (*Client) UpdateThing 

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

Updates the data for a thing.

Requires permission to access the UpdateThing action.

func (*Client) UpdateThingGroup 

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

Update a thing group.

Requires permission to access the UpdateThingGroup action.

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.

Requires permission to access the UpdateThingGroupsForThing action.

func (*Client) UpdateThingType added in v1.60.0 

func (c *Client) UpdateThingType(ctx context.Context, params *UpdateThingTypeInput, optFns ...func(*Options)) (*UpdateThingTypeOutput, error)

Updates a thing type.

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.

Requires permission to access the UpdateTopicRuleDestination action.

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.

Requires permission to access the ValidateSecurityProfileBehaviors action.

type ConfirmTopicRuleDestinationInput 

type ConfirmTopicRuleDestinationInput struct {

	// The token used to confirm ownership or access to the topic rule confirmation
	// URL.
	//
	// This member is required.
	ConfirmationToken *string
	// contains filtered or unexported fields
}

type ConfirmTopicRuleDestinationOutput 

type ConfirmTopicRuleDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAuditSuppressionInput added in v0.29.0 

type CreateAuditSuppressionInput struct {

	// An audit check name. 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.)
	//
	// This member is required.
	CheckName *string

	//  Each audit supression must have a unique client request token. If you try to
	// create a new audit suppression with the same token as one that already exists,
	// an exception occurs. If you omit this value, Amazon Web Services SDKs will
	// automatically generate a unique client request.
	//
	// This member is required.
	ClientRequestToken *string

	// Information that identifies the noncompliant resource.
	//
	// This member is required.
	ResourceIdentifier *types.ResourceIdentifier

	//  The description of the audit suppression.
	Description *string

	//  The epoch timestamp in seconds at which this suppression expires.
	ExpirationDate *time.Time

	//  Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool
	// contains filtered or unexported fields
}

type CreateAuditSuppressionOutput added in v0.29.0 

type CreateAuditSuppressionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAuthorizerInput 

type CreateAuthorizerInput struct {

	// The ARN of the authorizer's Lambda function.
	//
	// This member is required.
	AuthorizerFunctionArn *string

	// The authorizer name.
	//
	// This member is required.
	AuthorizerName *string

	// When true , the result from the authorizer’s Lambda function is cached for
	// clients that use persistent HTTP connections. The results are cached for the
	// time specified by the Lambda function in refreshAfterInSeconds . This value does
	// not affect authorization of clients that use MQTT connections.
	//
	// The default value is false .
	EnableCachingForHttp *bool

	// Specifies whether IoT validates the token signature in an authorization request.
	SigningDisabled *bool

	// The status of the create authorizer request.
	Status types.AuthorizerStatus

	// 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

	// The name of the token key used to extract the token from the HTTP headers.
	TokenKeyName *string

	// The public keys used to verify the digital signature returned by your custom
	// authentication service.
	TokenSigningPublicKeys map[string]string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateBillingGroupInput 

type CreateBillingGroupInput struct {

	// The name you wish to give to the billing group.
	//
	// This member is required.
	BillingGroupName *string

	// The properties of the billing group.
	BillingGroupProperties *types.BillingGroupProperties

	// Metadata which can be used to manage the billing group.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateBillingGroupOutput 

type CreateBillingGroupOutput struct {

	// The ARN of the billing group.
	BillingGroupArn *string

	// The ID of the billing group.
	BillingGroupId *string

	// The name you gave to the billing group.
	BillingGroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCertificateFromCsrInput 

type CreateCertificateFromCsrInput struct {

	// The certificate signing request (CSR).
	//
	// This member is required.
	CertificateSigningRequest *string

	// Specifies whether the certificate is active.
	SetAsActive bool
	// contains filtered or unexported fields
}

The input for the CreateCertificateFromCsr operation.

type CreateCertificateFromCsrOutput 

type CreateCertificateFromCsrOutput struct {

	// The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a
	// principal for policy operations.
	CertificateArn *string

	// The ID of the certificate. Certificate management operations only take a
	// certificateId.
	CertificateId *string

	// The certificate data, in PEM format.
	CertificatePem *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the CreateCertificateFromCsr operation.

type CreateCertificateProviderInput added in v1.47.0 

type CreateCertificateProviderInput struct {

	// A list of the operations that the certificate provider will use to generate
	// certificates. Valid value: CreateCertificateFromCsr .
	//
	// This member is required.
	AccountDefaultForOperations []types.CertificateProviderOperation

	// The name of the certificate provider.
	//
	// This member is required.
	CertificateProviderName *string

	// The ARN of the Lambda function that defines the authentication logic.
	//
	// This member is required.
	LambdaFunctionArn *string

	// A string that you can optionally pass in the CreateCertificateProvider request
	// to make sure the request is idempotent.
	ClientToken *string

	// Metadata which can be used to manage the certificate provider.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCertificateProviderOutput added in v1.47.0 

type CreateCertificateProviderOutput struct {

	// The ARN of the certificate provider.
	CertificateProviderArn *string

	// The name of the certificate provider.
	CertificateProviderName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCommandInput added in v1.61.0 

type CreateCommandInput struct {

	// A unique identifier for the command. We recommend using UUID. Alpha-numeric
	// characters, hyphens, and underscores are valid for use here.
	//
	// This member is required.
	CommandId *string

	// A short text decription of the command.
	Description *string

	// The user-friendly name in the console for the command. This name doesn't have
	// to be unique. You can update the user-friendly name after you define it.
	DisplayName *string

	// A list of parameters that are required by the StartCommandExecution API. These
	// parameters need to be specified only when using the AWS-IoT-FleetWise
	// namespace. You can either specify them here or when running the command using
	// the StartCommandExecution API.
	MandatoryParameters []types.CommandParameter

	// The namespace of the command. The MQTT reserved topics and validations will be
	// used for command executions according to the namespace setting.
	Namespace types.CommandNamespace

	// The payload object for the command. You must specify this information when
	// using the AWS-IoT namespace.
	//
	// You can upload a static payload file from your local storage that contains the
	// instructions for the device to process. The payload file can use any format. To
	// make sure that the device correctly interprets the payload, we recommend you to
	// specify the payload content type.
	Payload *types.CommandPayload

	// The IAM role that allows access to create the command.
	RoleArn *string

	// Name-value pairs that are used as metadata to manage a command.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCommandOutput added in v1.61.0 

type CreateCommandOutput struct {

	// The Amazon Resource Number (ARN) of the command. For example,
	// arn:aws:iot:::command/
	CommandArn *string

	// The unique identifier for the command.
	CommandId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomMetricInput added in v1.2.0 

type CreateCustomMetricInput struct {

	// Each custom metric must have a unique client request token. If you try to
	// create a new custom metric that already exists with a different token, an
	// exception occurs. If you omit this value, Amazon Web Services SDKs will
	// automatically generate a unique client request.
	//
	// This member is required.
	ClientRequestToken *string

	//  The name of the custom metric. This will be used in the metric report
	// submitted from the device/thing. The name can't begin with aws: . You can't
	// change the name after you define it.
	//
	// This member is required.
	MetricName *string

	//  The type of the custom metric.
	//
	// The type number only takes a single metric value as an input, but when you
	// submit the metrics value in the DeviceMetrics report, you must pass it as an
	// array with a single value.
	//
	// This member is required.
	MetricType types.CustomMetricType

	//  The friendly name in the console for the custom metric. This name doesn't have
	// to be unique. Don't use this name as the metric identifier in the device metric
	// report. You can update the friendly name after you define it.
	DisplayName *string

	//  Metadata that can be used to manage the custom metric.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCustomMetricOutput added in v1.2.0 

type CreateCustomMetricOutput struct {

	//  The Amazon Resource Number (ARN) of the custom metric. For example,
	// arn:aws-partition:iot:region:accountId:custommetric/metricName
	MetricArn *string

	//  The name of the custom metric to be used in the metric report.
	MetricName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDimensionInput 

type CreateDimensionInput struct {

	// 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, Amazon Web Services SDKs will
	// automatically generate a unique client request.
	//
	// This member is required.
	ClientRequestToken *string

	// A unique identifier for the dimension. Choose something that describes the type
	// and value to make it easy to remember what it does.
	//
	// This member is required.
	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/#").
	//
	// This member is required.
	StringValues []string

	// Specifies the type of dimension. Supported types: TOPIC_FILTER.
	//
	// This member is required.
	Type types.DimensionType

	// Metadata that can be used to manage the dimension.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDimensionOutput 

type CreateDimensionOutput struct {

	// The Amazon Resource Name (ARN) of the created dimension.
	Arn *string

	// A unique identifier for the dimension.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDomainConfigurationInput 

type CreateDomainConfigurationInput struct {

	// The name of the domain configuration. This value must be unique to a region.
	//
	// This member is required.
	DomainConfigurationName *string

	// An enumerated string that specifies the application-layer protocol.
	//
	//   - SECURE_MQTT - MQTT over TLS.
	//
	//   - MQTT_WSS - MQTT over WebSocket.
	//
	//   - HTTPS - HTTP over TLS.
	//
	//   - DEFAULT - Use a combination of port and Application Layer Protocol
	//   Negotiation (ALPN) to specify application_layer protocol. For more information,
	//   see [Device communication protocols].
	//
	// [Device communication protocols]: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html
	ApplicationProtocol types.ApplicationProtocol

	// An enumerated string that specifies the authentication type.
	//
	//   - CUSTOM_AUTH_X509 - Use custom authentication and authorization with
	//   additional details from the X.509 client certificate.
	//
	//   - CUSTOM_AUTH - Use custom authentication and authorization. For more
	//   information, see [Custom authentication and authorization].
	//
	//   - AWS_X509 - Use X.509 client certificates without custom authentication and
	//   authorization. For more information, see [X.509 client certificates].
	//
	//   - AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more
	//   information, see [IAM users, groups, and roles].
	//
	//   - DEFAULT - Use a combination of port and Application Layer Protocol
	//   Negotiation (ALPN) to specify authentication type. For more information, see [Device communication protocols].
	//
	// [Custom authentication and authorization]: https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
	// [X.509 client certificates]: https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html
	// [IAM users, groups, and roles]: https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
	// [Device communication protocols]: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html
	AuthenticationType types.AuthenticationType

	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *types.AuthorizerConfig

	// An object that specifies the client certificate configuration for a domain.
	ClientCertificateConfig *types.ClientCertificateConfig

	// The name of the domain.
	DomainName *string

	// The ARNs of the certificates that IoT passes to the device during the TLS
	// handshake. Currently you can specify only one certificate ARN. This value is not
	// required for Amazon Web Services-managed domains.
	ServerCertificateArns []string

	// The server certificate configuration.
	ServerCertificateConfig *types.ServerCertificateConfig

	// The type of service delivered by the endpoint.
	//
	// Amazon Web Services 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

	// An object that specifies the TLS configuration for a domain.
	TlsConfig *types.TlsConfig

	// 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 Amazon Web Services-managed domains.
	ValidationCertificateArn *string
	// contains filtered or unexported fields
}

type CreateDomainConfigurationOutput 

type CreateDomainConfigurationOutput struct {

	// The ARN of the domain configuration.
	DomainConfigurationArn *string

	// The name of the domain configuration.
	DomainConfigurationName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDynamicThingGroupInput 

type CreateDynamicThingGroupInput struct {

	// The dynamic thing group search query string.
	//
	// See [Query Syntax] for information about query string syntax.
	//
	// [Query Syntax]: https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html
	//
	// This member is required.
	QueryString *string

	// The dynamic thing group name to create.
	//
	// This member is required.
	ThingGroupName *string

	// The dynamic thing group index name.
	//
	// Currently one index is supported: AWS_Things .
	IndexName *string

	// 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

	// Metadata which can be used to manage the dynamic thing group.
	Tags []types.Tag

	// The dynamic thing group properties.
	ThingGroupProperties *types.ThingGroupProperties
	// contains filtered or unexported fields
}

type CreateDynamicThingGroupOutput 

type CreateDynamicThingGroupOutput struct {

	// The dynamic thing group index name.
	IndexName *string

	// The dynamic thing group search query string.
	QueryString *string

	// The dynamic thing group query version.
	QueryVersion *string

	// The dynamic thing group ARN.
	ThingGroupArn *string

	// The dynamic thing group ID.
	ThingGroupId *string

	// The dynamic thing group name.
	ThingGroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFleetMetricInput added in v1.11.0 

type CreateFleetMetricInput struct {

	// The field to aggregate.
	//
	// This member is required.
	AggregationField *string

	// The type of the aggregation query.
	//
	// This member is required.
	AggregationType *types.AggregationType

	// The name of the fleet metric to create.
	//
	// This member is required.
	MetricName *string

	// The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
	// day)] and must be multiple of 60.
	//
	// This member is required.
	Period *int32

	// The search query string.
	//
	// This member is required.
	QueryString *string

	// The fleet metric description.
	Description *string

	// The name of the index to search.
	IndexName *string

	// The query version.
	QueryVersion *string

	// Metadata, which can be used to manage the fleet metric.
	Tags []types.Tag

	// Used to support unit transformation such as milliseconds to seconds. The unit
	// must be supported by [CW metric]. Default to null.
	//
	// [CW metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
	Unit types.FleetMetricUnit
	// contains filtered or unexported fields
}

type CreateFleetMetricOutput added in v1.11.0 

type CreateFleetMetricOutput struct {

	// The Amazon Resource Name (ARN) of the new fleet metric.
	MetricArn *string

	// The name of the fleet metric to create.
	MetricName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateJobInput 

type CreateJobInput struct {

	// A job identifier which must be unique for your account. We recommend using a
	// UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
	//
	// This member is required.
	JobId *string

	// A list of things and thing groups to which the job should be sent.
	//
	// This member is required.
	Targets []string

	// Allows you to create the criteria to abort a job.
	AbortConfig *types.AbortConfig

	// A short text description of the job.
	Description *string

	// The package version Amazon Resource Names (ARNs) that are installed on the
	// device when the job successfully completes. The package version must be in
	// either the Published or Deprecated state when the job deploys. For more
	// information, see [Package version lifecycle].
	//
	// Note:The following Length Constraints relates to a single ARN. Up to 25 package
	// version ARNs are allowed.
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	DestinationPackageVersions []string

	// The job document. Required if you don't specify a value for documentSource .
	Document *string

	// Parameters of an Amazon Web Services managed template that you can specify to
	// create the job document.
	//
	// documentParameters can only be used when creating jobs from Amazon Web Services
	// managed templates. This parameter can't be used with custom job templates or to
	// create jobs from them.
	DocumentParameters map[string]string

	// An S3 link, or S3 object URL, to the job document. The link is an Amazon S3
	// object URL and is required if you don't specify a value for document .
	//
	// For example, --document-source
	// https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
	//
	// For more information, see [Methods for accessing a bucket].
	//
	// [Methods for accessing a bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
	DocumentSource *string

	// Allows you to create the criteria to retry a job.
	JobExecutionsRetryConfig *types.JobExecutionsRetryConfig

	// Allows you to create a staged rollout of the job.
	JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig

	// The ARN of the job template used to create the job.
	JobTemplateArn *string

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *string

	// Configuration information for pre-signed S3 URLs.
	PresignedUrlConfig *types.PresignedUrlConfig

	// The configuration that allows you to schedule a job for a future date and time
	// in addition to specifying the end behavior for each job execution.
	SchedulingConfig *types.SchedulingConfig

	// Metadata which can be used to manage the job.
	Tags []types.Tag

	// 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.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	TargetSelection types.TargetSelection

	// 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
	// contains filtered or unexported fields
}

type CreateJobOutput 

type CreateJobOutput struct {

	// The job description.
	Description *string

	// The job ARN.
	JobArn *string

	// The unique identifier you assigned to this job.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateJobTemplateInput added in v1.6.0 

type CreateJobTemplateInput struct {

	// A description of the job document.
	//
	// This member is required.
	Description *string

	// A unique identifier for the job template. We recommend using a UUID.
	// Alpha-numeric characters, "-", and "_" are valid for use here.
	//
	// This member is required.
	JobTemplateId *string

	// The criteria that determine when and how a job abort takes place.
	AbortConfig *types.AbortConfig

	// The package version Amazon Resource Names (ARNs) that are installed on the
	// device when the job successfully completes. The package version must be in
	// either the Published or Deprecated state when the job deploys. For more
	// information, see [Package version lifecycle].
	//
	// Note:The following Length Constraints relates to a single ARN. Up to 25 package
	// version ARNs are allowed.
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	DestinationPackageVersions []string

	// The job document. Required if you don't specify a value for documentSource .
	Document *string

	// An S3 link, or S3 object URL, to the job document. The link is an Amazon S3
	// object URL and is required if you don't specify a value for document .
	//
	// For example, --document-source
	// https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
	//
	// For more information, see [Methods for accessing a bucket].
	//
	// [Methods for accessing a bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
	DocumentSource *string

	// The ARN of the job to use as the basis for the job template.
	JobArn *string

	// Allows you to create the criteria to retry a job.
	JobExecutionsRetryConfig *types.JobExecutionsRetryConfig

	// Allows you to create a staged rollout of a job.
	JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig

	// Allows you to configure an optional maintenance window for the rollout of a job
	// document to all devices in the target group for a job.
	MaintenanceWindows []types.MaintenanceWindow

	// Configuration for pre-signed S3 URLs.
	PresignedUrlConfig *types.PresignedUrlConfig

	// Metadata that can be used to manage the job template.
	Tags []types.Tag

	// 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 .
	TimeoutConfig *types.TimeoutConfig
	// contains filtered or unexported fields
}

type CreateJobTemplateOutput added in v1.6.0 

type CreateJobTemplateOutput struct {

	// The ARN of the job template.
	JobTemplateArn *string

	// The unique identifier of the job template.
	JobTemplateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKeysAndCertificateInput 

type CreateKeysAndCertificateInput struct {

	// Specifies whether the certificate is active.
	SetAsActive bool
	// contains filtered or unexported fields
}

The input for the CreateKeysAndCertificate operation.

Requires permission to access the CreateKeysAndCertificateRequest action.

type CreateKeysAndCertificateOutput 

type CreateKeysAndCertificateOutput struct {

	// The ARN of the certificate.
	CertificateArn *string

	// The ID of the certificate. IoT issues a default subject name for the
	// certificate (for example, IoT Certificate).
	CertificateId *string

	// The certificate data, in PEM format.
	CertificatePem *string

	// The generated key pair.
	KeyPair *types.KeyPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output of the CreateKeysAndCertificate operation.

type CreateMitigationActionInput 

type CreateMitigationActionInput struct {

	// A friendly name for the action. Choose a friendly name that accurately
	// describes the action (for example, EnableLoggingAction ).
	//
	// This member is required.
	ActionName *string

	// Defines the type of action and the parameters for that action.
	//
	// This member is required.
	ActionParams *types.MitigationActionParams

	// The ARN of the IAM role that is used to apply the mitigation action.
	//
	// This member is required.
	RoleArn *string

	// Metadata that can be used to manage the mitigation action.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMitigationActionOutput 

type CreateMitigationActionOutput struct {

	// The ARN for the new mitigation action.
	ActionArn *string

	// A unique identifier for the new mitigation action.
	ActionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateOTAUpdateInput 

type CreateOTAUpdateInput struct {

	// The files to be streamed by the OTA update.
	//
	// This member is required.
	Files []types.OTAUpdateFile

	// The ID of the OTA update to be created.
	//
	// This member is required.
	OtaUpdateId *string

	// The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3,
	// IoT jobs and Amazon Web Services Code Signing resources to create an OTA update
	// job.
	//
	// This member is required.
	RoleArn *string

	// The devices targeted to receive OTA updates.
	//
	// This member is required.
	Targets []string

	// A list of additional OTA update parameters, which are name-value pairs. They
	// won't be sent to devices as a part of the Job document.
	AdditionalParameters map[string]string

	// The criteria that determine when and how a job abort takes place.
	AwsJobAbortConfig *types.AwsJobAbortConfig

	// Configuration for the rollout of OTA updates.
	AwsJobExecutionsRolloutConfig *types.AwsJobExecutionsRolloutConfig

	// Configuration information for pre-signed URLs.
	AwsJobPresignedUrlConfig *types.AwsJobPresignedUrlConfig

	// 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 description of the OTA update.
	Description *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

	// 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
	// contains filtered or unexported fields
}

type CreateOTAUpdateOutput 

type CreateOTAUpdateOutput struct {

	// The IoT job ARN associated with the OTA update.
	AwsIotJobArn *string

	// The IoT job ID associated with the OTA update.
	AwsIotJobId *string

	// The OTA update ARN.
	OtaUpdateArn *string

	// The OTA update ID.
	OtaUpdateId *string

	// The OTA update status.
	OtaUpdateStatus types.OTAUpdateStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePackageInput added in v1.38.0 

type CreatePackageInput struct {

	// The name of the new software package.
	//
	// This member is required.
	PackageName *string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string

	// A summary of the package being created. This can be used to outline the
	// package's contents or purpose.
	Description *string

	// Metadata that can be used to manage the package.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreatePackageOutput added in v1.38.0 

type CreatePackageOutput struct {

	// The package description.
	Description *string

	// The Amazon Resource Name (ARN) for the package.
	PackageArn *string

	// The name of the software package.
	PackageName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePackageVersionInput added in v1.38.0 

type CreatePackageVersionInput struct {

	// The name of the associated software package.
	//
	// This member is required.
	PackageName *string

	// The name of the new package version.
	//
	// This member is required.
	VersionName *string

	// The various build components created during the build process such as libraries
	// and configuration files that make up a software package version.
	Artifact *types.PackageVersionArtifact

	// Metadata that can be used to define a package version’s configuration. For
	// example, the S3 file location, configuration options that are being sent to the
	// device or fleet.
	//
	// The combined size of all the attributes on a package version is limited to 3KB.
	Attributes map[string]string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string

	// A summary of the package version being created. This can be used to outline the
	// package's contents or purpose.
	Description *string

	// The inline job document associated with a software package version used for a
	// quick job deployment.
	Recipe *string

	// Metadata that can be used to manage the package version.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreatePackageVersionOutput added in v1.38.0 

type CreatePackageVersionOutput struct {

	// Metadata that were added to the package version that can be used to define a
	// package version’s configuration.
	Attributes map[string]string

	// The package version description.
	Description *string

	// Error reason for a package version failure during creation or update.
	ErrorReason *string

	// The name of the associated software package.
	PackageName *string

	// The Amazon Resource Name (ARN) for the package.
	PackageVersionArn *string

	// The status of the package version. For more information, see [Package version lifecycle].
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	Status types.PackageVersionStatus

	// The name of the new package version.
	VersionName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePolicyInput 

type CreatePolicyInput struct {

	// The JSON document that describes the policy. policyDocument must have a minimum
	// length of 1, with a maximum length of 2048, excluding whitespace.
	//
	// This member is required.
	PolicyDocument *string

	// The policy name.
	//
	// This member is required.
	PolicyName *string

	// 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
	// contains filtered or unexported fields
}

The input for the CreatePolicy operation.

type CreatePolicyOutput 

type CreatePolicyOutput struct {

	// The policy ARN.
	PolicyArn *string

	// The JSON document that describes the policy.
	PolicyDocument *string

	// The policy name.
	PolicyName *string

	// The policy version ID.
	PolicyVersionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the CreatePolicy operation.

type CreatePolicyVersionInput 

type CreatePolicyVersionInput struct {

	// The JSON document that describes the policy. Minimum length of 1. Maximum
	// length of 2048, excluding whitespace.
	//
	// This member is required.
	PolicyDocument *string

	// The policy name.
	//
	// This member is required.
	PolicyName *string

	// 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
	// contains filtered or unexported fields
}

The input for the CreatePolicyVersion operation.

type CreatePolicyVersionOutput 

type CreatePolicyVersionOutput struct {

	// Specifies whether the policy version is the default.
	IsDefaultVersion bool

	// The policy ARN.
	PolicyArn *string

	// The JSON document that describes the policy.
	PolicyDocument *string

	// The policy version ID.
	PolicyVersionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output of the CreatePolicyVersion operation.

type CreateProvisioningClaimInput 

type CreateProvisioningClaimInput struct {

	// The name of the provisioning template to use.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

type CreateProvisioningClaimOutput 

type CreateProvisioningClaimOutput struct {

	// The ID of the certificate.
	CertificateId *string

	// The provisioning claim certificate.
	CertificatePem *string

	// The provisioning claim expiration time.
	Expiration *time.Time

	// The provisioning claim key pair.
	KeyPair *types.KeyPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProvisioningTemplateInput 

type CreateProvisioningTemplateInput struct {

	// The role ARN for the role associated with the provisioning template. This IoT
	// role grants permission to provision a device.
	//
	// This member is required.
	ProvisioningRoleArn *string

	// The JSON formatted contents of the provisioning template.
	//
	// This member is required.
	TemplateBody *string

	// The name of the provisioning template.
	//
	// This member is required.
	TemplateName *string

	// The description of the provisioning template.
	Description *string

	// True to enable the provisioning template, otherwise false.
	Enabled *bool

	// Creates a pre-provisioning hook template. Only supports template of type
	// FLEET_PROVISIONING . For more information about provisioning template types, see [type]
	// .
	//
	// [type]: https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type
	PreProvisioningHook *types.ProvisioningHook

	// Metadata which can be used to manage the 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

	// The type you define in a provisioning template. You can create a template with
	// only one type. You can't change the template type after its creation. The
	// default value is FLEET_PROVISIONING . For more information about provisioning
	// template, see: [Provisioning template].
	//
	// [Provisioning template]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html
	Type types.TemplateType
	// contains filtered or unexported fields
}

type CreateProvisioningTemplateOutput 

type CreateProvisioningTemplateOutput struct {

	// The default version of the provisioning template.
	DefaultVersionId *int32

	// The ARN that identifies the provisioning template.
	TemplateArn *string

	// The name of the provisioning template.
	TemplateName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProvisioningTemplateVersionInput 

type CreateProvisioningTemplateVersionInput struct {

	// The JSON formatted contents of the provisioning template.
	//
	// This member is required.
	TemplateBody *string

	// The name of the provisioning template.
	//
	// This member is required.
	TemplateName *string

	// Sets a fleet provision template version as the default version.
	SetAsDefault bool
	// contains filtered or unexported fields
}

type CreateProvisioningTemplateVersionOutput 

type CreateProvisioningTemplateVersionOutput struct {

	// True if the provisioning template version is the default version, otherwise
	// false.
	IsDefaultVersion bool

	// The ARN that identifies the provisioning template.
	TemplateArn *string

	// The name of the provisioning template.
	TemplateName *string

	// The version of the provisioning template.
	VersionId *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRoleAliasInput 

type CreateRoleAliasInput struct {

	// The role alias that points to a role ARN. This allows you to change the role
	// without having to update the device.
	//
	// This member is required.
	RoleAlias *string

	// The role ARN.
	//
	// This member is required.
	RoleArn *string

	// How long (in seconds) the credentials will be valid. The default value is 3,600
	// seconds.
	//
	// This value must be less than or equal to the maximum session duration of the
	// IAM role that the role alias references.
	CredentialDurationSeconds *int32

	// 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
	// contains filtered or unexported fields
}

type CreateRoleAliasOutput 

type CreateRoleAliasOutput struct {

	// The role alias.
	RoleAlias *string

	// The role alias ARN.
	RoleAliasArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateScheduledAuditInput 

type CreateScheduledAuditInput struct {

	// How often the scheduled audit takes place, either DAILY , WEEKLY , BIWEEKLY or
	// MONTHLY . The start time of each audit is determined by the system.
	//
	// This member is required.
	Frequency types.AuditFrequency

	// The name you want to give to the scheduled audit. (Max. 128 chars)
	//
	// This member is required.
	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.)
	//
	// This member is required.
	TargetCheckNames []string

	// The day of the month on which the scheduled audit takes place. This can be "1"
	// through "31" or "LAST". This field is required if the "frequency" parameter is
	// set to MONTHLY . If days 29 to 31 are specified, and the month doesn't have that
	// many days, the audit takes place on the LAST day of the month.
	DayOfMonth *string

	// The day of the week on which the scheduled audit takes place, either 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
	// contains filtered or unexported fields
}

type CreateScheduledAuditOutput 

type CreateScheduledAuditOutput struct {

	// The ARN of the scheduled audit.
	ScheduledAuditArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSecurityProfileInput 

type CreateSecurityProfileInput struct {

	// The name you are giving to the security profile.
	//
	// This member is required.
	SecurityProfileName *string

	//  Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
	//
	// 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. Can be used with custom metrics; cannot be used with
	// dimensions.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []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. Can be used with custom metrics; cannot be used with
	// dimensions.
	AdditionalMetricsToRetainV2 []types.MetricToRetain

	// 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

	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	Behaviors []types.Behavior

	// Specifies the MQTT topic and role ARN required for metric export.
	MetricsExportConfig *types.MetricsExportConfig

	// A description of the security profile.
	SecurityProfileDescription *string

	// Metadata that can be used to manage the security profile.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateStreamInput 

type CreateStreamInput struct {

	// The files to stream.
	//
	// This member is required.
	Files []types.StreamFile

	// An IAM role that allows the IoT service principal to access your S3 files.
	//
	// This member is required.
	RoleArn *string

	// The stream ID.
	//
	// This member is required.
	StreamId *string

	// A description of the stream.
	Description *string

	// Metadata which can be used to manage streams.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateStreamOutput 

type CreateStreamOutput struct {

	// A description of the stream.
	Description *string

	// The stream ARN.
	StreamArn *string

	// The stream ID.
	StreamId *string

	// The version of the stream.
	StreamVersion *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateThingGroupInput 

type CreateThingGroupInput struct {

	// The thing group name to create.
	//
	// This member is required.
	ThingGroupName *string

	// 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
	// contains filtered or unexported fields
}

type CreateThingGroupOutput 

type CreateThingGroupOutput struct {

	// The thing group ARN.
	ThingGroupArn *string

	// The thing group ID.
	ThingGroupId *string

	// The thing group name.
	ThingGroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateThingInput 

type CreateThingInput struct {

	// 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.
	//
	// This member is required.
	ThingName *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 name of the billing group the thing will be added to.
	BillingGroupName *string

	// The name of the thing type associated with the new thing.
	ThingTypeName *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output of the CreateThing operation.

type CreateThingTypeInput 

type CreateThingTypeInput struct {

	// The name of the thing type.
	//
	// This member is required.
	ThingTypeName *string

	// Metadata which can be used to manage the thing type.
	Tags []types.Tag

	// 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
	// contains filtered or unexported fields
}

The input for the CreateThingType operation.

type CreateThingTypeOutput 

type CreateThingTypeOutput struct {

	// The Amazon Resource Name (ARN) of the thing type.
	ThingTypeArn *string

	// The thing type ID.
	ThingTypeId *string

	// The name of the thing type.
	ThingTypeName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output of the CreateThingType operation.

type CreateTopicRuleDestinationInput 

type CreateTopicRuleDestinationInput struct {

	// The topic rule destination configuration.
	//
	// This member is required.
	DestinationConfiguration *types.TopicRuleDestinationConfiguration
	// contains filtered or unexported fields
}

type CreateTopicRuleDestinationOutput 

type CreateTopicRuleDestinationOutput struct {

	// The topic rule destination.
	TopicRuleDestination *types.TopicRuleDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTopicRuleInput 

type CreateTopicRuleInput struct {

	// The name of the rule.
	//
	// This member is required.
	RuleName *string

	// The rule payload.
	//
	// This member is required.
	TopicRulePayload *types.TopicRulePayload

	// 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
	// contains filtered or unexported fields
}

The input for the CreateTopicRule operation.

type CreateTopicRuleOutput 

type CreateTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAccountAuditConfigurationInput 

type DeleteAccountAuditConfigurationInput struct {

	// If true, all scheduled audits are deleted.
	DeleteScheduledAudits bool
	// contains filtered or unexported fields
}

type DeleteAccountAuditConfigurationOutput 

type DeleteAccountAuditConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAuditSuppressionInput added in v0.29.0 

type DeleteAuditSuppressionInput struct {

	// An audit check name. 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.)
	//
	// This member is required.
	CheckName *string

	// Information that identifies the noncompliant resource.
	//
	// This member is required.
	ResourceIdentifier *types.ResourceIdentifier
	// contains filtered or unexported fields
}

type DeleteAuditSuppressionOutput added in v0.29.0 

type DeleteAuditSuppressionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAuthorizerInput 

type DeleteAuthorizerInput struct {

	// The name of the authorizer to delete.
	//
	// This member is required.
	AuthorizerName *string
	// contains filtered or unexported fields
}

type DeleteAuthorizerOutput 

type DeleteAuthorizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBillingGroupInput 

type DeleteBillingGroupInput struct {

	// The name of the billing group.
	//
	// This member is required.
	BillingGroupName *string

	// 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
	// contains filtered or unexported fields
}

type DeleteBillingGroupOutput 

type DeleteBillingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCACertificateInput 

type DeleteCACertificateInput struct {

	// The ID of the certificate to delete. (The last part of the certificate ARN
	// contains the certificate ID.)
	//
	// This member is required.
	CertificateId *string
	// contains filtered or unexported fields
}

Input for the DeleteCACertificate operation.

type DeleteCACertificateOutput 

type DeleteCACertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.)
	//
	// This member is required.
	CertificateId *string

	// Forces the deletion of a certificate if it is inactive and is not attached to
	// an IoT thing.
	ForceDelete bool
	// contains filtered or unexported fields
}

The input for the DeleteCertificate operation.

type DeleteCertificateOutput 

type DeleteCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCertificateProviderInput added in v1.47.0 

type DeleteCertificateProviderInput struct {

	// The name of the certificate provider.
	//
	// This member is required.
	CertificateProviderName *string
	// contains filtered or unexported fields
}

type DeleteCertificateProviderOutput added in v1.47.0 

type DeleteCertificateProviderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCommandExecutionInput added in v1.61.0 

type DeleteCommandExecutionInput struct {

	// The unique identifier of the command execution that you want to delete from
	// your account.
	//
	// This member is required.
	ExecutionId *string

	// The Amazon Resource Number (ARN) of the target device for which you want to
	// delete command executions.
	//
	// This member is required.
	TargetArn *string
	// contains filtered or unexported fields
}

type DeleteCommandExecutionOutput added in v1.61.0 

type DeleteCommandExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCommandInput added in v1.61.0 

type DeleteCommandInput struct {

	// The unique identifier of the command to be deleted.
	//
	// This member is required.
	CommandId *string
	// contains filtered or unexported fields
}

type DeleteCommandOutput added in v1.61.0 

type DeleteCommandOutput struct {

	// The status code for the command deletion request. The status code is in the 200
	// range for a successful request.
	//
	//   - If the command hasn't been deprecated, or has been deprecated for a
	//   duration that is shorter than the maximum time out duration of 12 hours, when
	//   calling the DeleteCommand request, the deletion will be scheduled and a 202
	//   status code will be returned. While the command is being deleted, it will be in
	//   a pendingDeletion state. Once the time out duration has been reached, the
	//   command will be permanently removed from your account.
	//
	//   - If the command has been deprecated for a duration that is longer than the
	//   maximum time out duration of 12 hours, when calling the DeleteCommand request,
	//   the command will be deleted immediately and a 204 status code will be returned.
	StatusCode int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomMetricInput added in v1.2.0 

type DeleteCustomMetricInput struct {

	//  The name of the custom metric.
	//
	// This member is required.
	MetricName *string
	// contains filtered or unexported fields
}

type DeleteCustomMetricOutput added in v1.2.0 

type DeleteCustomMetricOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDimensionInput 

type DeleteDimensionInput struct {

	// The unique identifier for the dimension that you want to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteDimensionOutput 

type DeleteDimensionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDomainConfigurationInput 

type DeleteDomainConfigurationInput struct {

	// The name of the domain configuration to be deleted.
	//
	// This member is required.
	DomainConfigurationName *string
	// contains filtered or unexported fields
}

type DeleteDomainConfigurationOutput 

type DeleteDomainConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDynamicThingGroupInput 

type DeleteDynamicThingGroupInput struct {

	// The name of the dynamic thing group to delete.
	//
	// This member is required.
	ThingGroupName *string

	// The expected version of the dynamic thing group to delete.
	ExpectedVersion *int64
	// contains filtered or unexported fields
}

type DeleteDynamicThingGroupOutput 

type DeleteDynamicThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFleetMetricInput added in v1.11.0 

type DeleteFleetMetricInput struct {

	// The name of the fleet metric to delete.
	//
	// This member is required.
	MetricName *string

	// The expected version of the fleet metric to delete.
	ExpectedVersion *int64
	// contains filtered or unexported fields
}

type DeleteFleetMetricOutput added in v1.11.0 

type DeleteFleetMetricOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteJobExecutionInput 

type DeleteJobExecutionInput struct {

	// 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.
	//
	// This member is required.
	ExecutionNumber *int64

	// The ID of the job whose execution on a particular device will be deleted.
	//
	// This member is required.
	JobId *string

	// The name of the thing whose job execution will be deleted.
	//
	// This member is required.
	ThingName *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 namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *string
	// contains filtered or unexported fields
}

type DeleteJobExecutionOutput 

type DeleteJobExecutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteJobInput 

type DeleteJobInput struct {

	// 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.
	//
	// This member is required.
	JobId *string

	// (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 namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *string
	// contains filtered or unexported fields
}

type DeleteJobOutput 

type DeleteJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteJobTemplateInput added in v1.6.0 

type DeleteJobTemplateInput struct {

	// The unique identifier of the job template to delete.
	//
	// This member is required.
	JobTemplateId *string
	// contains filtered or unexported fields
}

type DeleteJobTemplateOutput added in v1.6.0 

type DeleteJobTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMitigationActionInput 

type DeleteMitigationActionInput struct {

	// The name of the mitigation action that you want to delete.
	//
	// This member is required.
	ActionName *string
	// contains filtered or unexported fields
}

type DeleteMitigationActionOutput 

type DeleteMitigationActionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteOTAUpdateInput 

type DeleteOTAUpdateInput struct {

	// The ID of the OTA update to delete.
	//
	// This member is required.
	OtaUpdateId *string

	// When true, the stream created by the OTAUpdate process is deleted when the OTA
	// update is deleted. Ignored if the stream specified in the OTAUpdate is supplied
	// by the user.
	DeleteStream bool

	// When true, deletes the IoT job created by the OTAUpdate process even if it is
	// "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or
	// "CANCELED") an exception will occur. The default is false.
	ForceDeleteAWSJob bool
	// contains filtered or unexported fields
}

type DeleteOTAUpdateOutput 

type DeleteOTAUpdateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePackageInput added in v1.38.0 

type DeletePackageInput struct {

	// The name of the target software package.
	//
	// This member is required.
	PackageName *string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeletePackageOutput added in v1.38.0 

type DeletePackageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePackageVersionInput added in v1.38.0 

type DeletePackageVersionInput struct {

	// The name of the associated software package.
	//
	// This member is required.
	PackageName *string

	// The name of the target package version.
	//
	// This member is required.
	VersionName *string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeletePackageVersionOutput added in v1.38.0 

type DeletePackageVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePolicyInput 

type DeletePolicyInput struct {

	// The name of the policy to delete.
	//
	// This member is required.
	PolicyName *string
	// contains filtered or unexported fields
}

The input for the DeletePolicy operation.

type DeletePolicyOutput 

type DeletePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePolicyVersionInput 

type DeletePolicyVersionInput struct {

	// The name of the policy.
	//
	// This member is required.
	PolicyName *string

	// The policy version ID.
	//
	// This member is required.
	PolicyVersionId *string
	// contains filtered or unexported fields
}

The input for the DeletePolicyVersion operation.

type DeletePolicyVersionOutput 

type DeletePolicyVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProvisioningTemplateInput 

type DeleteProvisioningTemplateInput struct {

	// The name of the fleet provision template to delete.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

type DeleteProvisioningTemplateOutput 

type DeleteProvisioningTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProvisioningTemplateVersionInput 

type DeleteProvisioningTemplateVersionInput struct {

	// The name of the provisioning template version to delete.
	//
	// This member is required.
	TemplateName *string

	// The provisioning template version ID to delete.
	//
	// This member is required.
	VersionId *int32
	// contains filtered or unexported fields
}

type DeleteProvisioningTemplateVersionOutput 

type DeleteProvisioningTemplateVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRegistrationCodeInput 

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

The input for the DeleteRegistrationCode operation.

type DeleteRegistrationCodeOutput 

type DeleteRegistrationCodeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output for the DeleteRegistrationCode operation.

type DeleteRoleAliasInput 

type DeleteRoleAliasInput struct {

	// The role alias to delete.
	//
	// This member is required.
	RoleAlias *string
	// contains filtered or unexported fields
}

type DeleteRoleAliasOutput 

type DeleteRoleAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteScheduledAuditInput 

type DeleteScheduledAuditInput struct {

	// The name of the scheduled audit you want to delete.
	//
	// This member is required.
	ScheduledAuditName *string
	// contains filtered or unexported fields
}

type DeleteScheduledAuditOutput 

type DeleteScheduledAuditOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSecurityProfileInput 

type DeleteSecurityProfileInput struct {

	// The name of the security profile to be deleted.
	//
	// This member is required.
	SecurityProfileName *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
	// contains filtered or unexported fields
}

type DeleteSecurityProfileOutput 

type DeleteSecurityProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteStreamInput 

type DeleteStreamInput struct {

	// The stream ID.
	//
	// This member is required.
	StreamId *string
	// contains filtered or unexported fields
}

type DeleteStreamOutput 

type DeleteStreamOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteThingGroupInput 

type DeleteThingGroupInput struct {

	// The name of the thing group to delete.
	//
	// This member is required.
	ThingGroupName *string

	// The expected version of the thing group to delete.
	ExpectedVersion *int64
	// contains filtered or unexported fields
}

type DeleteThingGroupOutput 

type DeleteThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteThingInput 

type DeleteThingInput struct {

	// The name of the thing to delete.
	//
	// This member is required.
	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
	// contains filtered or unexported fields
}

The input for the DeleteThing operation.

type DeleteThingOutput 

type DeleteThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output of the DeleteThing operation.

type DeleteThingTypeInput 

type DeleteThingTypeInput struct {

	// The name of the thing type.
	//
	// This member is required.
	ThingTypeName *string
	// contains filtered or unexported fields
}

The input for the DeleteThingType operation.

type DeleteThingTypeOutput 

type DeleteThingTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output for the DeleteThingType operation.

type DeleteTopicRuleDestinationInput 

type DeleteTopicRuleDestinationInput struct {

	// The ARN of the topic rule destination to delete.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteTopicRuleDestinationOutput 

type DeleteTopicRuleDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTopicRuleInput 

type DeleteTopicRuleInput struct {

	// The name of the rule.
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

The input for the DeleteTopicRule operation.

type DeleteTopicRuleOutput 

type DeleteTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteV2LoggingLevelInput 

type DeleteV2LoggingLevelInput struct {

	// The name of the resource for which you are configuring logging.
	//
	// This member is required.
	TargetName *string

	// The type of resource for which you are configuring logging. Must be THING_Group .
	//
	// This member is required.
	TargetType types.LogTargetType
	// contains filtered or unexported fields
}

type DeleteV2LoggingLevelOutput 

type DeleteV2LoggingLevelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeprecateThingTypeInput 

type DeprecateThingTypeInput struct {

	// The name of the thing type to deprecate.
	//
	// This member is required.
	ThingTypeName *string

	// 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
	// contains filtered or unexported fields
}

The input for the DeprecateThingType operation.

type DeprecateThingTypeOutput 

type DeprecateThingTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output for the DeprecateThingType operation.

type DescribeAccountAuditConfigurationInput 

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

type DescribeAccountAuditConfigurationOutput 

type DescribeAccountAuditConfigurationOutput struct {

	// 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

	// The ARN of the role that grants permission to 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	FindingId *string
	// contains filtered or unexported fields
}

type DescribeAuditFindingOutput 

type DescribeAuditFindingOutput struct {

	// The findings (results) of the audit.
	Finding *types.AuditFinding

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAuditMitigationActionsTaskInput 

type DescribeAuditMitigationActionsTaskInput struct {

	// The unique identifier for the audit mitigation task.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type DescribeAuditMitigationActionsTaskOutput 

type DescribeAuditMitigationActionsTaskOutput struct {

	// Specifies the mitigation actions and their parameters that are applied as part
	// of this task.
	ActionsDefinition []types.MitigationAction

	// 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

	// The date and time when the task was started.
	StartTime *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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAuditSuppressionInput added in v0.29.0 

type DescribeAuditSuppressionInput struct {

	// An audit check name. 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.)
	//
	// This member is required.
	CheckName *string

	// Information that identifies the noncompliant resource.
	//
	// This member is required.
	ResourceIdentifier *types.ResourceIdentifier
	// contains filtered or unexported fields
}

type DescribeAuditSuppressionOutput added in v0.29.0 

type DescribeAuditSuppressionOutput struct {

	// An audit check name. 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.)
	CheckName *string

	//  The description of the audit suppression.
	Description *string

	//  The epoch timestamp in seconds at which this suppression expires.
	ExpirationDate *time.Time

	// Information that identifies the noncompliant resource.
	ResourceIdentifier *types.ResourceIdentifier

	//  Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAuditTaskInput 

type DescribeAuditTaskInput struct {

	// The ID of the audit whose information you want to get.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type DescribeAuditTaskOutput 

type DescribeAuditTaskOutput struct {

	// Detailed information about each check performed during this audit.
	AuditDetails map[string]types.AuditCheckDetails

	// The name of the scheduled audit (only if the audit was a scheduled audit).
	ScheduledAuditName *string

	// The time the audit started.
	TaskStartTime *time.Time

	// Statistical information about the audit.
	TaskStatistics *types.TaskStatistics

	// The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or
	// "CANCELED".
	TaskStatus types.AuditTaskStatus

	// The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
	TaskType types.AuditTaskType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAuthorizerInput 

type DescribeAuthorizerInput struct {

	// The name of the authorizer to describe.
	//
	// This member is required.
	AuthorizerName *string
	// contains filtered or unexported fields
}

type DescribeAuthorizerOutput 

type DescribeAuthorizerOutput struct {

	// The authorizer description.
	AuthorizerDescription *types.AuthorizerDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBillingGroupInput 

type DescribeBillingGroupInput struct {

	// The name of the billing group.
	//
	// This member is required.
	BillingGroupName *string
	// contains filtered or unexported fields
}

type DescribeBillingGroupOutput 

type DescribeBillingGroupOutput struct {

	// The ARN of the billing group.
	BillingGroupArn *string

	// The ID of the billing group.
	BillingGroupId *string

	// Additional information about the billing group.
	BillingGroupMetadata *types.BillingGroupMetadata

	// The name of the billing group.
	BillingGroupName *string

	// The properties of the billing group.
	BillingGroupProperties *types.BillingGroupProperties

	// The version of the billing group.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCACertificateInput 

type DescribeCACertificateInput struct {

	// The CA certificate identifier.
	//
	// This member is required.
	CertificateId *string
	// contains filtered or unexported fields
}

The input for the DescribeCACertificate operation.

type DescribeCACertificateOutput 

type DescribeCACertificateOutput struct {

	// The CA certificate description.
	CertificateDescription *types.CACertificateDescription

	// Information about the registration configuration.
	RegistrationConfig *types.RegistrationConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.)
	//
	// This member is required.
	CertificateId *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output of the DescribeCertificate operation.

type DescribeCertificateProviderInput added in v1.47.0 

type DescribeCertificateProviderInput struct {

	// The name of the certificate provider.
	//
	// This member is required.
	CertificateProviderName *string
	// contains filtered or unexported fields
}

type DescribeCertificateProviderOutput added in v1.47.0 

type DescribeCertificateProviderOutput struct {

	// A list of the operations that the certificate provider will use to generate
	// certificates. Valid value: CreateCertificateFromCsr .
	AccountDefaultForOperations []types.CertificateProviderOperation

	// The ARN of the certificate provider.
	CertificateProviderArn *string

	// The name of the certificate provider.
	CertificateProviderName *string

	// The date-time string that indicates when the certificate provider was created.
	CreationDate *time.Time

	// The Lambda function ARN that's associated with the certificate provider.
	LambdaFunctionArn *string

	// The date-time string that indicates when the certificate provider was last
	// updated.
	LastModifiedDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCustomMetricInput added in v1.2.0 

type DescribeCustomMetricInput struct {

	//  The name of the custom metric.
	//
	// This member is required.
	MetricName *string
	// contains filtered or unexported fields
}

type DescribeCustomMetricOutput added in v1.2.0 

type DescribeCustomMetricOutput struct {

	//  The creation date of the custom metric in milliseconds since epoch.
	CreationDate *time.Time

	//  Field represents a friendly name in the console for the custom metric; doesn't
	// have to be unique. Don't use this name as the metric identifier in the device
	// metric report. Can be updated.
	DisplayName *string

	//  The time the custom metric was last modified in milliseconds since epoch.
	LastModifiedDate *time.Time

	//  The Amazon Resource Number (ARN) of the custom metric.
	MetricArn *string

	//  The name of the custom metric.
	MetricName *string

	//  The type of the custom metric.
	//
	// The type number only takes a single metric value as an input, but while
	// submitting the metrics value in the DeviceMetrics report, it must be passed as
	// an array with a single value.
	MetricType types.CustomMetricType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDefaultAuthorizerInput 

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

type DescribeDefaultAuthorizerOutput 

type DescribeDefaultAuthorizerOutput struct {

	// The default authorizer's description.
	AuthorizerDescription *types.AuthorizerDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDetectMitigationActionsTaskInput added in v1.2.0 

type DescribeDetectMitigationActionsTaskInput struct {

	//  The unique identifier of the task.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type DescribeDetectMitigationActionsTaskOutput added in v1.2.0 

type DescribeDetectMitigationActionsTaskOutput struct {

	//  The description of a task.
	TaskSummary *types.DetectMitigationActionsTaskSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDimensionInput 

type DescribeDimensionInput struct {

	// The unique identifier for the dimension.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DescribeDimensionOutput 

type DescribeDimensionOutput struct {

	// The Amazon Resource Name (ARN) for the dimension.
	Arn *string

	// The date the dimension was created.
	CreationDate *time.Time

	// The date the dimension was last modified.
	LastModifiedDate *time.Time

	// The unique identifier for the dimension.
	Name *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

	// The type of the dimension.
	Type types.DimensionType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDomainConfigurationInput 

type DescribeDomainConfigurationInput struct {

	// The name of the domain configuration.
	//
	// This member is required.
	DomainConfigurationName *string
	// contains filtered or unexported fields
}

type DescribeDomainConfigurationOutput 

type DescribeDomainConfigurationOutput struct {

	// An enumerated string that specifies the application-layer protocol.
	//
	//   - SECURE_MQTT - MQTT over TLS.
	//
	//   - MQTT_WSS - MQTT over WebSocket.
	//
	//   - HTTPS - HTTP over TLS.
	//
	//   - DEFAULT - Use a combination of port and Application Layer Protocol
	//   Negotiation (ALPN) to specify application_layer protocol. For more information,
	//   see [Device communication protocols].
	//
	// [Device communication protocols]: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html
	ApplicationProtocol types.ApplicationProtocol

	// An enumerated string that specifies the authentication type.
	//
	//   - CUSTOM_AUTH_X509 - Use custom authentication and authorization with
	//   additional details from the X.509 client certificate.
	//
	//   - CUSTOM_AUTH - Use custom authentication and authorization. For more
	//   information, see [Custom authentication and authorization].
	//
	//   - AWS_X509 - Use X.509 client certificates without custom authentication and
	//   authorization. For more information, see [X.509 client certificates].
	//
	//   - AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more
	//   information, see [IAM users, groups, and roles].
	//
	//   - DEFAULT - Use a combination of port and Application Layer Protocol
	//   Negotiation (ALPN) to specify authentication type. For more information, see [Device communication protocols].
	//
	// [Custom authentication and authorization]: https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
	// [X.509 client certificates]: https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html
	// [IAM users, groups, and roles]: https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
	// [Device communication protocols]: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html
	AuthenticationType types.AuthenticationType

	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *types.AuthorizerConfig

	// An object that specifies the client certificate configuration for a domain.
	ClientCertificateConfig *types.ClientCertificateConfig

	// The ARN of the domain configuration.
	DomainConfigurationArn *string

	// The name of the domain configuration.
	DomainConfigurationName *string

	// A Boolean value that specifies the current state of the domain configuration.
	DomainConfigurationStatus types.DomainConfigurationStatus

	// The name of the domain.
	DomainName *string

	// The type of the domain.
	DomainType types.DomainType

	// The date and time the domain configuration's status was last changed.
	LastStatusChangeDate *time.Time

	// The server certificate configuration.
	ServerCertificateConfig *types.ServerCertificateConfig

	// A list containing summary information about the server certificate included in
	// the domain configuration.
	ServerCertificates []types.ServerCertificateSummary

	// The type of service delivered by the endpoint.
	ServiceType types.ServiceType

	// An object that specifies the TLS configuration for a domain.
	TlsConfig *types.TlsConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 IoT credentials provider API endpoint.
	//
	//   - iot:Jobs - Returns an 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. ATS Signed Certificates are more secure and are trusted by most
	// popular browsers.
	EndpointType *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the DescribeEndpoint operation.

type DescribeEventConfigurationsInput 

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

type DescribeEventConfigurationsOutput 

type DescribeEventConfigurationsOutput struct {

	// The creation date of the event configuration.
	CreationDate *time.Time

	// The event configurations.
	EventConfigurations map[string]types.Configuration

	// The date the event configurations were last modified.
	LastModifiedDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFleetMetricInput added in v1.11.0 

type DescribeFleetMetricInput struct {

	// The name of the fleet metric to describe.
	//
	// This member is required.
	MetricName *string
	// contains filtered or unexported fields
}

type DescribeFleetMetricOutput added in v1.11.0 

type DescribeFleetMetricOutput struct {

	// The field to aggregate.
	AggregationField *string

	// The type of the aggregation query.
	AggregationType *types.AggregationType

	// The date when the fleet metric is created.
	CreationDate *time.Time

	// The fleet metric description.
	Description *string

	// The name of the index to search.
	IndexName *string

	// The date when the fleet metric is last modified.
	LastModifiedDate *time.Time

	// The ARN of the fleet metric to describe.
	MetricArn *string

	// The name of the fleet metric to describe.
	MetricName *string

	// The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
	// day)] and must be multiple of 60.
	Period *int32

	// The search query string.
	QueryString *string

	// The query version.
	QueryVersion *string

	// Used to support unit transformation such as milliseconds to seconds. The unit
	// must be supported by [CW metric].
	//
	// [CW metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
	Unit types.FleetMetricUnit

	// The version of the fleet metric.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeIndexInput 

type DescribeIndexInput struct {

	// The index name.
	//
	// This member is required.
	IndexName *string
	// contains filtered or unexported fields
}

type DescribeIndexOutput 

type DescribeIndexOutput struct {

	// The index name.
	IndexName *string

	// The index status.
	IndexStatus types.IndexStatus

	// 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.
	//
	//   - MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For
	//   more information, see [GetIndexingConfiguration].
	//
	// [GetIndexingConfiguration]: https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html
	Schema *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeJobExecutionInput 

type DescribeJobExecutionInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// This member is required.
	JobId *string

	// The name of the thing on which the job execution is running.
	//
	// This member is required.
	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
	// contains filtered or unexported fields
}

type DescribeJobExecutionOutput 

type DescribeJobExecutionOutput struct {

	// Information about the job execution.
	Execution *types.JobExecution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeJobInput 

type DescribeJobInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// This member is required.
	JobId *string

	// Provides a view of the job document before and after the substitution
	// parameters have been resolved with their exact values.
	BeforeSubstitution bool
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DescribeJobTemplateInput added in v1.6.0 

type DescribeJobTemplateInput struct {

	// The unique identifier of the job template.
	//
	// This member is required.
	JobTemplateId *string
	// contains filtered or unexported fields
}

type DescribeJobTemplateOutput added in v1.6.0 

type DescribeJobTemplateOutput struct {

	// The criteria that determine when and how a job abort takes place.
	AbortConfig *types.AbortConfig

	// The time, in seconds since the epoch, when the job template was created.
	CreatedAt *time.Time

	// A description of the job template.
	Description *string

	// The package version Amazon Resource Names (ARNs) that are installed on the
	// device when the job successfully completes. The package version must be in
	// either the Published or Deprecated state when the job deploys. For more
	// information, see [Package version lifecycle].
	//
	// Note:The following Length Constraints relates to a single ARN. Up to 25 package
	// version ARNs are allowed.
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	DestinationPackageVersions []string

	// The job document.
	Document *string

	// An S3 link to the job document.
	DocumentSource *string

	// The configuration that determines how many retries are allowed for each failure
	// type for a job.
	JobExecutionsRetryConfig *types.JobExecutionsRetryConfig

	// Allows you to create a staged rollout of a job.
	JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig

	// The ARN of the job template.
	JobTemplateArn *string

	// The unique identifier of the job template.
	JobTemplateId *string

	// Allows you to configure an optional maintenance window for the rollout of a job
	// document to all devices in the target group for a job.
	MaintenanceWindows []types.MaintenanceWindow

	// Configuration for pre-signed S3 URLs.
	PresignedUrlConfig *types.PresignedUrlConfig

	// 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 .
	TimeoutConfig *types.TimeoutConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeManagedJobTemplateInput added in v1.17.0 

type DescribeManagedJobTemplateInput struct {

	// The unique name of a managed job template, which is required.
	//
	// This member is required.
	TemplateName *string

	// An optional parameter to specify version of a managed template. If not
	// specified, the pre-defined default version is returned.
	TemplateVersion *string
	// contains filtered or unexported fields
}

type DescribeManagedJobTemplateOutput added in v1.17.0 

type DescribeManagedJobTemplateOutput struct {

	// The unique description of a managed template.
	Description *string

	// The document schema for a managed job template.
	Document *string

	// A map of key-value pairs that you can use as guidance to specify the inputs for
	// creating a job from a managed template.
	//
	// documentParameters can only be used when creating jobs from Amazon Web Services
	// managed templates. This parameter can't be used with custom job templates or to
	// create jobs from them.
	DocumentParameters []types.DocumentParameter

	// A list of environments that are supported with the managed job template.
	Environments []string

	// The unique Amazon Resource Name (ARN) of the managed template.
	TemplateArn *string

	// The unique name of a managed template, such as AWS-Reboot .
	TemplateName *string

	// The version for a managed template.
	TemplateVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeMitigationActionInput 

type DescribeMitigationActionInput struct {

	// The friendly name that uniquely identifies the mitigation action.
	//
	// This member is required.
	ActionName *string
	// contains filtered or unexported fields
}

type DescribeMitigationActionOutput 

type DescribeMitigationActionOutput struct {

	// The ARN that identifies this migration action.
	ActionArn *string

	// A unique identifier for this action.
	ActionId *string

	// The friendly name that uniquely identifies the mitigation action.
	ActionName *string

	// Parameters that control how the mitigation action is applied, specific to the
	// type of mitigation action.
	ActionParams *types.MitigationActionParams

	// The type of mitigation action.
	ActionType types.MitigationActionType

	// The date and time when the mitigation action was added to your Amazon Web
	// Services accounts.
	CreationDate *time.Time

	// The date and time when the mitigation action was last changed.
	LastModifiedDate *time.Time

	// The ARN of the IAM role used to apply this action.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeProvisioningTemplateInput 

type DescribeProvisioningTemplateInput struct {

	// The name of the provisioning template.
	//
	// This member is required.
	TemplateName *string
	// contains filtered or unexported fields
}

type DescribeProvisioningTemplateOutput 

type DescribeProvisioningTemplateOutput struct {

	// The date when the provisioning template was created.
	CreationDate *time.Time

	// The default fleet template version ID.
	DefaultVersionId *int32

	// The description of the provisioning template.
	Description *string

	// True if the provisioning template is enabled, otherwise false.
	Enabled *bool

	// The date when the provisioning template was last modified.
	LastModifiedDate *time.Time

	// Gets information about a pre-provisioned hook.
	PreProvisioningHook *types.ProvisioningHook

	// The ARN of the role associated with the provisioning template. This IoT role
	// grants permission to provision a device.
	ProvisioningRoleArn *string

	// The ARN of the provisioning template.
	TemplateArn *string

	// The JSON formatted contents of the provisioning template.
	TemplateBody *string

	// The name of the provisioning template.
	TemplateName *string

	// The type you define in a provisioning template. You can create a template with
	// only one type. You can't change the template type after its creation. The
	// default value is FLEET_PROVISIONING . For more information about provisioning
	// template, see: [Provisioning template].
	//
	// [Provisioning template]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html
	Type types.TemplateType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeProvisioningTemplateVersionInput 

type DescribeProvisioningTemplateVersionInput struct {

	// The template name.
	//
	// This member is required.
	TemplateName *string

	// The provisioning template version ID.
	//
	// This member is required.
	VersionId *int32
	// contains filtered or unexported fields
}

type DescribeProvisioningTemplateVersionOutput 

type DescribeProvisioningTemplateVersionOutput struct {

	// The date when the provisioning template version was created.
	CreationDate *time.Time

	// True if the provisioning template version is the default version.
	IsDefaultVersion bool

	// The JSON formatted contents of the provisioning template version.
	TemplateBody *string

	// The provisioning template version ID.
	VersionId *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRoleAliasInput 

type DescribeRoleAliasInput struct {

	// The role alias to describe.
	//
	// This member is required.
	RoleAlias *string
	// contains filtered or unexported fields
}

type DescribeRoleAliasOutput 

type DescribeRoleAliasOutput struct {

	// The role alias description.
	RoleAliasDescription *types.RoleAliasDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeScheduledAuditInput 

type DescribeScheduledAuditInput struct {

	// The name of the scheduled audit whose information you want to get.
	//
	// This member is required.
	ScheduledAuditName *string
	// contains filtered or unexported fields
}

type DescribeScheduledAuditOutput 

type DescribeScheduledAuditOutput struct {

	// The day of the month on which the scheduled audit takes place. This is 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 day of the week on which the scheduled audit takes place, either one of SUN
	// , MON , TUE , WED , THU , FRI , or SAT .
	DayOfWeek types.DayOfWeek

	// How often the scheduled audit takes place, either one of DAILY , WEEKLY ,
	// BIWEEKLY , or MONTHLY . The start time of each audit is determined by the system.
	Frequency types.AuditFrequency

	// The ARN of the scheduled audit.
	ScheduledAuditArn *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
	// contains filtered or unexported fields
}

type DescribeSecurityProfileInput 

type DescribeSecurityProfileInput struct {

	// The name of the security profile whose information you want to get.
	//
	// This member is required.
	SecurityProfileName *string
	// contains filtered or unexported fields
}

type DescribeSecurityProfileOutput 

type DescribeSecurityProfileOutput struct {

	//  Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
	//
	// 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.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []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

	// 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

	// The time the security profile was created.
	CreationDate *time.Time

	// The time the security profile was last modified.
	LastModifiedDate *time.Time

	// Specifies the MQTT topic and role ARN required for metric export.
	MetricsExportConfig *types.MetricsExportConfig

	// The ARN of the security profile.
	SecurityProfileArn *string

	// A description of the security profile (associated with the security profile
	// when it was created or updated).
	SecurityProfileDescription *string

	// The name of the security profile.
	SecurityProfileName *string

	// The version of the security profile. A new version is generated whenever the
	// security profile is updated.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeStreamInput 

type DescribeStreamInput struct {

	// The stream ID.
	//
	// This member is required.
	StreamId *string
	// contains filtered or unexported fields
}

type DescribeStreamOutput 

type DescribeStreamOutput struct {

	// Information about the stream.
	StreamInfo *types.StreamInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeThingGroupInput 

type DescribeThingGroupInput struct {

	// The name of the thing group.
	//
	// This member is required.
	ThingGroupName *string
	// contains filtered or unexported fields
}

type DescribeThingGroupOutput 

type DescribeThingGroupOutput struct {

	// The dynamic thing group index name.
	IndexName *string

	// The dynamic thing group search query string.
	QueryString *string

	// The dynamic thing group query version.
	QueryVersion *string

	// The dynamic thing group status.
	Status types.DynamicGroupStatus

	// The thing group ARN.
	ThingGroupArn *string

	// The thing group ID.
	ThingGroupId *string

	// Thing group metadata.
	ThingGroupMetadata *types.ThingGroupMetadata

	// The name of the thing group.
	ThingGroupName *string

	// The thing group properties.
	ThingGroupProperties *types.ThingGroupProperties

	// The version of the thing group.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeThingInput 

type DescribeThingInput struct {

	// The name of the thing.
	//
	// This member is required.
	ThingName *string
	// contains filtered or unexported fields
}

The input for the DescribeThing operation.

type DescribeThingOutput 

type DescribeThingOutput struct {

	// The thing attributes.
	Attributes map[string]string

	// The name of the billing group the thing belongs to.
	BillingGroupName *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 IoT fleet without removing the flexibility
	// of the underlying device certificate model or shadows.
	DefaultClientId *string

	// The ARN of the thing to describe.
	ThingArn *string

	// The ID of the thing to describe.
	ThingId *string

	// The name of the thing.
	ThingName *string

	// The thing type name.
	ThingTypeName *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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the DescribeThing operation.

type DescribeThingRegistrationTaskInput 

type DescribeThingRegistrationTaskInput struct {

	// The task ID.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type DescribeThingRegistrationTaskOutput 

type DescribeThingRegistrationTaskOutput struct {

	// The task creation date.
	CreationDate *time.Time

	// The number of things that failed to be provisioned.
	FailureCount int32

	// The S3 bucket that contains the input file.
	InputFileBucket *string

	// The input file key.
	InputFileKey *string

	// The date when the task was last modified.
	LastModifiedDate *time.Time

	// The message.
	Message *string

	// The progress of the bulk provisioning task expressed as a percentage.
	PercentageProgress int32

	// The role ARN that grants access to the input file bucket.
	RoleArn *string

	// The status of the bulk thing provisioning task.
	Status types.Status

	// The number of things successfully provisioned.
	SuccessCount int32

	// The task ID.
	TaskId *string

	// The task's template.
	TemplateBody *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeThingTypeInput 

type DescribeThingTypeInput struct {

	// The name of the thing type.
	//
	// This member is required.
	ThingTypeName *string
	// contains filtered or unexported fields
}

The input for the DescribeThingType operation.

type DescribeThingTypeOutput 

type DescribeThingTypeOutput struct {

	// The thing type ARN.
	ThingTypeArn *string

	// 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 ThingTypeProperties contains information about the thing type including
	// description, a list of searchable thing attribute names, and MQTT5
	// configuration.
	ThingTypeProperties *types.ThingTypeProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output for the DescribeThingType operation.

type DetachPolicyInput 

type DetachPolicyInput struct {

	// The policy to detach.
	//
	// This member is required.
	PolicyName *string

	// The target from which the policy will be detached.
	//
	// This member is required.
	Target *string
	// contains filtered or unexported fields
}

type DetachPolicyOutput 

type DetachPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetachPrincipalPolicyInput 

type DetachPrincipalPolicyInput struct {

	// The name of the policy to detach.
	//
	// This member is required.
	PolicyName *string

	// The principal.
	//
	// Valid principals are CertificateArn
	// (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
	// (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
	//
	// This member is required.
	Principal *string
	// contains filtered or unexported fields
}

The input for the DetachPrincipalPolicy operation.

type DetachPrincipalPolicyOutput 

type DetachPrincipalPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetachSecurityProfileInput 

type DetachSecurityProfileInput struct {

	// The security profile that is detached.
	//
	// This member is required.
	SecurityProfileName *string

	// The ARN of the thing group from which the security profile is detached.
	//
	// This member is required.
	SecurityProfileTargetArn *string
	// contains filtered or unexported fields
}

type DetachSecurityProfileOutput 

type DetachSecurityProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DetachThingPrincipalInput 

type DetachThingPrincipalInput struct {

	// 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.
	//
	// This member is required.
	Principal *string

	// The name of the thing.
	//
	// This member is required.
	ThingName *string
	// contains filtered or unexported fields
}

The input for the DetachThingPrincipal operation.

type DetachThingPrincipalOutput 

type DetachThingPrincipalOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the DetachThingPrincipal operation.

type DisableTopicRuleInput 

type DisableTopicRuleInput struct {

	// The name of the rule to disable.
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

The input for the DisableTopicRuleRequest operation.

type DisableTopicRuleOutput 

type DisableTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateSbomFromPackageVersionInput added in v1.56.0 

type DisassociateSbomFromPackageVersionInput struct {

	// The name of the new software package.
	//
	// This member is required.
	PackageName *string

	// The name of the new package version.
	//
	// This member is required.
	VersionName *string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string
	// contains filtered or unexported fields
}

type DisassociateSbomFromPackageVersionOutput added in v1.56.0 

type DisassociateSbomFromPackageVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableTopicRuleInput 

type EnableTopicRuleInput struct {

	// The name of the topic rule to enable.
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

The input for the EnableTopicRuleRequest operation.

type EnableTopicRuleOutput 

type EnableTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.39.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.39.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.39.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.39.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.39.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetBehaviorModelTrainingSummariesAPIClient added in v1.2.0 

type GetBehaviorModelTrainingSummariesAPIClient interface {
	GetBehaviorModelTrainingSummaries(context.Context, *GetBehaviorModelTrainingSummariesInput, ...func(*Options)) (*GetBehaviorModelTrainingSummariesOutput, error)
}

GetBehaviorModelTrainingSummariesAPIClient is a client that implements the GetBehaviorModelTrainingSummaries operation.

type GetBehaviorModelTrainingSummariesInput added in v1.2.0 

type GetBehaviorModelTrainingSummariesInput struct {

	//  The maximum number of results to return at one time. The default is 10.
	MaxResults *int32

	//  The token for the next set of results.
	NextToken *string

	//  The name of the security profile.
	SecurityProfileName *string
	// contains filtered or unexported fields
}

type GetBehaviorModelTrainingSummariesOutput added in v1.2.0 

type GetBehaviorModelTrainingSummariesOutput 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 all ML Detect behaviors and their model status for a given Security
	// Profile.
	Summaries []types.BehaviorModelTrainingSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetBehaviorModelTrainingSummariesPaginator added in v1.2.0 

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

GetBehaviorModelTrainingSummariesPaginator is a paginator for GetBehaviorModelTrainingSummaries

func NewGetBehaviorModelTrainingSummariesPaginator added in v1.2.0 

func NewGetBehaviorModelTrainingSummariesPaginator(client GetBehaviorModelTrainingSummariesAPIClient, params *GetBehaviorModelTrainingSummariesInput, optFns ...func(*GetBehaviorModelTrainingSummariesPaginatorOptions)) *GetBehaviorModelTrainingSummariesPaginator

NewGetBehaviorModelTrainingSummariesPaginator returns a new GetBehaviorModelTrainingSummariesPaginator

func (*GetBehaviorModelTrainingSummariesPaginator) HasMorePages added in v1.2.0 

func (p *GetBehaviorModelTrainingSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetBehaviorModelTrainingSummariesPaginator) NextPage added in v1.2.0 

func (p *GetBehaviorModelTrainingSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetBehaviorModelTrainingSummariesOutput, error)

NextPage retrieves the next GetBehaviorModelTrainingSummaries page.

type GetBehaviorModelTrainingSummariesPaginatorOptions added in v1.2.0 

type GetBehaviorModelTrainingSummariesPaginatorOptions struct {
	//  The maximum number of results to return at one time. The default is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetBehaviorModelTrainingSummariesPaginatorOptions is the paginator options for GetBehaviorModelTrainingSummaries

type GetBucketsAggregationInput added in v1.11.0 

type GetBucketsAggregationInput struct {

	// The aggregation field.
	//
	// This member is required.
	AggregationField *string

	// The basic control of the response shape and the bucket aggregation type to
	// perform.
	//
	// This member is required.
	BucketsAggregationType *types.BucketsAggregationType

	// The search query string.
	//
	// This member is required.
	QueryString *string

	// The name of the index to search.
	IndexName *string

	// The version of the query.
	QueryVersion *string
	// contains filtered or unexported fields
}

type GetBucketsAggregationOutput added in v1.11.0 

type GetBucketsAggregationOutput struct {

	// The main part of the response with a list of buckets. Each bucket contains a
	// keyValue and a count .
	//
	// keyValue : The aggregation field value counted for the particular bucket.
	//
	// count : The number of documents that have that value.
	Buckets []types.Bucket

	// The total number of things that fit the query string criteria.
	TotalCount int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCardinalityInput 

type GetCardinalityInput struct {

	// The search query string.
	//
	// This member is required.
	QueryString *string

	// The field to aggregate.
	AggregationField *string

	// The name of the index to search.
	IndexName *string

	// The query version.
	QueryVersion *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetCommandExecutionInput added in v1.61.0 

type GetCommandExecutionInput struct {

	// The unique identifier for the command execution. This information is returned
	// as a response of the StartCommandExecution API request.
	//
	// This member is required.
	ExecutionId *string

	// The Amazon Resource Number (ARN) of the device on which the command execution
	// is being performed.
	//
	// This member is required.
	TargetArn *string

	// Can be used to specify whether to include the result of the command execution
	// in the GetCommandExecution API response. Your device can use this field to
	// provide additional information about the command execution. You only need to
	// specify this field when using the AWS-IoT namespace.
	IncludeResult *bool
	// contains filtered or unexported fields
}

type GetCommandExecutionOutput added in v1.61.0 

type GetCommandExecutionOutput struct {

	// The Amazon Resource Number (ARN) of the command. For example,
	// arn:aws:iot:::command/
	CommandArn *string

	// The timestamp, when the command execution was completed.
	CompletedAt *time.Time

	// The timestamp, when the command execution was created.
	CreatedAt *time.Time

	// The unique identifier of the command execution.
	ExecutionId *string

	// Specifies the amount of time in seconds that the device can take to finish a
	// command execution. A timer starts when the command execution is created. If the
	// command execution status is not set to another terminal state before the timer
	// expires, it will automatically update to TIMED_OUT .
	ExecutionTimeoutSeconds *int64

	// The timestamp, when the command execution was last updated.
	LastUpdatedAt *time.Time

	// The list of parameters that the StartCommandExecution API used when performing
	// the command on the device.
	Parameters map[string]types.CommandParameterValue

	// The result value for the current state of the command execution. The status
	// provides information about the progress of the command execution. The device can
	// use the result field to share additional details about the execution such as a
	// return value of a remote function call.
	//
	// If you use the AWS-IoT-FleetWise namespace, then this field is not applicable
	// in the API response.
	Result map[string]types.CommandExecutionResult

	// The timestamp, when the command execution was started.
	StartedAt *time.Time

	// The status of the command execution. After your devices receive the command and
	// start performing the operations specified in the command, it can use the
	// UpdateCommandExecution MQTT API to update the status information.
	Status types.CommandExecutionStatus

	// Your devices can use this parameter to provide additional context about the
	// status of a command execution using a reason code and description.
	StatusReason *types.StatusReason

	// The Amazon Resource Number (ARN) of the device on which the command execution
	// is being performed.
	TargetArn *string

	// The time to live (TTL) parameter for the GetCommandExecution API.
	TimeToLive *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCommandInput added in v1.61.0 

type GetCommandInput struct {

	// The unique identifier of the command for which you want to retrieve information.
	//
	// This member is required.
	CommandId *string
	// contains filtered or unexported fields
}

type GetCommandOutput added in v1.61.0 

type GetCommandOutput struct {

	// The Amazon Resource Number (ARN) of the command. For example,
	// arn:aws:iot:::command/
	CommandArn *string

	// The unique identifier of the command.
	CommandId *string

	// The timestamp, when the command was created.
	CreatedAt *time.Time

	// Indicates whether the command has been deprecated.
	Deprecated *bool

	// A short text description of the command.
	Description *string

	// The user-friendly name in the console for the command.
	DisplayName *string

	// The timestamp, when the command was last updated.
	LastUpdatedAt *time.Time

	// A list of parameters for the command created.
	MandatoryParameters []types.CommandParameter

	// The namespace of the command.
	Namespace types.CommandNamespace

	// The payload object that you provided for the command.
	Payload *types.CommandPayload

	// Indicates whether the command is being deleted.
	PendingDeletion *bool

	// The IAM role that allows access to retrieve information about the command.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEffectivePoliciesInput 

type GetEffectivePoliciesInput struct {

	// The Cognito identity pool ID.
	CognitoIdentityPoolId *string

	// The principal. Valid principals are CertificateArn
	// (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
	// (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
	Principal *string

	// The thing name.
	ThingName *string
	// contains filtered or unexported fields
}

type GetEffectivePoliciesOutput 

type GetEffectivePoliciesOutput struct {

	// The effective policies.
	EffectivePolicies []types.EffectivePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetIndexingConfigurationInput 

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

type GetIndexingConfigurationOutput 

type GetIndexingConfigurationOutput struct {

	// The index configuration.
	ThingGroupIndexingConfiguration *types.ThingGroupIndexingConfiguration

	// Thing indexing configuration.
	ThingIndexingConfiguration *types.ThingIndexingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetJobDocumentInput 

type GetJobDocumentInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// This member is required.
	JobId *string

	// Provides a view of the job document before and after the substitution
	// parameters have been resolved with their exact values.
	BeforeSubstitution bool
	// contains filtered or unexported fields
}

type GetJobDocumentOutput 

type GetJobDocumentOutput struct {

	// The job document content.
	Document *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLoggingOptionsInput 

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

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
	// contains filtered or unexported fields
}

The output from the GetLoggingOptions operation.

type GetOTAUpdateInput 

type GetOTAUpdateInput struct {

	// The OTA update ID.
	//
	// This member is required.
	OtaUpdateId *string
	// contains filtered or unexported fields
}

type GetOTAUpdateOutput 

type GetOTAUpdateOutput struct {

	// The OTA update info.
	OtaUpdateInfo *types.OTAUpdateInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPackageConfigurationInput added in v1.38.0 

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

type GetPackageConfigurationOutput added in v1.38.0 

type GetPackageConfigurationOutput struct {

	// The version that is associated to a specific job.
	VersionUpdateByJobsConfig *types.VersionUpdateByJobsConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPackageInput added in v1.38.0 

type GetPackageInput struct {

	// The name of the target software package.
	//
	// This member is required.
	PackageName *string
	// contains filtered or unexported fields
}

type GetPackageOutput added in v1.38.0 

type GetPackageOutput struct {

	// The date the package was created.
	CreationDate *time.Time

	// The name of the default package version.
	DefaultVersionName *string

	// The package description.
	Description *string

	// The date when the package was last updated.
	LastModifiedDate *time.Time

	// The ARN for the package.
	PackageArn *string

	// The name of the software package.
	PackageName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPackageVersionInput added in v1.38.0 

type GetPackageVersionInput struct {

	// The name of the associated package.
	//
	// This member is required.
	PackageName *string

	// The name of the target package version.
	//
	// This member is required.
	VersionName *string
	// contains filtered or unexported fields
}

type GetPackageVersionOutput added in v1.38.0 

type GetPackageVersionOutput struct {

	// The various components that make up a software package version.
	Artifact *types.PackageVersionArtifact

	// Metadata that were added to the package version that can be used to define a
	// package version’s configuration.
	Attributes map[string]string

	// The date when the package version was created.
	CreationDate *time.Time

	// The package version description.
	Description *string

	// Error reason for a package version failure during creation or update.
	ErrorReason *string

	// The date when the package version was last updated.
	LastModifiedDate *time.Time

	// The name of the software package.
	PackageName *string

	// The ARN for the package version.
	PackageVersionArn *string

	// The inline job document associated with a software package version used for a
	// quick job deployment.
	Recipe *string

	// The software bill of materials for a software package version.
	Sbom *types.Sbom

	// The status of the validation for a new software bill of materials added to a
	// software package version.
	SbomValidationStatus types.SbomValidationStatus

	// The status associated to the package version. For more information, see [Package version lifecycle].
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	Status types.PackageVersionStatus

	// The name of the package version.
	VersionName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPercentilesInput 

type GetPercentilesInput struct {

	// The search query string.
	//
	// This member is required.
	QueryString *string

	// The field to aggregate.
	AggregationField *string

	// The name of the index to search.
	IndexName *string

	// The percentile groups returned.
	Percents []float64

	// The query version.
	QueryVersion *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetPolicyInput 

type GetPolicyInput struct {

	// The name of the policy.
	//
	// This member is required.
	PolicyName *string
	// contains filtered or unexported fields
}

The input for the GetPolicy operation.

type GetPolicyOutput 

type GetPolicyOutput struct {

	// The date the policy was created.
	CreationDate *time.Time

	// The default policy version ID.
	DefaultVersionId *string

	// The generation ID of the policy.
	GenerationId *string

	// The date the policy was last modified.
	LastModifiedDate *time.Time

	// The policy ARN.
	PolicyArn *string

	// The JSON document that describes the policy.
	PolicyDocument *string

	// The policy name.
	PolicyName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the GetPolicy operation.

type GetPolicyVersionInput 

type GetPolicyVersionInput struct {

	// The name of the policy.
	//
	// This member is required.
	PolicyName *string

	// The policy version ID.
	//
	// This member is required.
	PolicyVersionId *string
	// contains filtered or unexported fields
}

The input for the GetPolicyVersion operation.

type GetPolicyVersionOutput 

type GetPolicyVersionOutput struct {

	// The date the policy was created.
	CreationDate *time.Time

	// The generation ID of the policy version.
	GenerationId *string

	// Specifies whether the policy version is the default.
	IsDefaultVersion bool

	// The date the policy was last modified.
	LastModifiedDate *time.Time

	// The policy ARN.
	PolicyArn *string

	// The JSON document that describes the policy.
	PolicyDocument *string

	// The policy name.
	PolicyName *string

	// The policy version ID.
	PolicyVersionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the GetPolicyVersion operation.

type GetRegistrationCodeInput 

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

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
	// contains filtered or unexported fields
}

The output from the GetRegistrationCode operation.

type GetStatisticsInput 

type GetStatisticsInput struct {

	// The query used to search. You can specify "*" for the query string to get the
	// count of all indexed things in your Amazon Web Services account.
	//
	// This member is required.
	QueryString *string

	// The aggregation field name.
	AggregationField *string

	// The name of the index to search. The default value is AWS_Things .
	IndexName *string

	// The version of the query used to search.
	QueryVersion *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetTopicRuleDestinationInput 

type GetTopicRuleDestinationInput struct {

	// The ARN of the topic rule destination.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetTopicRuleDestinationOutput 

type GetTopicRuleDestinationOutput struct {

	// The topic rule destination.
	TopicRuleDestination *types.TopicRuleDestination

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTopicRuleInput 

type GetTopicRuleInput struct {

	// The name of the rule.
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the GetTopicRule operation.

type GetV2LoggingOptionsInput 

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

type GetV2LoggingOptionsOutput 

type GetV2LoggingOptionsOutput struct {

	// The default log level.
	DefaultLogLevel types.LogLevel

	// Disables all logs.
	DisableAllLogs bool

	// The IAM role ARN IoT uses to write to your CloudWatch logs.
	RoleArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

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

IdempotencyTokenProvider interface for providing idempotency token

type ListActiveViolationsAPIClient added in v0.30.0 

type ListActiveViolationsAPIClient interface {
	ListActiveViolations(context.Context, *ListActiveViolationsInput, ...func(*Options)) (*ListActiveViolationsOutput, error)
}

ListActiveViolationsAPIClient is a client that implements the ListActiveViolations operation.

type ListActiveViolationsInput 

type ListActiveViolationsInput struct {

	//  The criteria for a behavior.
	BehaviorCriteriaType types.BehaviorCriteriaType

	//  A list of all suppressed alerts.
	ListSuppressedAlerts *bool

	// 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

	// The name of the thing whose active violations are listed.
	ThingName *string

	// The verification state of the violation (detect alarm).
	VerificationState types.VerificationState
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListActiveViolationsPaginator added in v0.30.0 

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

ListActiveViolationsPaginator is a paginator for ListActiveViolations

func NewListActiveViolationsPaginator added in v0.30.0 

func NewListActiveViolationsPaginator(client ListActiveViolationsAPIClient, params *ListActiveViolationsInput, optFns ...func(*ListActiveViolationsPaginatorOptions)) *ListActiveViolationsPaginator

NewListActiveViolationsPaginator returns a new ListActiveViolationsPaginator

func (*ListActiveViolationsPaginator) HasMorePages added in v0.30.0 

func (p *ListActiveViolationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListActiveViolationsPaginator) NextPage added in v0.30.0 

func (p *ListActiveViolationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListActiveViolationsOutput, error)

NextPage retrieves the next ListActiveViolations page.

type ListActiveViolationsPaginatorOptions added in v0.30.0 

type ListActiveViolationsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListActiveViolationsPaginatorOptions is the paginator options for ListActiveViolations

type ListAttachedPoliciesAPIClient added in v0.30.0 

type ListAttachedPoliciesAPIClient interface {
	ListAttachedPolicies(context.Context, *ListAttachedPoliciesInput, ...func(*Options)) (*ListAttachedPoliciesOutput, error)
}

ListAttachedPoliciesAPIClient is a client that implements the ListAttachedPolicies operation.

type ListAttachedPoliciesInput 

type ListAttachedPoliciesInput struct {

	// The group or principal for which the policies will be listed. Valid principals
	// are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId),
	// thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId
	// (region:id).
	//
	// This member is required.
	Target *string

	// The token to retrieve the next set of results.
	Marker *string

	// The maximum number of results to be returned per request.
	PageSize *int32

	// When true, recursively list attached policies.
	Recursive bool
	// contains filtered or unexported fields
}

type ListAttachedPoliciesOutput 

type ListAttachedPoliciesOutput struct {

	// The token to retrieve the next set of results, or “null“ if there are no more
	// results.
	NextMarker *string

	// The policies.
	Policies []types.Policy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAttachedPoliciesPaginator added in v0.30.0 

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

ListAttachedPoliciesPaginator is a paginator for ListAttachedPolicies

func NewListAttachedPoliciesPaginator added in v0.30.0 

func NewListAttachedPoliciesPaginator(client ListAttachedPoliciesAPIClient, params *ListAttachedPoliciesInput, optFns ...func(*ListAttachedPoliciesPaginatorOptions)) *ListAttachedPoliciesPaginator

NewListAttachedPoliciesPaginator returns a new ListAttachedPoliciesPaginator

func (*ListAttachedPoliciesPaginator) HasMorePages added in v0.30.0 

func (p *ListAttachedPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAttachedPoliciesPaginator) NextPage added in v0.30.0 

func (p *ListAttachedPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAttachedPoliciesOutput, error)

NextPage retrieves the next ListAttachedPolicies page.

type ListAttachedPoliciesPaginatorOptions added in v0.30.0 

type ListAttachedPoliciesPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAttachedPoliciesPaginatorOptions is the paginator options for ListAttachedPolicies

type ListAuditFindingsAPIClient added in v0.30.0 

type ListAuditFindingsAPIClient interface {
	ListAuditFindings(context.Context, *ListAuditFindingsInput, ...func(*Options)) (*ListAuditFindingsOutput, error)
}

ListAuditFindingsAPIClient is a client that implements the ListAuditFindings operation.

type ListAuditFindingsInput 

type ListAuditFindingsInput struct {

	// A filter to limit results to the findings for the specified audit check.
	CheckName *string

	// 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

	//  Boolean flag indicating whether only the suppressed findings or the
	// unsuppressed findings should be listed. If this parameter isn't provided, the
	// response will list both suppressed and unsuppressed findings.
	ListSuppressedFindings bool

	// 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

	// Information identifying the noncompliant resource.
	ResourceIdentifier *types.ResourceIdentifier

	// 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 audit with the specified ID. You must specify
	// either the taskId or the startTime and endTime, but not both.
	TaskId *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListAuditFindingsPaginator added in v0.30.0 

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

ListAuditFindingsPaginator is a paginator for ListAuditFindings

func NewListAuditFindingsPaginator added in v0.30.0 

func NewListAuditFindingsPaginator(client ListAuditFindingsAPIClient, params *ListAuditFindingsInput, optFns ...func(*ListAuditFindingsPaginatorOptions)) *ListAuditFindingsPaginator

NewListAuditFindingsPaginator returns a new ListAuditFindingsPaginator

func (*ListAuditFindingsPaginator) HasMorePages added in v0.30.0 

func (p *ListAuditFindingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAuditFindingsPaginator) NextPage added in v0.30.0 

func (p *ListAuditFindingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAuditFindingsOutput, error)

NextPage retrieves the next ListAuditFindings page.

type ListAuditFindingsPaginatorOptions added in v0.30.0 

type ListAuditFindingsPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAuditFindingsPaginatorOptions is the paginator options for ListAuditFindings

type ListAuditMitigationActionsExecutionsAPIClient added in v0.30.0 

type ListAuditMitigationActionsExecutionsAPIClient interface {
	ListAuditMitigationActionsExecutions(context.Context, *ListAuditMitigationActionsExecutionsInput, ...func(*Options)) (*ListAuditMitigationActionsExecutionsOutput, error)
}

ListAuditMitigationActionsExecutionsAPIClient is a client that implements the ListAuditMitigationActionsExecutions operation.

type ListAuditMitigationActionsExecutionsInput 

type ListAuditMitigationActionsExecutionsInput struct {

	// Specify this filter to limit results to those that were applied to a specific
	// audit finding.
	//
	// This member is required.
	FindingId *string

	// Specify this filter to limit results to actions for a specific audit mitigation
	// actions task.
	//
	// This member is required.
	TaskId *string

	// Specify this filter to limit results to those with a specific status.
	ActionStatus types.AuditMitigationActionsExecutionStatus

	// 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
	// contains filtered or unexported fields
}

type ListAuditMitigationActionsExecutionsOutput 

type ListAuditMitigationActionsExecutionsOutput struct {

	// 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

	// The token for the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAuditMitigationActionsExecutionsPaginator added in v0.30.0 

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

ListAuditMitigationActionsExecutionsPaginator is a paginator for ListAuditMitigationActionsExecutions

func NewListAuditMitigationActionsExecutionsPaginator added in v0.30.0 

func NewListAuditMitigationActionsExecutionsPaginator(client ListAuditMitigationActionsExecutionsAPIClient, params *ListAuditMitigationActionsExecutionsInput, optFns ...func(*ListAuditMitigationActionsExecutionsPaginatorOptions)) *ListAuditMitigationActionsExecutionsPaginator

NewListAuditMitigationActionsExecutionsPaginator returns a new ListAuditMitigationActionsExecutionsPaginator

func (*ListAuditMitigationActionsExecutionsPaginator) HasMorePages added in v0.30.0 

func (p *ListAuditMitigationActionsExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAuditMitigationActionsExecutionsPaginator) NextPage added in v0.30.0 

func (p *ListAuditMitigationActionsExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAuditMitigationActionsExecutionsOutput, error)

NextPage retrieves the next ListAuditMitigationActionsExecutions page.

type ListAuditMitigationActionsExecutionsPaginatorOptions added in v0.30.0 

type ListAuditMitigationActionsExecutionsPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAuditMitigationActionsExecutionsPaginatorOptions is the paginator options for ListAuditMitigationActionsExecutions

type ListAuditMitigationActionsTasksAPIClient added in v0.30.0 

type ListAuditMitigationActionsTasksAPIClient interface {
	ListAuditMitigationActionsTasks(context.Context, *ListAuditMitigationActionsTasksInput, ...func(*Options)) (*ListAuditMitigationActionsTasksOutput, error)
}

ListAuditMitigationActionsTasksAPIClient is a client that implements the ListAuditMitigationActionsTasks operation.

type ListAuditMitigationActionsTasksInput 

type ListAuditMitigationActionsTasksInput struct {

	// Specify this filter to limit results to tasks that were completed or canceled
	// on or before a specific date and time.
	//
	// This member is required.
	EndTime *time.Time

	// Specify this filter to limit results to tasks that began on or after a specific
	// date and time.
	//
	// This member is required.
	StartTime *time.Time

	// 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 were applied to a specific
	// audit finding.
	FindingId *string

	// 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

	// Specify this filter to limit results to tasks that are in a specific state.
	TaskStatus types.AuditMitigationActionsTaskStatus
	// contains filtered or unexported fields
}

type ListAuditMitigationActionsTasksOutput 

type ListAuditMitigationActionsTasksOutput struct {

	// The token for the next set of results.
	NextToken *string

	// The collection of audit mitigation tasks that matched the filter criteria.
	Tasks []types.AuditMitigationActionsTaskMetadata

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAuditMitigationActionsTasksPaginator added in v0.30.0 

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

ListAuditMitigationActionsTasksPaginator is a paginator for ListAuditMitigationActionsTasks

func NewListAuditMitigationActionsTasksPaginator added in v0.30.0 

func NewListAuditMitigationActionsTasksPaginator(client ListAuditMitigationActionsTasksAPIClient, params *ListAuditMitigationActionsTasksInput, optFns ...func(*ListAuditMitigationActionsTasksPaginatorOptions)) *ListAuditMitigationActionsTasksPaginator

NewListAuditMitigationActionsTasksPaginator returns a new ListAuditMitigationActionsTasksPaginator

func (*ListAuditMitigationActionsTasksPaginator) HasMorePages added in v0.30.0 

func (p *ListAuditMitigationActionsTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAuditMitigationActionsTasksPaginator) NextPage added in v0.30.0 

func (p *ListAuditMitigationActionsTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAuditMitigationActionsTasksOutput, error)

NextPage retrieves the next ListAuditMitigationActionsTasks page.

type ListAuditMitigationActionsTasksPaginatorOptions added in v0.30.0 

type ListAuditMitigationActionsTasksPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAuditMitigationActionsTasksPaginatorOptions is the paginator options for ListAuditMitigationActionsTasks

type ListAuditSuppressionsAPIClient added in v0.30.0 

type ListAuditSuppressionsAPIClient interface {
	ListAuditSuppressions(context.Context, *ListAuditSuppressionsInput, ...func(*Options)) (*ListAuditSuppressionsOutput, error)
}

ListAuditSuppressionsAPIClient is a client that implements the ListAuditSuppressions operation.

type ListAuditSuppressionsInput added in v0.29.0 

type ListAuditSuppressionsInput struct {

	//  Determines whether suppressions are listed in ascending order by expiration
	// date or not. If parameter isn't provided, ascendingOrder=true .
	AscendingOrder bool

	// An audit check name. 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.)
	CheckName *string

	//  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

	// Information that identifies the noncompliant resource.
	ResourceIdentifier *types.ResourceIdentifier
	// contains filtered or unexported fields
}

type ListAuditSuppressionsOutput added in v0.29.0 

type ListAuditSuppressionsOutput struct {

	//  A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string

	//  List of audit suppressions.
	Suppressions []types.AuditSuppression

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAuditSuppressionsPaginator added in v0.30.0 

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

ListAuditSuppressionsPaginator is a paginator for ListAuditSuppressions

func NewListAuditSuppressionsPaginator added in v0.30.0 

func NewListAuditSuppressionsPaginator(client ListAuditSuppressionsAPIClient, params *ListAuditSuppressionsInput, optFns ...func(*ListAuditSuppressionsPaginatorOptions)) *ListAuditSuppressionsPaginator

NewListAuditSuppressionsPaginator returns a new ListAuditSuppressionsPaginator

func (*ListAuditSuppressionsPaginator) HasMorePages added in v0.30.0 

func (p *ListAuditSuppressionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAuditSuppressionsPaginator) NextPage added in v0.30.0 

func (p *ListAuditSuppressionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAuditSuppressionsOutput, error)

NextPage retrieves the next ListAuditSuppressions page.

type ListAuditSuppressionsPaginatorOptions added in v0.30.0 

type ListAuditSuppressionsPaginatorOptions struct {
	//  The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAuditSuppressionsPaginatorOptions is the paginator options for ListAuditSuppressions

type ListAuditTasksAPIClient added in v0.30.0 

type ListAuditTasksAPIClient interface {
	ListAuditTasks(context.Context, *ListAuditTasksInput, ...func(*Options)) (*ListAuditTasksOutput, error)
}

ListAuditTasksAPIClient is a client that implements the ListAuditTasks operation.

type ListAuditTasksInput 

type ListAuditTasksInput struct {

	// The end of the time period.
	//
	// This member is required.
	EndTime *time.Time

	// The beginning of the time period. Audit information is retained for a limited
	// time (90 days). Requesting a start time prior to what is retained results in an
	// "InvalidRequestException".
	//
	// This member is required.
	StartTime *time.Time

	// 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

	// 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

	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListAuditTasksPaginator added in v0.30.0 

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

ListAuditTasksPaginator is a paginator for ListAuditTasks

func NewListAuditTasksPaginator added in v0.30.0 

func NewListAuditTasksPaginator(client ListAuditTasksAPIClient, params *ListAuditTasksInput, optFns ...func(*ListAuditTasksPaginatorOptions)) *ListAuditTasksPaginator

NewListAuditTasksPaginator returns a new ListAuditTasksPaginator

func (*ListAuditTasksPaginator) HasMorePages added in v0.30.0 

func (p *ListAuditTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAuditTasksPaginator) NextPage added in v0.30.0 

func (p *ListAuditTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAuditTasksOutput, error)

NextPage retrieves the next ListAuditTasks page.

type ListAuditTasksPaginatorOptions added in v0.30.0 

type ListAuditTasksPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAuditTasksPaginatorOptions is the paginator options for ListAuditTasks

type ListAuthorizersAPIClient added in v0.30.0 

type ListAuthorizersAPIClient interface {
	ListAuthorizers(context.Context, *ListAuthorizersInput, ...func(*Options)) (*ListAuthorizersOutput, error)
}

ListAuthorizersAPIClient is a client that implements the ListAuthorizers operation.

type ListAuthorizersInput 

type ListAuthorizersInput struct {

	// Return the list of authorizers in ascending alphabetical order.
	AscendingOrder bool

	// A marker used to get the next set of results.
	Marker *string

	// The maximum number of results to return at one time.
	PageSize *int32

	// The status of the list authorizers request.
	Status types.AuthorizerStatus
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListAuthorizersPaginator added in v0.30.0 

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

ListAuthorizersPaginator is a paginator for ListAuthorizers

func NewListAuthorizersPaginator added in v0.30.0 

func NewListAuthorizersPaginator(client ListAuthorizersAPIClient, params *ListAuthorizersInput, optFns ...func(*ListAuthorizersPaginatorOptions)) *ListAuthorizersPaginator

NewListAuthorizersPaginator returns a new ListAuthorizersPaginator

func (*ListAuthorizersPaginator) HasMorePages added in v0.30.0 

func (p *ListAuthorizersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAuthorizersPaginator) NextPage added in v0.30.0 

func (p *ListAuthorizersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAuthorizersOutput, error)

NextPage retrieves the next ListAuthorizers page.

type ListAuthorizersPaginatorOptions added in v0.30.0 

type ListAuthorizersPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAuthorizersPaginatorOptions is the paginator options for ListAuthorizers

type ListBillingGroupsAPIClient added in v0.30.0 

type ListBillingGroupsAPIClient interface {
	ListBillingGroups(context.Context, *ListBillingGroupsInput, ...func(*Options)) (*ListBillingGroupsOutput, error)
}

ListBillingGroupsAPIClient is a client that implements the ListBillingGroups operation.

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

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBillingGroupsOutput 

type ListBillingGroupsOutput struct {

	// The list of billing groups.
	BillingGroups []types.GroupNameAndArn

	// The token to use 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
	// contains filtered or unexported fields
}

type ListBillingGroupsPaginator added in v0.30.0 

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

ListBillingGroupsPaginator is a paginator for ListBillingGroups

func NewListBillingGroupsPaginator added in v0.30.0 

func NewListBillingGroupsPaginator(client ListBillingGroupsAPIClient, params *ListBillingGroupsInput, optFns ...func(*ListBillingGroupsPaginatorOptions)) *ListBillingGroupsPaginator

NewListBillingGroupsPaginator returns a new ListBillingGroupsPaginator

func (*ListBillingGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListBillingGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBillingGroupsPaginator) NextPage added in v0.30.0 

func (p *ListBillingGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBillingGroupsOutput, error)

NextPage retrieves the next ListBillingGroups page.

type ListBillingGroupsPaginatorOptions added in v0.30.0 

type ListBillingGroupsPaginatorOptions struct {
	// The maximum number of results to return per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBillingGroupsPaginatorOptions is the paginator options for ListBillingGroups

type ListCACertificatesAPIClient added in v0.30.0 

type ListCACertificatesAPIClient interface {
	ListCACertificates(context.Context, *ListCACertificatesInput, ...func(*Options)) (*ListCACertificatesOutput, error)
}

ListCACertificatesAPIClient is a client that implements the ListCACertificates operation.

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

	// The name of the provisioning template.
	TemplateName *string
	// contains filtered or unexported fields
}

Input for the ListCACertificates operation.

type ListCACertificatesOutput 

type ListCACertificatesOutput struct {

	// The CA certificates registered in your Amazon Web Services 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
	// contains filtered or unexported fields
}

The output from the ListCACertificates operation.

type ListCACertificatesPaginator added in v0.30.0 

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

ListCACertificatesPaginator is a paginator for ListCACertificates

func NewListCACertificatesPaginator added in v0.30.0 

func NewListCACertificatesPaginator(client ListCACertificatesAPIClient, params *ListCACertificatesInput, optFns ...func(*ListCACertificatesPaginatorOptions)) *ListCACertificatesPaginator

NewListCACertificatesPaginator returns a new ListCACertificatesPaginator

func (*ListCACertificatesPaginator) HasMorePages added in v0.30.0 

func (p *ListCACertificatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCACertificatesPaginator) NextPage added in v0.30.0 

func (p *ListCACertificatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCACertificatesOutput, error)

NextPage retrieves the next ListCACertificates page.

type ListCACertificatesPaginatorOptions added in v0.30.0 

type ListCACertificatesPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCACertificatesPaginatorOptions is the paginator options for ListCACertificates

type ListCertificateProvidersInput added in v1.47.0 

type ListCertificateProvidersInput struct {

	// Returns the list of certificate providers in ascending alphabetical order.
	AscendingOrder bool

	// The token for the next set of results, or null if there are no more results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCertificateProvidersOutput added in v1.47.0 

type ListCertificateProvidersOutput struct {

	// The list of certificate providers in your Amazon Web Services account.
	CertificateProviders []types.CertificateProviderSummary

	// The token for the next set of results, or null if there are no more results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCertificatesAPIClient added in v0.30.0 

type ListCertificatesAPIClient interface {
	ListCertificates(context.Context, *ListCertificatesInput, ...func(*Options)) (*ListCertificatesOutput, error)
}

ListCertificatesAPIClient is a client that implements the ListCertificates operation.

type ListCertificatesByCAAPIClient added in v0.30.0 

type ListCertificatesByCAAPIClient interface {
	ListCertificatesByCA(context.Context, *ListCertificatesByCAInput, ...func(*Options)) (*ListCertificatesByCAOutput, error)
}

ListCertificatesByCAAPIClient is a client that implements the ListCertificatesByCA operation.

type ListCertificatesByCAInput 

type ListCertificatesByCAInput struct {

	// The ID of the CA certificate. This operation will list all registered device
	// certificate that were signed by this CA certificate.
	//
	// This member is required.
	CaCertificateId *string

	// 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
	// contains filtered or unexported fields
}

The input to the ListCertificatesByCA operation.

type ListCertificatesByCAOutput 

type ListCertificatesByCAOutput struct {

	// The device certificates signed by the specified CA certificate.
	Certificates []types.Certificate

	// 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
	// contains filtered or unexported fields
}

The output of the ListCertificatesByCA operation.

type ListCertificatesByCAPaginator added in v0.30.0 

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

ListCertificatesByCAPaginator is a paginator for ListCertificatesByCA

func NewListCertificatesByCAPaginator added in v0.30.0 

func NewListCertificatesByCAPaginator(client ListCertificatesByCAAPIClient, params *ListCertificatesByCAInput, optFns ...func(*ListCertificatesByCAPaginatorOptions)) *ListCertificatesByCAPaginator

NewListCertificatesByCAPaginator returns a new ListCertificatesByCAPaginator

func (*ListCertificatesByCAPaginator) HasMorePages added in v0.30.0 

func (p *ListCertificatesByCAPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCertificatesByCAPaginator) NextPage added in v0.30.0 

func (p *ListCertificatesByCAPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCertificatesByCAOutput, error)

NextPage retrieves the next ListCertificatesByCA page.

type ListCertificatesByCAPaginatorOptions added in v0.30.0 

type ListCertificatesByCAPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCertificatesByCAPaginatorOptions is the paginator options for ListCertificatesByCA

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 marker for the next set of results.
	Marker *string

	// The result page size.
	PageSize *int32
	// contains filtered or unexported fields
}

The input for the ListCertificates operation.

type ListCertificatesOutput 

type ListCertificatesOutput struct {

	// The descriptions of the certificates.
	Certificates []types.Certificate

	// 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
	// contains filtered or unexported fields
}

The output of the ListCertificates operation.

type ListCertificatesPaginator added in v0.30.0 

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

ListCertificatesPaginator is a paginator for ListCertificates

func NewListCertificatesPaginator added in v0.30.0 

func NewListCertificatesPaginator(client ListCertificatesAPIClient, params *ListCertificatesInput, optFns ...func(*ListCertificatesPaginatorOptions)) *ListCertificatesPaginator

NewListCertificatesPaginator returns a new ListCertificatesPaginator

func (*ListCertificatesPaginator) HasMorePages added in v0.30.0 

func (p *ListCertificatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCertificatesPaginator) NextPage added in v0.30.0 

func (p *ListCertificatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCertificatesOutput, error)

NextPage retrieves the next ListCertificates page.

type ListCertificatesPaginatorOptions added in v0.30.0 

type ListCertificatesPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCertificatesPaginatorOptions is the paginator options for ListCertificates

type ListCommandExecutionsAPIClient added in v1.61.0 

type ListCommandExecutionsAPIClient interface {
	ListCommandExecutions(context.Context, *ListCommandExecutionsInput, ...func(*Options)) (*ListCommandExecutionsOutput, error)
}

ListCommandExecutionsAPIClient is a client that implements the ListCommandExecutions operation.

type ListCommandExecutionsInput added in v1.61.0 

type ListCommandExecutionsInput struct {

	// The Amazon Resource Number (ARN) of the command. You can use this information
	// to list all command executions for a particular command.
	CommandArn *string

	// List all command executions that completed any time before or after the date
	// and time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm .
	CompletedTimeFilter *types.TimeFilter

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// The namespace of the command.
	Namespace types.CommandNamespace

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// Specify whether to list the command executions that were created in the
	// ascending or descending order. By default, the API returns all commands in the
	// descending order based on the start time or completion time of the executions,
	// that are determined by the startTimeFilter and completeTimeFilter parameters.
	SortOrder types.SortOrder

	// List all command executions that started any time before or after the date and
	// time that you specify. The date and time uses the format yyyy-MM-dd'T'HH:mm .
	StartedTimeFilter *types.TimeFilter

	// List all command executions for the device that have a particular status. For
	// example, you can filter the list to display only command executions that have
	// failed or timed out.
	Status types.CommandExecutionStatus

	// The Amazon Resource Number (ARN) of the target device. You can use this
	// information to list all command executions for a particular device.
	TargetArn *string
	// contains filtered or unexported fields
}

type ListCommandExecutionsOutput added in v1.61.0 

type ListCommandExecutionsOutput struct {

	// The list of command executions.
	CommandExecutions []types.CommandExecutionSummary

	// The token to use 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
	// contains filtered or unexported fields
}

type ListCommandExecutionsPaginator added in v1.61.0 

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

ListCommandExecutionsPaginator is a paginator for ListCommandExecutions

func NewListCommandExecutionsPaginator added in v1.61.0 

func NewListCommandExecutionsPaginator(client ListCommandExecutionsAPIClient, params *ListCommandExecutionsInput, optFns ...func(*ListCommandExecutionsPaginatorOptions)) *ListCommandExecutionsPaginator

NewListCommandExecutionsPaginator returns a new ListCommandExecutionsPaginator

func (*ListCommandExecutionsPaginator) HasMorePages added in v1.61.0 

func (p *ListCommandExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCommandExecutionsPaginator) NextPage added in v1.61.0 

func (p *ListCommandExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCommandExecutionsOutput, error)

NextPage retrieves the next ListCommandExecutions page.

type ListCommandExecutionsPaginatorOptions added in v1.61.0 

type ListCommandExecutionsPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCommandExecutionsPaginatorOptions is the paginator options for ListCommandExecutions

type ListCommandsAPIClient added in v1.61.0 

type ListCommandsAPIClient interface {
	ListCommands(context.Context, *ListCommandsInput, ...func(*Options)) (*ListCommandsOutput, error)
}

ListCommandsAPIClient is a client that implements the ListCommands operation.

type ListCommandsInput added in v1.61.0 

type ListCommandsInput struct {

	// A filter that can be used to display the list of commands that have a specific
	// command parameter name.
	CommandParameterName *string

	// The maximum number of results to return in this operation. By default, the API
	// returns up to a maximum of 25 results. You can override this default value to
	// return up to a maximum of 100 results for this operation.
	MaxResults *int32

	// The namespace of the command. By default, the API returns all commands that
	// have been created for both AWS-IoT and AWS-IoT-FleetWise namespaces. You can
	// override this default value if you want to return all commands that have been
	// created only for a specific namespace.
	Namespace types.CommandNamespace

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// Specify whether to list the commands that you have created in the ascending or
	// descending order. By default, the API returns all commands in the descending
	// order based on the time that they were created.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListCommandsOutput added in v1.61.0 

type ListCommandsOutput struct {

	// The list of commands.
	Commands []types.CommandSummary

	// The token to use 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
	// contains filtered or unexported fields
}

type ListCommandsPaginator added in v1.61.0 

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

ListCommandsPaginator is a paginator for ListCommands

func NewListCommandsPaginator added in v1.61.0 

func NewListCommandsPaginator(client ListCommandsAPIClient, params *ListCommandsInput, optFns ...func(*ListCommandsPaginatorOptions)) *ListCommandsPaginator

NewListCommandsPaginator returns a new ListCommandsPaginator

func (*ListCommandsPaginator) HasMorePages added in v1.61.0 

func (p *ListCommandsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCommandsPaginator) NextPage added in v1.61.0 

func (p *ListCommandsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCommandsOutput, error)

NextPage retrieves the next ListCommands page.

type ListCommandsPaginatorOptions added in v1.61.0 

type ListCommandsPaginatorOptions struct {
	// The maximum number of results to return in this operation. By default, the API
	// returns up to a maximum of 25 results. You can override this default value to
	// return up to a maximum of 100 results for this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCommandsPaginatorOptions is the paginator options for ListCommands

type ListCustomMetricsAPIClient added in v1.2.0 

type ListCustomMetricsAPIClient interface {
	ListCustomMetrics(context.Context, *ListCustomMetricsInput, ...func(*Options)) (*ListCustomMetricsOutput, error)
}

ListCustomMetricsAPIClient is a client that implements the ListCustomMetrics operation.

type ListCustomMetricsInput added in v1.2.0 

type ListCustomMetricsInput struct {

	//  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
	// contains filtered or unexported fields
}

type ListCustomMetricsOutput added in v1.2.0 

type ListCustomMetricsOutput struct {

	//  The name of the custom metric.
	MetricNames []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
	// contains filtered or unexported fields
}

type ListCustomMetricsPaginator added in v1.2.0 

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

ListCustomMetricsPaginator is a paginator for ListCustomMetrics

func NewListCustomMetricsPaginator added in v1.2.0 

func NewListCustomMetricsPaginator(client ListCustomMetricsAPIClient, params *ListCustomMetricsInput, optFns ...func(*ListCustomMetricsPaginatorOptions)) *ListCustomMetricsPaginator

NewListCustomMetricsPaginator returns a new ListCustomMetricsPaginator

func (*ListCustomMetricsPaginator) HasMorePages added in v1.2.0 

func (p *ListCustomMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomMetricsPaginator) NextPage added in v1.2.0 

func (p *ListCustomMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomMetricsOutput, error)

NextPage retrieves the next ListCustomMetrics page.

type ListCustomMetricsPaginatorOptions added in v1.2.0 

type ListCustomMetricsPaginatorOptions struct {
	//  The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomMetricsPaginatorOptions is the paginator options for ListCustomMetrics

type ListDetectMitigationActionsExecutionsAPIClient added in v1.2.0 

type ListDetectMitigationActionsExecutionsAPIClient interface {
	ListDetectMitigationActionsExecutions(context.Context, *ListDetectMitigationActionsExecutionsInput, ...func(*Options)) (*ListDetectMitigationActionsExecutionsOutput, error)
}

ListDetectMitigationActionsExecutionsAPIClient is a client that implements the ListDetectMitigationActionsExecutions operation.

type ListDetectMitigationActionsExecutionsInput added in v1.2.0 

type ListDetectMitigationActionsExecutionsInput struct {

	//  The end of the time period for which ML Detect mitigation actions executions
	// are returned.
	EndTime *time.Time

	//  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

	//  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

	//  The unique identifier of the task.
	TaskId *string

	//  The name of the thing whose mitigation actions are listed.
	ThingName *string

	//  The unique identifier of the violation.
	ViolationId *string
	// contains filtered or unexported fields
}

type ListDetectMitigationActionsExecutionsOutput added in v1.2.0 

type ListDetectMitigationActionsExecutionsOutput struct {

	//  List of actions executions.
	ActionsExecutions []types.DetectMitigationActionExecution

	//  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
	// contains filtered or unexported fields
}

type ListDetectMitigationActionsExecutionsPaginator added in v1.2.0 

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

ListDetectMitigationActionsExecutionsPaginator is a paginator for ListDetectMitigationActionsExecutions

func NewListDetectMitigationActionsExecutionsPaginator added in v1.2.0 

func NewListDetectMitigationActionsExecutionsPaginator(client ListDetectMitigationActionsExecutionsAPIClient, params *ListDetectMitigationActionsExecutionsInput, optFns ...func(*ListDetectMitigationActionsExecutionsPaginatorOptions)) *ListDetectMitigationActionsExecutionsPaginator

NewListDetectMitigationActionsExecutionsPaginator returns a new ListDetectMitigationActionsExecutionsPaginator

func (*ListDetectMitigationActionsExecutionsPaginator) HasMorePages added in v1.2.0 

func (p *ListDetectMitigationActionsExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDetectMitigationActionsExecutionsPaginator) NextPage added in v1.2.0 

func (p *ListDetectMitigationActionsExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDetectMitigationActionsExecutionsOutput, error)

NextPage retrieves the next ListDetectMitigationActionsExecutions page.

type ListDetectMitigationActionsExecutionsPaginatorOptions added in v1.2.0 

type ListDetectMitigationActionsExecutionsPaginatorOptions struct {
	//  The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDetectMitigationActionsExecutionsPaginatorOptions is the paginator options for ListDetectMitigationActionsExecutions

type ListDetectMitigationActionsTasksAPIClient added in v1.2.0 

type ListDetectMitigationActionsTasksAPIClient interface {
	ListDetectMitigationActionsTasks(context.Context, *ListDetectMitigationActionsTasksInput, ...func(*Options)) (*ListDetectMitigationActionsTasksOutput, error)
}

ListDetectMitigationActionsTasksAPIClient is a client that implements the ListDetectMitigationActionsTasks operation.

type ListDetectMitigationActionsTasksInput added in v1.2.0 

type ListDetectMitigationActionsTasksInput struct {

	//  The end of the time period for which ML Detect mitigation actions tasks are
	// returned.
	//
	// This member is required.
	EndTime *time.Time

	//  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.
	//
	// This member is required.
	StartTime *time.Time

	// 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
	// contains filtered or unexported fields
}

type ListDetectMitigationActionsTasksOutput added in v1.2.0 

type ListDetectMitigationActionsTasksOutput 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 collection of ML Detect mitigation tasks that matched the filter criteria.
	Tasks []types.DetectMitigationActionsTaskSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDetectMitigationActionsTasksPaginator added in v1.2.0 

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

ListDetectMitigationActionsTasksPaginator is a paginator for ListDetectMitigationActionsTasks

func NewListDetectMitigationActionsTasksPaginator added in v1.2.0 

func NewListDetectMitigationActionsTasksPaginator(client ListDetectMitigationActionsTasksAPIClient, params *ListDetectMitigationActionsTasksInput, optFns ...func(*ListDetectMitigationActionsTasksPaginatorOptions)) *ListDetectMitigationActionsTasksPaginator

NewListDetectMitigationActionsTasksPaginator returns a new ListDetectMitigationActionsTasksPaginator

func (*ListDetectMitigationActionsTasksPaginator) HasMorePages added in v1.2.0 

func (p *ListDetectMitigationActionsTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDetectMitigationActionsTasksPaginator) NextPage added in v1.2.0 

func (p *ListDetectMitigationActionsTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDetectMitigationActionsTasksOutput, error)

NextPage retrieves the next ListDetectMitigationActionsTasks page.

type ListDetectMitigationActionsTasksPaginatorOptions added in v1.2.0 

type ListDetectMitigationActionsTasksPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDetectMitigationActionsTasksPaginatorOptions is the paginator options for ListDetectMitigationActionsTasks

type ListDimensionsAPIClient added in v0.30.0 

type ListDimensionsAPIClient interface {
	ListDimensions(context.Context, *ListDimensionsInput, ...func(*Options)) (*ListDimensionsOutput, error)
}

ListDimensionsAPIClient is a client that implements the ListDimensions operation.

type ListDimensionsInput 

type ListDimensionsInput struct {

	// The maximum number of results to retrieve at one time.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListDimensionsPaginator added in v0.30.0 

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

ListDimensionsPaginator is a paginator for ListDimensions

func NewListDimensionsPaginator added in v0.30.0 

func NewListDimensionsPaginator(client ListDimensionsAPIClient, params *ListDimensionsInput, optFns ...func(*ListDimensionsPaginatorOptions)) *ListDimensionsPaginator

NewListDimensionsPaginator returns a new ListDimensionsPaginator

func (*ListDimensionsPaginator) HasMorePages added in v0.30.0 

func (p *ListDimensionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDimensionsPaginator) NextPage added in v0.30.0 

func (p *ListDimensionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDimensionsOutput, error)

NextPage retrieves the next ListDimensions page.

type ListDimensionsPaginatorOptions added in v0.30.0 

type ListDimensionsPaginatorOptions struct {
	// The maximum number of results to retrieve at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDimensionsPaginatorOptions is the paginator options for ListDimensions

type ListDomainConfigurationsAPIClient added in v0.30.0 

type ListDomainConfigurationsAPIClient interface {
	ListDomainConfigurations(context.Context, *ListDomainConfigurationsInput, ...func(*Options)) (*ListDomainConfigurationsOutput, error)
}

ListDomainConfigurationsAPIClient is a client that implements the ListDomainConfigurations operation.

type ListDomainConfigurationsInput 

type ListDomainConfigurationsInput struct {

	// The marker for the next set of results.
	Marker *string

	// The result page size.
	PageSize *int32

	// The type of service delivered by the endpoint.
	ServiceType types.ServiceType
	// contains filtered or unexported fields
}

type ListDomainConfigurationsOutput 

type ListDomainConfigurationsOutput struct {

	// A list of objects that contain summary information about the user's domain
	// configurations.
	DomainConfigurations []types.DomainConfigurationSummary

	// The marker for the next set of results.
	NextMarker *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDomainConfigurationsPaginator added in v0.30.0 

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

ListDomainConfigurationsPaginator is a paginator for ListDomainConfigurations

func NewListDomainConfigurationsPaginator added in v0.30.0 

func NewListDomainConfigurationsPaginator(client ListDomainConfigurationsAPIClient, params *ListDomainConfigurationsInput, optFns ...func(*ListDomainConfigurationsPaginatorOptions)) *ListDomainConfigurationsPaginator

NewListDomainConfigurationsPaginator returns a new ListDomainConfigurationsPaginator

func (*ListDomainConfigurationsPaginator) HasMorePages added in v0.30.0 

func (p *ListDomainConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainConfigurationsPaginator) NextPage added in v0.30.0 

func (p *ListDomainConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainConfigurationsOutput, error)

NextPage retrieves the next ListDomainConfigurations page.

type ListDomainConfigurationsPaginatorOptions added in v0.30.0 

type ListDomainConfigurationsPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDomainConfigurationsPaginatorOptions is the paginator options for ListDomainConfigurations

type ListFleetMetricsAPIClient added in v1.11.0 

type ListFleetMetricsAPIClient interface {
	ListFleetMetrics(context.Context, *ListFleetMetricsInput, ...func(*Options)) (*ListFleetMetricsOutput, error)
}

ListFleetMetricsAPIClient is a client that implements the ListFleetMetrics operation.

type ListFleetMetricsInput added in v1.11.0 

type ListFleetMetricsInput struct {

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFleetMetricsOutput added in v1.11.0 

type ListFleetMetricsOutput struct {

	// The list of fleet metrics objects.
	FleetMetrics []types.FleetMetricNameAndArn

	// The token for the next set of results. Will not be returned if the operation
	// has returned all results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFleetMetricsPaginator added in v1.11.0 

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

ListFleetMetricsPaginator is a paginator for ListFleetMetrics

func NewListFleetMetricsPaginator added in v1.11.0 

func NewListFleetMetricsPaginator(client ListFleetMetricsAPIClient, params *ListFleetMetricsInput, optFns ...func(*ListFleetMetricsPaginatorOptions)) *ListFleetMetricsPaginator

NewListFleetMetricsPaginator returns a new ListFleetMetricsPaginator

func (*ListFleetMetricsPaginator) HasMorePages added in v1.11.0 

func (p *ListFleetMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFleetMetricsPaginator) NextPage added in v1.11.0 

func (p *ListFleetMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFleetMetricsOutput, error)

NextPage retrieves the next ListFleetMetrics page.

type ListFleetMetricsPaginatorOptions added in v1.11.0 

type ListFleetMetricsPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFleetMetricsPaginatorOptions is the paginator options for ListFleetMetrics

type ListIndicesAPIClient added in v0.30.0 

type ListIndicesAPIClient interface {
	ListIndices(context.Context, *ListIndicesInput, ...func(*Options)) (*ListIndicesOutput, error)
}

ListIndicesAPIClient is a client that implements the ListIndices operation.

type ListIndicesInput 

type ListIndicesInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListIndicesPaginator added in v0.30.0 

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

ListIndicesPaginator is a paginator for ListIndices

func NewListIndicesPaginator added in v0.30.0 

func NewListIndicesPaginator(client ListIndicesAPIClient, params *ListIndicesInput, optFns ...func(*ListIndicesPaginatorOptions)) *ListIndicesPaginator

NewListIndicesPaginator returns a new ListIndicesPaginator

func (*ListIndicesPaginator) HasMorePages added in v0.30.0 

func (p *ListIndicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIndicesPaginator) NextPage added in v0.30.0 

func (p *ListIndicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIndicesOutput, error)

NextPage retrieves the next ListIndices page.

type ListIndicesPaginatorOptions added in v0.30.0 

type ListIndicesPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIndicesPaginatorOptions is the paginator options for ListIndices

type ListJobExecutionsForJobAPIClient added in v0.30.0 

type ListJobExecutionsForJobAPIClient interface {
	ListJobExecutionsForJob(context.Context, *ListJobExecutionsForJobInput, ...func(*Options)) (*ListJobExecutionsForJobOutput, error)
}

ListJobExecutionsForJobAPIClient is a client that implements the ListJobExecutionsForJob operation.

type ListJobExecutionsForJobInput 

type ListJobExecutionsForJobInput struct {

	// The unique identifier you assigned to this job when it was created.
	//
	// This member is required.
	JobId *string

	// The maximum number of results to be returned per request.
	MaxResults *int32

	// The token to retrieve the next set of results.
	NextToken *string

	// The status of the job.
	Status types.JobExecutionStatus
	// contains filtered or unexported fields
}

type ListJobExecutionsForJobOutput 

type ListJobExecutionsForJobOutput struct {

	// A list of job execution summaries.
	ExecutionSummaries []types.JobExecutionSummaryForJob

	// 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
	// contains filtered or unexported fields
}

type ListJobExecutionsForJobPaginator added in v0.30.0 

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

ListJobExecutionsForJobPaginator is a paginator for ListJobExecutionsForJob

func NewListJobExecutionsForJobPaginator added in v0.30.0 

func NewListJobExecutionsForJobPaginator(client ListJobExecutionsForJobAPIClient, params *ListJobExecutionsForJobInput, optFns ...func(*ListJobExecutionsForJobPaginatorOptions)) *ListJobExecutionsForJobPaginator

NewListJobExecutionsForJobPaginator returns a new ListJobExecutionsForJobPaginator

func (*ListJobExecutionsForJobPaginator) HasMorePages added in v0.30.0 

func (p *ListJobExecutionsForJobPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobExecutionsForJobPaginator) NextPage added in v0.30.0 

func (p *ListJobExecutionsForJobPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobExecutionsForJobOutput, error)

NextPage retrieves the next ListJobExecutionsForJob page.

type ListJobExecutionsForJobPaginatorOptions added in v0.30.0 

type ListJobExecutionsForJobPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobExecutionsForJobPaginatorOptions is the paginator options for ListJobExecutionsForJob

type ListJobExecutionsForThingAPIClient added in v0.30.0 

type ListJobExecutionsForThingAPIClient interface {
	ListJobExecutionsForThing(context.Context, *ListJobExecutionsForThingInput, ...func(*Options)) (*ListJobExecutionsForThingOutput, error)
}

ListJobExecutionsForThingAPIClient is a client that implements the ListJobExecutionsForThing operation.

type ListJobExecutionsForThingInput 

type ListJobExecutionsForThingInput struct {

	// The thing name.
	//
	// This member is required.
	ThingName *string

	// The unique identifier you assigned to this job when it was created.
	JobId *string

	// The maximum number of results to be returned per request.
	MaxResults *int32

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *string

	// The token to retrieve the next set of results.
	NextToken *string

	// An optional filter that lets you search for jobs that have the specified status.
	Status types.JobExecutionStatus
	// contains filtered or unexported fields
}

type ListJobExecutionsForThingOutput 

type ListJobExecutionsForThingOutput struct {

	// A list of job execution summaries.
	ExecutionSummaries []types.JobExecutionSummaryForThing

	// 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
	// contains filtered or unexported fields
}

type ListJobExecutionsForThingPaginator added in v0.30.0 

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

ListJobExecutionsForThingPaginator is a paginator for ListJobExecutionsForThing

func NewListJobExecutionsForThingPaginator added in v0.30.0 

func NewListJobExecutionsForThingPaginator(client ListJobExecutionsForThingAPIClient, params *ListJobExecutionsForThingInput, optFns ...func(*ListJobExecutionsForThingPaginatorOptions)) *ListJobExecutionsForThingPaginator

NewListJobExecutionsForThingPaginator returns a new ListJobExecutionsForThingPaginator

func (*ListJobExecutionsForThingPaginator) HasMorePages added in v0.30.0 

func (p *ListJobExecutionsForThingPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobExecutionsForThingPaginator) NextPage added in v0.30.0 

func (p *ListJobExecutionsForThingPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobExecutionsForThingOutput, error)

NextPage retrieves the next ListJobExecutionsForThing page.

type ListJobExecutionsForThingPaginatorOptions added in v0.30.0 

type ListJobExecutionsForThingPaginatorOptions struct {
	// The maximum number of results to be returned per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobExecutionsForThingPaginatorOptions is the paginator options for ListJobExecutionsForThing

type ListJobTemplatesAPIClient added in v1.11.0 

type ListJobTemplatesAPIClient interface {
	ListJobTemplates(context.Context, *ListJobTemplatesInput, ...func(*Options)) (*ListJobTemplatesOutput, error)
}

ListJobTemplatesAPIClient is a client that implements the ListJobTemplates operation.

type ListJobTemplatesInput added in v1.6.0 

type ListJobTemplatesInput struct {

	// The maximum number of results to return in the list.
	MaxResults *int32

	// The token to use to return the next set of results in the list.
	NextToken *string
	// contains filtered or unexported fields
}

type ListJobTemplatesOutput added in v1.6.0 

type ListJobTemplatesOutput struct {

	// A list of objects that contain information about the job templates.
	JobTemplates []types.JobTemplateSummary

	// 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
	// contains filtered or unexported fields
}

type ListJobTemplatesPaginator added in v1.11.0 

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

ListJobTemplatesPaginator is a paginator for ListJobTemplates

func NewListJobTemplatesPaginator added in v1.11.0 

func NewListJobTemplatesPaginator(client ListJobTemplatesAPIClient, params *ListJobTemplatesInput, optFns ...func(*ListJobTemplatesPaginatorOptions)) *ListJobTemplatesPaginator

NewListJobTemplatesPaginator returns a new ListJobTemplatesPaginator

func (*ListJobTemplatesPaginator) HasMorePages added in v1.11.0 

func (p *ListJobTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobTemplatesPaginator) NextPage added in v1.11.0 

func (p *ListJobTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobTemplatesOutput, error)

NextPage retrieves the next ListJobTemplates page.

type ListJobTemplatesPaginatorOptions added in v1.11.0 

type ListJobTemplatesPaginatorOptions struct {
	// The maximum number of results to return in the list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobTemplatesPaginatorOptions is the paginator options for ListJobTemplates

type ListJobsAPIClient added in v0.30.0 

type ListJobsAPIClient interface {
	ListJobs(context.Context, *ListJobsInput, ...func(*Options)) (*ListJobsOutput, error)
}

ListJobsAPIClient is a client that implements the ListJobs operation.

type ListJobsInput 

type ListJobsInput struct {

	// The maximum number of results to return per request.
	MaxResults *int32

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *string

	// The token to retrieve the next set of results.
	NextToken *string

	// An optional filter that lets you search for jobs that have the specified status.
	Status types.JobStatus

	// 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.
	//
	// We recommend that you use continuous jobs instead of snapshot jobs for dynamic
	// thing group targets. By using continuous jobs, devices that join the group
	// receive the job execution even after the job has been created.
	TargetSelection types.TargetSelection

	// A filter that limits the returned jobs to those for the specified group.
	ThingGroupId *string

	// A filter that limits the returned jobs to those for the specified group.
	ThingGroupName *string
	// contains filtered or unexported fields
}

type ListJobsOutput 

type ListJobsOutput struct {

	// A list of jobs.
	Jobs []types.JobSummary

	// 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
	// contains filtered or unexported fields
}

type ListJobsPaginator added in v0.30.0 

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

ListJobsPaginator is a paginator for ListJobs

func NewListJobsPaginator added in v0.30.0 

func NewListJobsPaginator(client ListJobsAPIClient, params *ListJobsInput, optFns ...func(*ListJobsPaginatorOptions)) *ListJobsPaginator

NewListJobsPaginator returns a new ListJobsPaginator

func (*ListJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobsPaginator) NextPage added in v0.30.0 

func (p *ListJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobsOutput, error)

NextPage retrieves the next ListJobs page.

type ListJobsPaginatorOptions added in v0.30.0 

type ListJobsPaginatorOptions struct {
	// The maximum number of results to return per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListJobsPaginatorOptions is the paginator options for ListJobs

type ListManagedJobTemplatesAPIClient added in v1.36.0 

type ListManagedJobTemplatesAPIClient interface {
	ListManagedJobTemplates(context.Context, *ListManagedJobTemplatesInput, ...func(*Options)) (*ListManagedJobTemplatesOutput, error)
}

ListManagedJobTemplatesAPIClient is a client that implements the ListManagedJobTemplates operation.

type ListManagedJobTemplatesInput added in v1.17.0 

type ListManagedJobTemplatesInput struct {

	// Maximum number of entries that can be returned.
	MaxResults *int32

	// The token to retrieve the next set of results.
	NextToken *string

	// An optional parameter for template name. If specified, only the versions of the
	// managed job templates that have the specified template name will be returned.
	TemplateName *string
	// contains filtered or unexported fields
}

type ListManagedJobTemplatesOutput added in v1.17.0 

type ListManagedJobTemplatesOutput struct {

	// A list of managed job templates that are returned.
	ManagedJobTemplates []types.ManagedJobTemplateSummary

	// The token to retrieve the next set of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListManagedJobTemplatesPaginator added in v1.36.0 

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

ListManagedJobTemplatesPaginator is a paginator for ListManagedJobTemplates

func NewListManagedJobTemplatesPaginator added in v1.36.0 

func NewListManagedJobTemplatesPaginator(client ListManagedJobTemplatesAPIClient, params *ListManagedJobTemplatesInput, optFns ...func(*ListManagedJobTemplatesPaginatorOptions)) *ListManagedJobTemplatesPaginator

NewListManagedJobTemplatesPaginator returns a new ListManagedJobTemplatesPaginator

func (*ListManagedJobTemplatesPaginator) HasMorePages added in v1.36.0 

func (p *ListManagedJobTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedJobTemplatesPaginator) NextPage added in v1.36.0 

func (p *ListManagedJobTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListManagedJobTemplatesOutput, error)

NextPage retrieves the next ListManagedJobTemplates page.

type ListManagedJobTemplatesPaginatorOptions added in v1.36.0 

type ListManagedJobTemplatesPaginatorOptions struct {
	// Maximum number of entries that can be returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListManagedJobTemplatesPaginatorOptions is the paginator options for ListManagedJobTemplates

type ListMetricValuesAPIClient added in v1.24.0 

type ListMetricValuesAPIClient interface {
	ListMetricValues(context.Context, *ListMetricValuesInput, ...func(*Options)) (*ListMetricValuesOutput, error)
}

ListMetricValuesAPIClient is a client that implements the ListMetricValues operation.

type ListMetricValuesInput added in v1.24.0 

type ListMetricValuesInput struct {

	// The end of the time period for which metric values are returned.
	//
	// This member is required.
	EndTime *time.Time

	// The name of the security profile metric for which values are returned.
	//
	// This member is required.
	MetricName *string

	// The start of the time period for which metric values are returned.
	//
	// This member is required.
	StartTime *time.Time

	// The name of the thing for which security profile metric values are returned.
	//
	// This member is required.
	ThingName *string

	// The dimension name.
	DimensionName *string

	// The dimension value operator.
	DimensionValueOperator types.DimensionValueOperator

	// The maximum number of results to return at one time.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMetricValuesOutput added in v1.24.0 

type ListMetricValuesOutput struct {

	// The data the thing reports for the metric during the specified time period.
	MetricDatumList []types.MetricDatum

	// 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
	// contains filtered or unexported fields
}

type ListMetricValuesPaginator added in v1.24.0 

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

ListMetricValuesPaginator is a paginator for ListMetricValues

func NewListMetricValuesPaginator added in v1.24.0 

func NewListMetricValuesPaginator(client ListMetricValuesAPIClient, params *ListMetricValuesInput, optFns ...func(*ListMetricValuesPaginatorOptions)) *ListMetricValuesPaginator

NewListMetricValuesPaginator returns a new ListMetricValuesPaginator

func (*ListMetricValuesPaginator) HasMorePages added in v1.24.0 

func (p *ListMetricValuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMetricValuesPaginator) NextPage added in v1.24.0 

func (p *ListMetricValuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMetricValuesOutput, error)

NextPage retrieves the next ListMetricValues page.

type ListMetricValuesPaginatorOptions added in v1.24.0 

type ListMetricValuesPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMetricValuesPaginatorOptions is the paginator options for ListMetricValues

type ListMitigationActionsAPIClient added in v0.30.0 

type ListMitigationActionsAPIClient interface {
	ListMitigationActions(context.Context, *ListMitigationActionsInput, ...func(*Options)) (*ListMitigationActionsOutput, error)
}

ListMitigationActionsAPIClient is a client that implements the ListMitigationActions operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListMitigationActionsPaginator added in v0.30.0 

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

ListMitigationActionsPaginator is a paginator for ListMitigationActions

func NewListMitigationActionsPaginator added in v0.30.0 

func NewListMitigationActionsPaginator(client ListMitigationActionsAPIClient, params *ListMitigationActionsInput, optFns ...func(*ListMitigationActionsPaginatorOptions)) *ListMitigationActionsPaginator

NewListMitigationActionsPaginator returns a new ListMitigationActionsPaginator

func (*ListMitigationActionsPaginator) HasMorePages added in v0.30.0 

func (p *ListMitigationActionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMitigationActionsPaginator) NextPage added in v0.30.0 

func (p *ListMitigationActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMitigationActionsOutput, error)

NextPage retrieves the next ListMitigationActions page.

type ListMitigationActionsPaginatorOptions added in v0.30.0 

type ListMitigationActionsPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMitigationActionsPaginatorOptions is the paginator options for ListMitigationActions

type ListOTAUpdatesAPIClient added in v0.30.0 

type ListOTAUpdatesAPIClient interface {
	ListOTAUpdates(context.Context, *ListOTAUpdatesInput, ...func(*Options)) (*ListOTAUpdatesOutput, error)
}

ListOTAUpdatesAPIClient is a client that implements the ListOTAUpdates operation.

type ListOTAUpdatesInput 

type ListOTAUpdatesInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token used to retrieve the next set of results.
	NextToken *string

	// The OTA update job status.
	OtaUpdateStatus types.OTAUpdateStatus
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListOTAUpdatesPaginator added in v0.30.0 

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

ListOTAUpdatesPaginator is a paginator for ListOTAUpdates

func NewListOTAUpdatesPaginator added in v0.30.0 

func NewListOTAUpdatesPaginator(client ListOTAUpdatesAPIClient, params *ListOTAUpdatesInput, optFns ...func(*ListOTAUpdatesPaginatorOptions)) *ListOTAUpdatesPaginator

NewListOTAUpdatesPaginator returns a new ListOTAUpdatesPaginator

func (*ListOTAUpdatesPaginator) HasMorePages added in v0.30.0 

func (p *ListOTAUpdatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOTAUpdatesPaginator) NextPage added in v0.30.0 

func (p *ListOTAUpdatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOTAUpdatesOutput, error)

NextPage retrieves the next ListOTAUpdates page.

type ListOTAUpdatesPaginatorOptions added in v0.30.0 

type ListOTAUpdatesPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListOTAUpdatesPaginatorOptions is the paginator options for ListOTAUpdates

type ListOutgoingCertificatesAPIClient added in v0.30.0 

type ListOutgoingCertificatesAPIClient interface {
	ListOutgoingCertificates(context.Context, *ListOutgoingCertificatesInput, ...func(*Options)) (*ListOutgoingCertificatesOutput, error)
}

ListOutgoingCertificatesAPIClient is a client that implements the ListOutgoingCertificates operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the ListOutgoingCertificates operation.

type ListOutgoingCertificatesPaginator added in v0.30.0 

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

ListOutgoingCertificatesPaginator is a paginator for ListOutgoingCertificates

func NewListOutgoingCertificatesPaginator added in v0.30.0 

func NewListOutgoingCertificatesPaginator(client ListOutgoingCertificatesAPIClient, params *ListOutgoingCertificatesInput, optFns ...func(*ListOutgoingCertificatesPaginatorOptions)) *ListOutgoingCertificatesPaginator

NewListOutgoingCertificatesPaginator returns a new ListOutgoingCertificatesPaginator

func (*ListOutgoingCertificatesPaginator) HasMorePages added in v0.30.0 

func (p *ListOutgoingCertificatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOutgoingCertificatesPaginator) NextPage added in v0.30.0 

func (p *ListOutgoingCertificatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOutgoingCertificatesOutput, error)

NextPage retrieves the next ListOutgoingCertificates page.

type ListOutgoingCertificatesPaginatorOptions added in v0.30.0 

type ListOutgoingCertificatesPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListOutgoingCertificatesPaginatorOptions is the paginator options for ListOutgoingCertificates

type ListPackageVersionsAPIClient added in v1.38.0 

type ListPackageVersionsAPIClient interface {
	ListPackageVersions(context.Context, *ListPackageVersionsInput, ...func(*Options)) (*ListPackageVersionsOutput, error)
}

ListPackageVersionsAPIClient is a client that implements the ListPackageVersions operation.

type ListPackageVersionsInput added in v1.38.0 

type ListPackageVersionsInput struct {

	// The name of the target software package.
	//
	// This member is required.
	PackageName *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// The status of the package version. For more information, see [Package version lifecycle].
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	Status types.PackageVersionStatus
	// contains filtered or unexported fields
}

type ListPackageVersionsOutput added in v1.38.0 

type ListPackageVersionsOutput struct {

	// The token for the next set of results.
	NextToken *string

	// Lists the package versions associated to the package.
	PackageVersionSummaries []types.PackageVersionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPackageVersionsPaginator added in v1.38.0 

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

ListPackageVersionsPaginator is a paginator for ListPackageVersions

func NewListPackageVersionsPaginator added in v1.38.0 

func NewListPackageVersionsPaginator(client ListPackageVersionsAPIClient, params *ListPackageVersionsInput, optFns ...func(*ListPackageVersionsPaginatorOptions)) *ListPackageVersionsPaginator

NewListPackageVersionsPaginator returns a new ListPackageVersionsPaginator

func (*ListPackageVersionsPaginator) HasMorePages added in v1.38.0 

func (p *ListPackageVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackageVersionsPaginator) NextPage added in v1.38.0 

func (p *ListPackageVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPackageVersionsOutput, error)

NextPage retrieves the next ListPackageVersions page.

type ListPackageVersionsPaginatorOptions added in v1.38.0 

type ListPackageVersionsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackageVersionsPaginatorOptions is the paginator options for ListPackageVersions

type ListPackagesAPIClient added in v1.38.0 

type ListPackagesAPIClient interface {
	ListPackages(context.Context, *ListPackagesInput, ...func(*Options)) (*ListPackagesOutput, error)
}

ListPackagesAPIClient is a client that implements the ListPackages operation.

type ListPackagesInput added in v1.38.0 

type ListPackagesInput struct {

	// The maximum number of results returned at one time.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPackagesOutput added in v1.38.0 

type ListPackagesOutput struct {

	// The token for the next set of results.
	NextToken *string

	// The software package summary.
	PackageSummaries []types.PackageSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPackagesPaginator added in v1.38.0 

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

ListPackagesPaginator is a paginator for ListPackages

func NewListPackagesPaginator added in v1.38.0 

func NewListPackagesPaginator(client ListPackagesAPIClient, params *ListPackagesInput, optFns ...func(*ListPackagesPaginatorOptions)) *ListPackagesPaginator

NewListPackagesPaginator returns a new ListPackagesPaginator

func (*ListPackagesPaginator) HasMorePages added in v1.38.0 

func (p *ListPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackagesPaginator) NextPage added in v1.38.0 

func (p *ListPackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPackagesOutput, error)

NextPage retrieves the next ListPackages page.

type ListPackagesPaginatorOptions added in v1.38.0 

type ListPackagesPaginatorOptions struct {
	// The maximum number of results returned at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackagesPaginatorOptions is the paginator options for ListPackages

type ListPoliciesAPIClient added in v0.30.0 

type ListPoliciesAPIClient interface {
	ListPolicies(context.Context, *ListPoliciesInput, ...func(*Options)) (*ListPoliciesOutput, error)
}

ListPoliciesAPIClient is a client that implements the ListPolicies operation.

type ListPoliciesInput 

type ListPoliciesInput struct {

	// 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 result page size.
	PageSize *int32
	// contains filtered or unexported fields
}

The input for the ListPolicies operation.

type ListPoliciesOutput 

type ListPoliciesOutput struct {

	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string

	// The descriptions of the policies.
	Policies []types.Policy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the ListPolicies operation.

type ListPoliciesPaginator added in v0.30.0 

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

ListPoliciesPaginator is a paginator for ListPolicies

func NewListPoliciesPaginator added in v0.30.0 

func NewListPoliciesPaginator(client ListPoliciesAPIClient, params *ListPoliciesInput, optFns ...func(*ListPoliciesPaginatorOptions)) *ListPoliciesPaginator

NewListPoliciesPaginator returns a new ListPoliciesPaginator

func (*ListPoliciesPaginator) HasMorePages added in v0.30.0 

func (p *ListPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPoliciesPaginator) NextPage added in v0.30.0 

func (p *ListPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPoliciesOutput, error)

NextPage retrieves the next ListPolicies page.

type ListPoliciesPaginatorOptions added in v0.30.0 

type ListPoliciesPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPoliciesPaginatorOptions is the paginator options for ListPolicies

type ListPolicyPrincipalsAPIClient added in v0.30.0 

type ListPolicyPrincipalsAPIClient interface {
	ListPolicyPrincipals(context.Context, *ListPolicyPrincipalsInput, ...func(*Options)) (*ListPolicyPrincipalsOutput, error)
}

ListPolicyPrincipalsAPIClient is a client that implements the ListPolicyPrincipals operation.

type ListPolicyPrincipalsInput 

type ListPolicyPrincipalsInput struct {

	// The policy name.
	//
	// This member is required.
	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 result page size.
	PageSize *int32
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the ListPolicyPrincipals operation.

type ListPolicyPrincipalsPaginator added in v0.30.0 

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

ListPolicyPrincipalsPaginator is a paginator for ListPolicyPrincipals

func NewListPolicyPrincipalsPaginator added in v0.30.0 

func NewListPolicyPrincipalsPaginator(client ListPolicyPrincipalsAPIClient, params *ListPolicyPrincipalsInput, optFns ...func(*ListPolicyPrincipalsPaginatorOptions)) *ListPolicyPrincipalsPaginator

NewListPolicyPrincipalsPaginator returns a new ListPolicyPrincipalsPaginator

func (*ListPolicyPrincipalsPaginator) HasMorePages added in v0.30.0 

func (p *ListPolicyPrincipalsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPolicyPrincipalsPaginator) NextPage added in v0.30.0 

func (p *ListPolicyPrincipalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPolicyPrincipalsOutput, error)

NextPage retrieves the next ListPolicyPrincipals page.

type ListPolicyPrincipalsPaginatorOptions added in v0.30.0 

type ListPolicyPrincipalsPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPolicyPrincipalsPaginatorOptions is the paginator options for ListPolicyPrincipals

type ListPolicyVersionsInput 

type ListPolicyVersionsInput struct {

	// The policy name.
	//
	// This member is required.
	PolicyName *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the ListPolicyVersions operation.

type ListPrincipalPoliciesAPIClient added in v0.30.0 

type ListPrincipalPoliciesAPIClient interface {
	ListPrincipalPolicies(context.Context, *ListPrincipalPoliciesInput, ...func(*Options)) (*ListPrincipalPoliciesOutput, error)
}

ListPrincipalPoliciesAPIClient is a client that implements the ListPrincipalPolicies operation.

type ListPrincipalPoliciesInput 

type ListPrincipalPoliciesInput struct {

	// The principal. Valid principals are CertificateArn
	// (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
	// (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
	//
	// This member is required.
	Principal *string

	// Specifies the order for results. If true, results are returned in ascending
	// creation order.
	AscendingOrder bool

	// The marker for the next set of results.
	Marker *string

	// The result page size.
	PageSize *int32
	// contains filtered or unexported fields
}

The input for the ListPrincipalPolicies operation.

type ListPrincipalPoliciesOutput 

type ListPrincipalPoliciesOutput struct {

	// The marker for the next set of results, or null if there are no additional
	// results.
	NextMarker *string

	// The policies.
	Policies []types.Policy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the ListPrincipalPolicies operation.

type ListPrincipalPoliciesPaginator added in v0.30.0 

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

ListPrincipalPoliciesPaginator is a paginator for ListPrincipalPolicies

func NewListPrincipalPoliciesPaginator added in v0.30.0 

func NewListPrincipalPoliciesPaginator(client ListPrincipalPoliciesAPIClient, params *ListPrincipalPoliciesInput, optFns ...func(*ListPrincipalPoliciesPaginatorOptions)) *ListPrincipalPoliciesPaginator

NewListPrincipalPoliciesPaginator returns a new ListPrincipalPoliciesPaginator

func (*ListPrincipalPoliciesPaginator) HasMorePages added in v0.30.0 

func (p *ListPrincipalPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPrincipalPoliciesPaginator) NextPage added in v0.30.0 

func (p *ListPrincipalPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalPoliciesOutput, error)

NextPage retrieves the next ListPrincipalPolicies page.

type ListPrincipalPoliciesPaginatorOptions added in v0.30.0 

type ListPrincipalPoliciesPaginatorOptions struct {
	// The result page size.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPrincipalPoliciesPaginatorOptions is the paginator options for ListPrincipalPolicies

type ListPrincipalThingsAPIClient added in v0.30.0 

type ListPrincipalThingsAPIClient interface {
	ListPrincipalThings(context.Context, *ListPrincipalThingsInput, ...func(*Options)) (*ListPrincipalThingsOutput, error)
}

ListPrincipalThingsAPIClient is a client that implements the ListPrincipalThings operation.

type ListPrincipalThingsInput 

type ListPrincipalThingsInput struct {

	// The principal.
	//
	// This member is required.
	Principal *string

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

The input for the ListPrincipalThings operation.

type ListPrincipalThingsOutput 

type ListPrincipalThingsOutput struct {

	// The token to use 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
	// contains filtered or unexported fields
}

The output from the ListPrincipalThings operation.

type ListPrincipalThingsPaginator added in v0.30.0 

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

ListPrincipalThingsPaginator is a paginator for ListPrincipalThings

func NewListPrincipalThingsPaginator added in v0.30.0 

func NewListPrincipalThingsPaginator(client ListPrincipalThingsAPIClient, params *ListPrincipalThingsInput, optFns ...func(*ListPrincipalThingsPaginatorOptions)) *ListPrincipalThingsPaginator

NewListPrincipalThingsPaginator returns a new ListPrincipalThingsPaginator

func (*ListPrincipalThingsPaginator) HasMorePages added in v0.30.0 

func (p *ListPrincipalThingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPrincipalThingsPaginator) NextPage added in v0.30.0 

func (p *ListPrincipalThingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalThingsOutput, error)

NextPage retrieves the next ListPrincipalThings page.

type ListPrincipalThingsPaginatorOptions added in v0.30.0 

type ListPrincipalThingsPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPrincipalThingsPaginatorOptions is the paginator options for ListPrincipalThings

type ListPrincipalThingsV2APIClient added in v1.60.0 

type ListPrincipalThingsV2APIClient interface {
	ListPrincipalThingsV2(context.Context, *ListPrincipalThingsV2Input, ...func(*Options)) (*ListPrincipalThingsV2Output, error)
}

ListPrincipalThingsV2APIClient is a client that implements the ListPrincipalThingsV2 operation.

type ListPrincipalThingsV2Input added in v1.60.0 

type ListPrincipalThingsV2Input struct {

	// The principal. A principal can be an X.509 certificate or an Amazon Cognito ID.
	//
	// This member is required.
	Principal *string

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// The type of the relation you want to filter in the response. If no value is
	// provided in this field, the response will list all things, including both the
	// EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment types.
	//
	//   - EXCLUSIVE_THING - Attaches the specified principal to the specified thing,
	//   exclusively. The thing will be the only thing that’s attached to the principal.
	//
	//   - NON_EXCLUSIVE_THING - Attaches the specified principal to the specified
	//   thing. Multiple things can be attached to the principal.
	ThingPrincipalType types.ThingPrincipalType
	// contains filtered or unexported fields
}

type ListPrincipalThingsV2Output added in v1.60.0 

type ListPrincipalThingsV2Output struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// A list of thingPrincipalObject that represents the principal and the type of
	// relation it has with the thing.
	PrincipalThingObjects []types.PrincipalThingObject

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPrincipalThingsV2Paginator added in v1.60.0 

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

ListPrincipalThingsV2Paginator is a paginator for ListPrincipalThingsV2

func NewListPrincipalThingsV2Paginator added in v1.60.0 

func NewListPrincipalThingsV2Paginator(client ListPrincipalThingsV2APIClient, params *ListPrincipalThingsV2Input, optFns ...func(*ListPrincipalThingsV2PaginatorOptions)) *ListPrincipalThingsV2Paginator

NewListPrincipalThingsV2Paginator returns a new ListPrincipalThingsV2Paginator

func (*ListPrincipalThingsV2Paginator) HasMorePages added in v1.60.0 

func (p *ListPrincipalThingsV2Paginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPrincipalThingsV2Paginator) NextPage added in v1.60.0 

func (p *ListPrincipalThingsV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalThingsV2Output, error)

NextPage retrieves the next ListPrincipalThingsV2 page.

type ListPrincipalThingsV2PaginatorOptions added in v1.60.0 

type ListPrincipalThingsV2PaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPrincipalThingsV2PaginatorOptions is the paginator options for ListPrincipalThingsV2

type ListProvisioningTemplateVersionsAPIClient added in v0.30.0 

type ListProvisioningTemplateVersionsAPIClient interface {
	ListProvisioningTemplateVersions(context.Context, *ListProvisioningTemplateVersionsInput, ...func(*Options)) (*ListProvisioningTemplateVersionsOutput, error)
}

ListProvisioningTemplateVersionsAPIClient is a client that implements the ListProvisioningTemplateVersions operation.

type ListProvisioningTemplateVersionsInput 

type ListProvisioningTemplateVersionsInput struct {

	// The name of the provisioning template.
	//
	// This member is required.
	TemplateName *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProvisioningTemplateVersionsOutput 

type ListProvisioningTemplateVersionsOutput struct {

	// A token to retrieve the next set of results.
	NextToken *string

	// The list of provisioning template versions.
	Versions []types.ProvisioningTemplateVersionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProvisioningTemplateVersionsPaginator added in v0.30.0 

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

ListProvisioningTemplateVersionsPaginator is a paginator for ListProvisioningTemplateVersions

func NewListProvisioningTemplateVersionsPaginator added in v0.30.0 

func NewListProvisioningTemplateVersionsPaginator(client ListProvisioningTemplateVersionsAPIClient, params *ListProvisioningTemplateVersionsInput, optFns ...func(*ListProvisioningTemplateVersionsPaginatorOptions)) *ListProvisioningTemplateVersionsPaginator

NewListProvisioningTemplateVersionsPaginator returns a new ListProvisioningTemplateVersionsPaginator

func (*ListProvisioningTemplateVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListProvisioningTemplateVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProvisioningTemplateVersionsPaginator) NextPage added in v0.30.0 

func (p *ListProvisioningTemplateVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProvisioningTemplateVersionsOutput, error)

NextPage retrieves the next ListProvisioningTemplateVersions page.

type ListProvisioningTemplateVersionsPaginatorOptions added in v0.30.0 

type ListProvisioningTemplateVersionsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProvisioningTemplateVersionsPaginatorOptions is the paginator options for ListProvisioningTemplateVersions

type ListProvisioningTemplatesAPIClient added in v0.30.0 

type ListProvisioningTemplatesAPIClient interface {
	ListProvisioningTemplates(context.Context, *ListProvisioningTemplatesInput, ...func(*Options)) (*ListProvisioningTemplatesOutput, error)
}

ListProvisioningTemplatesAPIClient is a client that implements the ListProvisioningTemplates operation.

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
	// contains filtered or unexported fields
}

type ListProvisioningTemplatesOutput 

type ListProvisioningTemplatesOutput struct {

	// A token to retrieve the next set of results.
	NextToken *string

	// A list of provisioning templates
	Templates []types.ProvisioningTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProvisioningTemplatesPaginator added in v0.30.0 

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

ListProvisioningTemplatesPaginator is a paginator for ListProvisioningTemplates

func NewListProvisioningTemplatesPaginator added in v0.30.0 

func NewListProvisioningTemplatesPaginator(client ListProvisioningTemplatesAPIClient, params *ListProvisioningTemplatesInput, optFns ...func(*ListProvisioningTemplatesPaginatorOptions)) *ListProvisioningTemplatesPaginator

NewListProvisioningTemplatesPaginator returns a new ListProvisioningTemplatesPaginator

func (*ListProvisioningTemplatesPaginator) HasMorePages added in v0.30.0 

func (p *ListProvisioningTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProvisioningTemplatesPaginator) NextPage added in v0.30.0 

func (p *ListProvisioningTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProvisioningTemplatesOutput, error)

NextPage retrieves the next ListProvisioningTemplates page.

type ListProvisioningTemplatesPaginatorOptions added in v0.30.0 

type ListProvisioningTemplatesPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProvisioningTemplatesPaginatorOptions is the paginator options for ListProvisioningTemplates

type ListRelatedResourcesForAuditFindingAPIClient added in v1.36.0 

type ListRelatedResourcesForAuditFindingAPIClient interface {
	ListRelatedResourcesForAuditFinding(context.Context, *ListRelatedResourcesForAuditFindingInput, ...func(*Options)) (*ListRelatedResourcesForAuditFindingOutput, error)
}

ListRelatedResourcesForAuditFindingAPIClient is a client that implements the ListRelatedResourcesForAuditFinding operation.

type ListRelatedResourcesForAuditFindingInput added in v1.31.0 

type ListRelatedResourcesForAuditFindingInput struct {

	// The finding Id.
	//
	// This member is required.
	FindingId *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRelatedResourcesForAuditFindingOutput added in v1.31.0 

type ListRelatedResourcesForAuditFindingOutput struct {

	// A token that can be used to retrieve the next set of results, or null for the
	// first API call.
	NextToken *string

	// The related resources.
	RelatedResources []types.RelatedResource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRelatedResourcesForAuditFindingPaginator added in v1.36.0 

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

ListRelatedResourcesForAuditFindingPaginator is a paginator for ListRelatedResourcesForAuditFinding

func NewListRelatedResourcesForAuditFindingPaginator added in v1.36.0 

func NewListRelatedResourcesForAuditFindingPaginator(client ListRelatedResourcesForAuditFindingAPIClient, params *ListRelatedResourcesForAuditFindingInput, optFns ...func(*ListRelatedResourcesForAuditFindingPaginatorOptions)) *ListRelatedResourcesForAuditFindingPaginator

NewListRelatedResourcesForAuditFindingPaginator returns a new ListRelatedResourcesForAuditFindingPaginator

func (*ListRelatedResourcesForAuditFindingPaginator) HasMorePages added in v1.36.0 

func (p *ListRelatedResourcesForAuditFindingPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRelatedResourcesForAuditFindingPaginator) NextPage added in v1.36.0 

func (p *ListRelatedResourcesForAuditFindingPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRelatedResourcesForAuditFindingOutput, error)

NextPage retrieves the next ListRelatedResourcesForAuditFinding page.

type ListRelatedResourcesForAuditFindingPaginatorOptions added in v1.36.0 

type ListRelatedResourcesForAuditFindingPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRelatedResourcesForAuditFindingPaginatorOptions is the paginator options for ListRelatedResourcesForAuditFinding

type ListRoleAliasesAPIClient added in v0.30.0 

type ListRoleAliasesAPIClient interface {
	ListRoleAliases(context.Context, *ListRoleAliasesInput, ...func(*Options)) (*ListRoleAliasesOutput, error)
}

ListRoleAliasesAPIClient is a client that implements the ListRoleAliases operation.

type ListRoleAliasesInput 

type ListRoleAliasesInput struct {

	// Return the list of role aliases in ascending alphabetical order.
	AscendingOrder bool

	// A marker used to get the next set of results.
	Marker *string

	// The maximum number of results to return at one time.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListRoleAliasesOutput 

type ListRoleAliasesOutput struct {

	// A marker used to get the next set of results.
	NextMarker *string

	// The role aliases.
	RoleAliases []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRoleAliasesPaginator added in v0.30.0 

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

ListRoleAliasesPaginator is a paginator for ListRoleAliases

func NewListRoleAliasesPaginator added in v0.30.0 

func NewListRoleAliasesPaginator(client ListRoleAliasesAPIClient, params *ListRoleAliasesInput, optFns ...func(*ListRoleAliasesPaginatorOptions)) *ListRoleAliasesPaginator

NewListRoleAliasesPaginator returns a new ListRoleAliasesPaginator

func (*ListRoleAliasesPaginator) HasMorePages added in v0.30.0 

func (p *ListRoleAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRoleAliasesPaginator) NextPage added in v0.30.0 

func (p *ListRoleAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRoleAliasesOutput, error)

NextPage retrieves the next ListRoleAliases page.

type ListRoleAliasesPaginatorOptions added in v0.30.0 

type ListRoleAliasesPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRoleAliasesPaginatorOptions is the paginator options for ListRoleAliases

type ListSbomValidationResultsAPIClient added in v1.56.0 

type ListSbomValidationResultsAPIClient interface {
	ListSbomValidationResults(context.Context, *ListSbomValidationResultsInput, ...func(*Options)) (*ListSbomValidationResultsOutput, error)
}

ListSbomValidationResultsAPIClient is a client that implements the ListSbomValidationResults operation.

type ListSbomValidationResultsInput added in v1.56.0 

type ListSbomValidationResultsInput struct {

	// The name of the new software package.
	//
	// This member is required.
	PackageName *string

	// The name of the new package version.
	//
	// This member is required.
	VersionName *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A token that can be used to retrieve the next set of results, or null if there
	// are no additional results.
	NextToken *string

	// The end result of the
	ValidationResult types.SbomValidationResult
	// contains filtered or unexported fields
}

type ListSbomValidationResultsOutput added in v1.56.0 

type ListSbomValidationResultsOutput 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 summary of the validation results for each software bill of materials
	// attached to a software package version.
	ValidationResultSummaries []types.SbomValidationResultSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSbomValidationResultsPaginator added in v1.56.0 

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

ListSbomValidationResultsPaginator is a paginator for ListSbomValidationResults

func NewListSbomValidationResultsPaginator added in v1.56.0 

func NewListSbomValidationResultsPaginator(client ListSbomValidationResultsAPIClient, params *ListSbomValidationResultsInput, optFns ...func(*ListSbomValidationResultsPaginatorOptions)) *ListSbomValidationResultsPaginator

NewListSbomValidationResultsPaginator returns a new ListSbomValidationResultsPaginator

func (*ListSbomValidationResultsPaginator) HasMorePages added in v1.56.0 

func (p *ListSbomValidationResultsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSbomValidationResultsPaginator) NextPage added in v1.56.0 

func (p *ListSbomValidationResultsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSbomValidationResultsOutput, error)

NextPage retrieves the next ListSbomValidationResults page.

type ListSbomValidationResultsPaginatorOptions added in v1.56.0 

type ListSbomValidationResultsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSbomValidationResultsPaginatorOptions is the paginator options for ListSbomValidationResults

type ListScheduledAuditsAPIClient added in v0.30.0 

type ListScheduledAuditsAPIClient interface {
	ListScheduledAudits(context.Context, *ListScheduledAuditsInput, ...func(*Options)) (*ListScheduledAuditsOutput, error)
}

ListScheduledAuditsAPIClient is a client that implements the ListScheduledAudits operation.

type ListScheduledAuditsInput 

type ListScheduledAuditsInput struct {

	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListScheduledAuditsPaginator added in v0.30.0 

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

ListScheduledAuditsPaginator is a paginator for ListScheduledAudits

func NewListScheduledAuditsPaginator added in v0.30.0 

func NewListScheduledAuditsPaginator(client ListScheduledAuditsAPIClient, params *ListScheduledAuditsInput, optFns ...func(*ListScheduledAuditsPaginatorOptions)) *ListScheduledAuditsPaginator

NewListScheduledAuditsPaginator returns a new ListScheduledAuditsPaginator

func (*ListScheduledAuditsPaginator) HasMorePages added in v0.30.0 

func (p *ListScheduledAuditsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListScheduledAuditsPaginator) NextPage added in v0.30.0 

func (p *ListScheduledAuditsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListScheduledAuditsOutput, error)

NextPage retrieves the next ListScheduledAudits page.

type ListScheduledAuditsPaginatorOptions added in v0.30.0 

type ListScheduledAuditsPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListScheduledAuditsPaginatorOptions is the paginator options for ListScheduledAudits

type ListSecurityProfilesAPIClient added in v0.30.0 

type ListSecurityProfilesAPIClient interface {
	ListSecurityProfiles(context.Context, *ListSecurityProfilesInput, ...func(*Options)) (*ListSecurityProfilesOutput, error)
}

ListSecurityProfilesAPIClient is a client that implements the ListSecurityProfiles operation.

type ListSecurityProfilesForTargetAPIClient added in v0.30.0 

type ListSecurityProfilesForTargetAPIClient interface {
	ListSecurityProfilesForTarget(context.Context, *ListSecurityProfilesForTargetInput, ...func(*Options)) (*ListSecurityProfilesForTargetOutput, error)
}

ListSecurityProfilesForTargetAPIClient is a client that implements the ListSecurityProfilesForTarget operation.

type ListSecurityProfilesForTargetInput 

type ListSecurityProfilesForTargetInput struct {

	// The ARN of the target (thing group) whose attached security profiles you want
	// to get.
	//
	// This member is required.
	SecurityProfileTargetArn *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// If true, return child groups too.
	Recursive bool
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListSecurityProfilesForTargetPaginator added in v0.30.0 

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

ListSecurityProfilesForTargetPaginator is a paginator for ListSecurityProfilesForTarget

func NewListSecurityProfilesForTargetPaginator added in v0.30.0 

func NewListSecurityProfilesForTargetPaginator(client ListSecurityProfilesForTargetAPIClient, params *ListSecurityProfilesForTargetInput, optFns ...func(*ListSecurityProfilesForTargetPaginatorOptions)) *ListSecurityProfilesForTargetPaginator

NewListSecurityProfilesForTargetPaginator returns a new ListSecurityProfilesForTargetPaginator

func (*ListSecurityProfilesForTargetPaginator) HasMorePages added in v0.30.0 

func (p *ListSecurityProfilesForTargetPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityProfilesForTargetPaginator) NextPage added in v0.30.0 

func (p *ListSecurityProfilesForTargetPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityProfilesForTargetOutput, error)

NextPage retrieves the next ListSecurityProfilesForTarget page.

type ListSecurityProfilesForTargetPaginatorOptions added in v0.30.0 

type ListSecurityProfilesForTargetPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSecurityProfilesForTargetPaginatorOptions is the paginator options for ListSecurityProfilesForTarget

type ListSecurityProfilesInput 

type ListSecurityProfilesInput struct {

	// A filter to limit results to the security profiles that use the defined
	// dimension. Cannot be used with metricName
	DimensionName *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	//  The name of the custom metric. Cannot be used with dimensionName .
	MetricName *string

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListSecurityProfilesPaginator added in v0.30.0 

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

ListSecurityProfilesPaginator is a paginator for ListSecurityProfiles

func NewListSecurityProfilesPaginator added in v0.30.0 

func NewListSecurityProfilesPaginator(client ListSecurityProfilesAPIClient, params *ListSecurityProfilesInput, optFns ...func(*ListSecurityProfilesPaginatorOptions)) *ListSecurityProfilesPaginator

NewListSecurityProfilesPaginator returns a new ListSecurityProfilesPaginator

func (*ListSecurityProfilesPaginator) HasMorePages added in v0.30.0 

func (p *ListSecurityProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSecurityProfilesPaginator) NextPage added in v0.30.0 

func (p *ListSecurityProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error)

NextPage retrieves the next ListSecurityProfiles page.

type ListSecurityProfilesPaginatorOptions added in v0.30.0 

type ListSecurityProfilesPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSecurityProfilesPaginatorOptions is the paginator options for ListSecurityProfiles

type ListStreamsAPIClient added in v0.30.0 

type ListStreamsAPIClient interface {
	ListStreams(context.Context, *ListStreamsInput, ...func(*Options)) (*ListStreamsOutput, error)
}

ListStreamsAPIClient is a client that implements the ListStreams operation.

type ListStreamsInput 

type ListStreamsInput struct {

	// Set to true to return the list of streams in ascending order.
	AscendingOrder bool

	// The maximum number of results to return at a time.
	MaxResults *int32

	// A token used to get the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListStreamsPaginator added in v0.30.0 

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

ListStreamsPaginator is a paginator for ListStreams

func NewListStreamsPaginator added in v0.30.0 

func NewListStreamsPaginator(client ListStreamsAPIClient, params *ListStreamsInput, optFns ...func(*ListStreamsPaginatorOptions)) *ListStreamsPaginator

NewListStreamsPaginator returns a new ListStreamsPaginator

func (*ListStreamsPaginator) HasMorePages added in v0.30.0 

func (p *ListStreamsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamsPaginator) NextPage added in v0.30.0 

func (p *ListStreamsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamsOutput, error)

NextPage retrieves the next ListStreams page.

type ListStreamsPaginatorOptions added in v0.30.0 

type ListStreamsPaginatorOptions struct {
	// The maximum number of results to return at a time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStreamsPaginatorOptions is the paginator options for ListStreams

type ListTagsForResourceAPIClient added in v0.30.0 

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceArn *string

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// The list of tags assigned to the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourcePaginator added in v0.30.0 

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v0.30.0 

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v0.30.0 

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v0.30.0 

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v0.30.0 

type ListTagsForResourcePaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type ListTargetsForPolicyAPIClient added in v0.30.0 

type ListTargetsForPolicyAPIClient interface {
	ListTargetsForPolicy(context.Context, *ListTargetsForPolicyInput, ...func(*Options)) (*ListTargetsForPolicyOutput, error)
}

ListTargetsForPolicyAPIClient is a client that implements the ListTargetsForPolicy operation.

type ListTargetsForPolicyInput 

type ListTargetsForPolicyInput struct {

	// The policy name.
	//
	// This member is required.
	PolicyName *string

	// A marker used to get the next set of results.
	Marker *string

	// The maximum number of results to return at one time.
	PageSize *int32
	// contains filtered or unexported fields
}

type ListTargetsForPolicyOutput 

type ListTargetsForPolicyOutput struct {

	// A marker used to get the next set of results.
	NextMarker *string

	// The policy targets.
	Targets []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTargetsForPolicyPaginator added in v0.30.0 

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

ListTargetsForPolicyPaginator is a paginator for ListTargetsForPolicy

func NewListTargetsForPolicyPaginator added in v0.30.0 

func NewListTargetsForPolicyPaginator(client ListTargetsForPolicyAPIClient, params *ListTargetsForPolicyInput, optFns ...func(*ListTargetsForPolicyPaginatorOptions)) *ListTargetsForPolicyPaginator

NewListTargetsForPolicyPaginator returns a new ListTargetsForPolicyPaginator

func (*ListTargetsForPolicyPaginator) HasMorePages added in v0.30.0 

func (p *ListTargetsForPolicyPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTargetsForPolicyPaginator) NextPage added in v0.30.0 

func (p *ListTargetsForPolicyPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTargetsForPolicyOutput, error)

NextPage retrieves the next ListTargetsForPolicy page.

type ListTargetsForPolicyPaginatorOptions added in v0.30.0 

type ListTargetsForPolicyPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTargetsForPolicyPaginatorOptions is the paginator options for ListTargetsForPolicy

type ListTargetsForSecurityProfileAPIClient added in v0.30.0 

type ListTargetsForSecurityProfileAPIClient interface {
	ListTargetsForSecurityProfile(context.Context, *ListTargetsForSecurityProfileInput, ...func(*Options)) (*ListTargetsForSecurityProfileOutput, error)
}

ListTargetsForSecurityProfileAPIClient is a client that implements the ListTargetsForSecurityProfile operation.

type ListTargetsForSecurityProfileInput 

type ListTargetsForSecurityProfileInput struct {

	// The security profile.
	//
	// This member is required.
	SecurityProfileName *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListTargetsForSecurityProfilePaginator added in v0.30.0 

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

ListTargetsForSecurityProfilePaginator is a paginator for ListTargetsForSecurityProfile

func NewListTargetsForSecurityProfilePaginator added in v0.30.0 

func NewListTargetsForSecurityProfilePaginator(client ListTargetsForSecurityProfileAPIClient, params *ListTargetsForSecurityProfileInput, optFns ...func(*ListTargetsForSecurityProfilePaginatorOptions)) *ListTargetsForSecurityProfilePaginator

NewListTargetsForSecurityProfilePaginator returns a new ListTargetsForSecurityProfilePaginator

func (*ListTargetsForSecurityProfilePaginator) HasMorePages added in v0.30.0 

func (p *ListTargetsForSecurityProfilePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTargetsForSecurityProfilePaginator) NextPage added in v0.30.0 

func (p *ListTargetsForSecurityProfilePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTargetsForSecurityProfileOutput, error)

NextPage retrieves the next ListTargetsForSecurityProfile page.

type ListTargetsForSecurityProfilePaginatorOptions added in v0.30.0 

type ListTargetsForSecurityProfilePaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTargetsForSecurityProfilePaginatorOptions is the paginator options for ListTargetsForSecurityProfile

type ListThingGroupsAPIClient added in v0.30.0 

type ListThingGroupsAPIClient interface {
	ListThingGroups(context.Context, *ListThingGroupsInput, ...func(*Options)) (*ListThingGroupsOutput, error)
}

ListThingGroupsAPIClient is a client that implements the ListThingGroups operation.

type ListThingGroupsForThingAPIClient added in v0.30.0 

type ListThingGroupsForThingAPIClient interface {
	ListThingGroupsForThing(context.Context, *ListThingGroupsForThingInput, ...func(*Options)) (*ListThingGroupsForThingOutput, error)
}

ListThingGroupsForThingAPIClient is a client that implements the ListThingGroupsForThing operation.

type ListThingGroupsForThingInput 

type ListThingGroupsForThingInput struct {

	// The thing name.
	//
	// This member is required.
	ThingName *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListThingGroupsForThingOutput 

type ListThingGroupsForThingOutput struct {

	// The token to use 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
	// contains filtered or unexported fields
}

type ListThingGroupsForThingPaginator added in v0.30.0 

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

ListThingGroupsForThingPaginator is a paginator for ListThingGroupsForThing

func NewListThingGroupsForThingPaginator added in v0.30.0 

func NewListThingGroupsForThingPaginator(client ListThingGroupsForThingAPIClient, params *ListThingGroupsForThingInput, optFns ...func(*ListThingGroupsForThingPaginatorOptions)) *ListThingGroupsForThingPaginator

NewListThingGroupsForThingPaginator returns a new ListThingGroupsForThingPaginator

func (*ListThingGroupsForThingPaginator) HasMorePages added in v0.30.0 

func (p *ListThingGroupsForThingPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingGroupsForThingPaginator) NextPage added in v0.30.0 

func (p *ListThingGroupsForThingPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingGroupsForThingOutput, error)

NextPage retrieves the next ListThingGroupsForThing page.

type ListThingGroupsForThingPaginatorOptions added in v0.30.0 

type ListThingGroupsForThingPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingGroupsForThingPaginatorOptions is the paginator options for ListThingGroupsForThing

type ListThingGroupsInput 

type ListThingGroupsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// A filter that limits the results to those with the specified name prefix.
	NamePrefixFilter *string

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *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
	// contains filtered or unexported fields
}

type ListThingGroupsOutput 

type ListThingGroupsOutput struct {

	// The token to use to get the next set of results. Will not be returned if
	// operation has returned all results.
	NextToken *string

	// The thing groups.
	ThingGroups []types.GroupNameAndArn

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThingGroupsPaginator added in v0.30.0 

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

ListThingGroupsPaginator is a paginator for ListThingGroups

func NewListThingGroupsPaginator added in v0.30.0 

func NewListThingGroupsPaginator(client ListThingGroupsAPIClient, params *ListThingGroupsInput, optFns ...func(*ListThingGroupsPaginatorOptions)) *ListThingGroupsPaginator

NewListThingGroupsPaginator returns a new ListThingGroupsPaginator

func (*ListThingGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListThingGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingGroupsPaginator) NextPage added in v0.30.0 

func (p *ListThingGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingGroupsOutput, error)

NextPage retrieves the next ListThingGroups page.

type ListThingGroupsPaginatorOptions added in v0.30.0 

type ListThingGroupsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingGroupsPaginatorOptions is the paginator options for ListThingGroups

type ListThingPrincipalsAPIClient added in v0.30.0 

type ListThingPrincipalsAPIClient interface {
	ListThingPrincipals(context.Context, *ListThingPrincipalsInput, ...func(*Options)) (*ListThingPrincipalsOutput, error)
}

ListThingPrincipalsAPIClient is a client that implements the ListThingPrincipals operation.

type ListThingPrincipalsInput 

type ListThingPrincipalsInput struct {

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

The input for the ListThingPrincipal operation.

type ListThingPrincipalsOutput 

type ListThingPrincipalsOutput struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// The principals associated with the thing.
	Principals []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the ListThingPrincipals operation.

type ListThingPrincipalsPaginator added in v0.30.0 

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

ListThingPrincipalsPaginator is a paginator for ListThingPrincipals

func NewListThingPrincipalsPaginator added in v0.30.0 

func NewListThingPrincipalsPaginator(client ListThingPrincipalsAPIClient, params *ListThingPrincipalsInput, optFns ...func(*ListThingPrincipalsPaginatorOptions)) *ListThingPrincipalsPaginator

NewListThingPrincipalsPaginator returns a new ListThingPrincipalsPaginator

func (*ListThingPrincipalsPaginator) HasMorePages added in v0.30.0 

func (p *ListThingPrincipalsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingPrincipalsPaginator) NextPage added in v0.30.0 

func (p *ListThingPrincipalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingPrincipalsOutput, error)

NextPage retrieves the next ListThingPrincipals page.

type ListThingPrincipalsPaginatorOptions added in v0.30.0 

type ListThingPrincipalsPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingPrincipalsPaginatorOptions is the paginator options for ListThingPrincipals

type ListThingPrincipalsV2APIClient added in v1.60.0 

type ListThingPrincipalsV2APIClient interface {
	ListThingPrincipalsV2(context.Context, *ListThingPrincipalsV2Input, ...func(*Options)) (*ListThingPrincipalsV2Output, error)
}

ListThingPrincipalsV2APIClient is a client that implements the ListThingPrincipalsV2 operation.

type ListThingPrincipalsV2Input added in v1.60.0 

type ListThingPrincipalsV2Input struct {

	// The name of the thing.
	//
	// This member is required.
	ThingName *string

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// The type of the relation you want to filter in the response. If no value is
	// provided in this field, the response will list all principals, including both
	// the EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment types.
	//
	//   - EXCLUSIVE_THING - Attaches the specified principal to the specified thing,
	//   exclusively. The thing will be the only thing that’s attached to the principal.
	//
	//   - NON_EXCLUSIVE_THING - Attaches the specified principal to the specified
	//   thing. Multiple things can be attached to the principal.
	ThingPrincipalType types.ThingPrincipalType
	// contains filtered or unexported fields
}

type ListThingPrincipalsV2Output added in v1.60.0 

type ListThingPrincipalsV2Output struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// A list of thingPrincipalObject that represents the principal and the type of
	// relation it has with the thing.
	ThingPrincipalObjects []types.ThingPrincipalObject

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThingPrincipalsV2Paginator added in v1.60.0 

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

ListThingPrincipalsV2Paginator is a paginator for ListThingPrincipalsV2

func NewListThingPrincipalsV2Paginator added in v1.60.0 

func NewListThingPrincipalsV2Paginator(client ListThingPrincipalsV2APIClient, params *ListThingPrincipalsV2Input, optFns ...func(*ListThingPrincipalsV2PaginatorOptions)) *ListThingPrincipalsV2Paginator

NewListThingPrincipalsV2Paginator returns a new ListThingPrincipalsV2Paginator

func (*ListThingPrincipalsV2Paginator) HasMorePages added in v1.60.0 

func (p *ListThingPrincipalsV2Paginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingPrincipalsV2Paginator) NextPage added in v1.60.0 

func (p *ListThingPrincipalsV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingPrincipalsV2Output, error)

NextPage retrieves the next ListThingPrincipalsV2 page.

type ListThingPrincipalsV2PaginatorOptions added in v1.60.0 

type ListThingPrincipalsV2PaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingPrincipalsV2PaginatorOptions is the paginator options for ListThingPrincipalsV2

type ListThingRegistrationTaskReportsAPIClient added in v0.30.0 

type ListThingRegistrationTaskReportsAPIClient interface {
	ListThingRegistrationTaskReports(context.Context, *ListThingRegistrationTaskReportsInput, ...func(*Options)) (*ListThingRegistrationTaskReportsOutput, error)
}

ListThingRegistrationTaskReportsAPIClient is a client that implements the ListThingRegistrationTaskReports operation.

type ListThingRegistrationTaskReportsInput 

type ListThingRegistrationTaskReportsInput struct {

	// The type of task report.
	//
	// This member is required.
	ReportType types.ReportType

	// The id of the task.
	//
	// This member is required.
	TaskId *string

	// The maximum number of results to return per request.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListThingRegistrationTaskReportsOutput 

type ListThingRegistrationTaskReportsOutput struct {

	// The token to use 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
	// contains filtered or unexported fields
}

type ListThingRegistrationTaskReportsPaginator added in v0.30.0 

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

ListThingRegistrationTaskReportsPaginator is a paginator for ListThingRegistrationTaskReports

func NewListThingRegistrationTaskReportsPaginator added in v0.30.0 

func NewListThingRegistrationTaskReportsPaginator(client ListThingRegistrationTaskReportsAPIClient, params *ListThingRegistrationTaskReportsInput, optFns ...func(*ListThingRegistrationTaskReportsPaginatorOptions)) *ListThingRegistrationTaskReportsPaginator

NewListThingRegistrationTaskReportsPaginator returns a new ListThingRegistrationTaskReportsPaginator

func (*ListThingRegistrationTaskReportsPaginator) HasMorePages added in v0.30.0 

func (p *ListThingRegistrationTaskReportsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingRegistrationTaskReportsPaginator) NextPage added in v0.30.0 

func (p *ListThingRegistrationTaskReportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingRegistrationTaskReportsOutput, error)

NextPage retrieves the next ListThingRegistrationTaskReports page.

type ListThingRegistrationTaskReportsPaginatorOptions added in v0.30.0 

type ListThingRegistrationTaskReportsPaginatorOptions struct {
	// The maximum number of results to return per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingRegistrationTaskReportsPaginatorOptions is the paginator options for ListThingRegistrationTaskReports

type ListThingRegistrationTasksAPIClient added in v0.30.0 

type ListThingRegistrationTasksAPIClient interface {
	ListThingRegistrationTasks(context.Context, *ListThingRegistrationTasksInput, ...func(*Options)) (*ListThingRegistrationTasksOutput, error)
}

ListThingRegistrationTasksAPIClient is a client that implements the ListThingRegistrationTasks operation.

type ListThingRegistrationTasksInput 

type ListThingRegistrationTasksInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// The status of the bulk thing provisioning task.
	Status types.Status
	// contains filtered or unexported fields
}

type ListThingRegistrationTasksOutput 

type ListThingRegistrationTasksOutput struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// A list of bulk thing provisioning task IDs.
	TaskIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThingRegistrationTasksPaginator added in v0.30.0 

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

ListThingRegistrationTasksPaginator is a paginator for ListThingRegistrationTasks

func NewListThingRegistrationTasksPaginator added in v0.30.0 

func NewListThingRegistrationTasksPaginator(client ListThingRegistrationTasksAPIClient, params *ListThingRegistrationTasksInput, optFns ...func(*ListThingRegistrationTasksPaginatorOptions)) *ListThingRegistrationTasksPaginator

NewListThingRegistrationTasksPaginator returns a new ListThingRegistrationTasksPaginator

func (*ListThingRegistrationTasksPaginator) HasMorePages added in v0.30.0 

func (p *ListThingRegistrationTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingRegistrationTasksPaginator) NextPage added in v0.30.0 

func (p *ListThingRegistrationTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingRegistrationTasksOutput, error)

NextPage retrieves the next ListThingRegistrationTasks page.

type ListThingRegistrationTasksPaginatorOptions added in v0.30.0 

type ListThingRegistrationTasksPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingRegistrationTasksPaginatorOptions is the paginator options for ListThingRegistrationTasks

type ListThingTypesAPIClient added in v0.30.0 

type ListThingTypesAPIClient interface {
	ListThingTypes(context.Context, *ListThingTypesInput, ...func(*Options)) (*ListThingTypesOutput, error)
}

ListThingTypesAPIClient is a client that implements the ListThingTypes operation.

type ListThingTypesInput 

type ListThingTypesInput struct {

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// The name of the thing type.
	ThingTypeName *string
	// contains filtered or unexported fields
}

The input for the ListThingTypes operation.

type ListThingTypesOutput 

type ListThingTypesOutput struct {

	// The token for the next set of results. Will not be returned if operation has
	// returned all results.
	NextToken *string

	// The thing types.
	ThingTypes []types.ThingTypeDefinition

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output for the ListThingTypes operation.

type ListThingTypesPaginator added in v0.30.0 

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

ListThingTypesPaginator is a paginator for ListThingTypes

func NewListThingTypesPaginator added in v0.30.0 

func NewListThingTypesPaginator(client ListThingTypesAPIClient, params *ListThingTypesInput, optFns ...func(*ListThingTypesPaginatorOptions)) *ListThingTypesPaginator

NewListThingTypesPaginator returns a new ListThingTypesPaginator

func (*ListThingTypesPaginator) HasMorePages added in v0.30.0 

func (p *ListThingTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingTypesPaginator) NextPage added in v0.30.0 

func (p *ListThingTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingTypesOutput, error)

NextPage retrieves the next ListThingTypes page.

type ListThingTypesPaginatorOptions added in v0.30.0 

type ListThingTypesPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingTypesPaginatorOptions is the paginator options for ListThingTypes

type ListThingsAPIClient added in v0.30.0 

type ListThingsAPIClient interface {
	ListThings(context.Context, *ListThingsInput, ...func(*Options)) (*ListThingsOutput, error)
}

ListThingsAPIClient is a client that implements the ListThings operation.

type ListThingsInBillingGroupAPIClient added in v0.30.0 

type ListThingsInBillingGroupAPIClient interface {
	ListThingsInBillingGroup(context.Context, *ListThingsInBillingGroupInput, ...func(*Options)) (*ListThingsInBillingGroupOutput, error)
}

ListThingsInBillingGroupAPIClient is a client that implements the ListThingsInBillingGroup operation.

type ListThingsInBillingGroupInput 

type ListThingsInBillingGroupInput struct {

	// The name of the billing group.
	//
	// This member is required.
	BillingGroupName *string

	// The maximum number of results to return per request.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListThingsInBillingGroupOutput 

type ListThingsInBillingGroupOutput struct {

	// The token to use to get the next set of results. Will not be returned if
	// operation has returned all results.
	NextToken *string

	// A list of things in the billing group.
	Things []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThingsInBillingGroupPaginator added in v0.30.0 

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

ListThingsInBillingGroupPaginator is a paginator for ListThingsInBillingGroup

func NewListThingsInBillingGroupPaginator added in v0.30.0 

func NewListThingsInBillingGroupPaginator(client ListThingsInBillingGroupAPIClient, params *ListThingsInBillingGroupInput, optFns ...func(*ListThingsInBillingGroupPaginatorOptions)) *ListThingsInBillingGroupPaginator

NewListThingsInBillingGroupPaginator returns a new ListThingsInBillingGroupPaginator

func (*ListThingsInBillingGroupPaginator) HasMorePages added in v0.30.0 

func (p *ListThingsInBillingGroupPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingsInBillingGroupPaginator) NextPage added in v0.30.0 

func (p *ListThingsInBillingGroupPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingsInBillingGroupOutput, error)

NextPage retrieves the next ListThingsInBillingGroup page.

type ListThingsInBillingGroupPaginatorOptions added in v0.30.0 

type ListThingsInBillingGroupPaginatorOptions struct {
	// The maximum number of results to return per request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingsInBillingGroupPaginatorOptions is the paginator options for ListThingsInBillingGroup

type ListThingsInThingGroupAPIClient added in v0.30.0 

type ListThingsInThingGroupAPIClient interface {
	ListThingsInThingGroup(context.Context, *ListThingsInThingGroupInput, ...func(*Options)) (*ListThingsInThingGroupOutput, error)
}

ListThingsInThingGroupAPIClient is a client that implements the ListThingsInThingGroup operation.

type ListThingsInThingGroupInput 

type ListThingsInThingGroupInput struct {

	// The thing group name.
	//
	// This member is required.
	ThingGroupName *string

	// The maximum number of results to return at one time.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// When true, list things in this thing group and in all child groups as well.
	Recursive bool
	// contains filtered or unexported fields
}

type ListThingsInThingGroupOutput 

type ListThingsInThingGroupOutput struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// The things in the specified thing group.
	Things []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThingsInThingGroupPaginator added in v0.30.0 

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

ListThingsInThingGroupPaginator is a paginator for ListThingsInThingGroup

func NewListThingsInThingGroupPaginator added in v0.30.0 

func NewListThingsInThingGroupPaginator(client ListThingsInThingGroupAPIClient, params *ListThingsInThingGroupInput, optFns ...func(*ListThingsInThingGroupPaginatorOptions)) *ListThingsInThingGroupPaginator

NewListThingsInThingGroupPaginator returns a new ListThingsInThingGroupPaginator

func (*ListThingsInThingGroupPaginator) HasMorePages added in v0.30.0 

func (p *ListThingsInThingGroupPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingsInThingGroupPaginator) NextPage added in v0.30.0 

func (p *ListThingsInThingGroupPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingsInThingGroupOutput, error)

NextPage retrieves the next ListThingsInThingGroup page.

type ListThingsInThingGroupPaginatorOptions added in v0.30.0 

type ListThingsInThingGroupPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingsInThingGroupPaginatorOptions is the paginator options for ListThingsInThingGroup

type ListThingsInput 

type ListThingsInput struct {

	// The attribute name used to search for things.
	AttributeName *string

	// The attribute value used to search for things.
	AttributeValue *string

	// The maximum number of results to return in this operation.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// The name of the thing type used to search for things.
	ThingTypeName *string

	// When true , the action returns the thing resources with attribute values that
	// start with the attributeValue provided.
	//
	// When false , or not present, the action returns only the thing resources with
	// attribute values that match the entire attributeValue provided.
	UsePrefixAttributeValue bool
	// contains filtered or unexported fields
}

The input for the ListThings operation.

type ListThingsOutput 

type ListThingsOutput struct {

	// The token to use to get the next set of results. Will not be returned if
	// operation has returned all results.
	NextToken *string

	// The things.
	Things []types.ThingAttribute

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the ListThings operation.

type ListThingsPaginator added in v0.30.0 

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

ListThingsPaginator is a paginator for ListThings

func NewListThingsPaginator added in v0.30.0 

func NewListThingsPaginator(client ListThingsAPIClient, params *ListThingsInput, optFns ...func(*ListThingsPaginatorOptions)) *ListThingsPaginator

NewListThingsPaginator returns a new ListThingsPaginator

func (*ListThingsPaginator) HasMorePages added in v0.30.0 

func (p *ListThingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListThingsPaginator) NextPage added in v0.30.0 

func (p *ListThingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThingsOutput, error)

NextPage retrieves the next ListThings page.

type ListThingsPaginatorOptions added in v0.30.0 

type ListThingsPaginatorOptions struct {
	// The maximum number of results to return in this operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListThingsPaginatorOptions is the paginator options for ListThings

type ListTopicRuleDestinationsAPIClient added in v0.30.0 

type ListTopicRuleDestinationsAPIClient interface {
	ListTopicRuleDestinations(context.Context, *ListTopicRuleDestinationsInput, ...func(*Options)) (*ListTopicRuleDestinationsOutput, error)
}

ListTopicRuleDestinationsAPIClient is a client that implements the ListTopicRuleDestinations operation.

type ListTopicRuleDestinationsInput 

type ListTopicRuleDestinationsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTopicRuleDestinationsOutput 

type ListTopicRuleDestinationsOutput struct {

	// Information about a topic rule destination.
	DestinationSummaries []types.TopicRuleDestinationSummary

	// The token to use 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
	// contains filtered or unexported fields
}

type ListTopicRuleDestinationsPaginator added in v0.30.0 

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

ListTopicRuleDestinationsPaginator is a paginator for ListTopicRuleDestinations

func NewListTopicRuleDestinationsPaginator added in v0.30.0 

func NewListTopicRuleDestinationsPaginator(client ListTopicRuleDestinationsAPIClient, params *ListTopicRuleDestinationsInput, optFns ...func(*ListTopicRuleDestinationsPaginatorOptions)) *ListTopicRuleDestinationsPaginator

NewListTopicRuleDestinationsPaginator returns a new ListTopicRuleDestinationsPaginator

func (*ListTopicRuleDestinationsPaginator) HasMorePages added in v0.30.0 

func (p *ListTopicRuleDestinationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTopicRuleDestinationsPaginator) NextPage added in v0.30.0 

func (p *ListTopicRuleDestinationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicRuleDestinationsOutput, error)

NextPage retrieves the next ListTopicRuleDestinations page.

type ListTopicRuleDestinationsPaginatorOptions added in v0.30.0 

type ListTopicRuleDestinationsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTopicRuleDestinationsPaginatorOptions is the paginator options for ListTopicRuleDestinations

type ListTopicRulesAPIClient added in v0.30.0 

type ListTopicRulesAPIClient interface {
	ListTopicRules(context.Context, *ListTopicRulesInput, ...func(*Options)) (*ListTopicRulesOutput, error)
}

ListTopicRulesAPIClient is a client that implements the ListTopicRules operation.

type ListTopicRulesInput 

type ListTopicRulesInput struct {

	// The maximum number of results to return.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// Specifies whether the rule is disabled.
	RuleDisabled *bool

	// The topic.
	Topic *string
	// contains filtered or unexported fields
}

The input for the ListTopicRules operation.

type ListTopicRulesOutput 

type ListTopicRulesOutput struct {

	// The token to use to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// The rules.
	Rules []types.TopicRuleListItem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the ListTopicRules operation.

type ListTopicRulesPaginator added in v0.30.0 

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

ListTopicRulesPaginator is a paginator for ListTopicRules

func NewListTopicRulesPaginator added in v0.30.0 

func NewListTopicRulesPaginator(client ListTopicRulesAPIClient, params *ListTopicRulesInput, optFns ...func(*ListTopicRulesPaginatorOptions)) *ListTopicRulesPaginator

NewListTopicRulesPaginator returns a new ListTopicRulesPaginator

func (*ListTopicRulesPaginator) HasMorePages added in v0.30.0 

func (p *ListTopicRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTopicRulesPaginator) NextPage added in v0.30.0 

func (p *ListTopicRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicRulesOutput, error)

NextPage retrieves the next ListTopicRules page.

type ListTopicRulesPaginatorOptions added in v0.30.0 

type ListTopicRulesPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTopicRulesPaginatorOptions is the paginator options for ListTopicRules

type ListV2LoggingLevelsAPIClient added in v0.30.0 

type ListV2LoggingLevelsAPIClient interface {
	ListV2LoggingLevels(context.Context, *ListV2LoggingLevelsInput, ...func(*Options)) (*ListV2LoggingLevelsOutput, error)
}

ListV2LoggingLevelsAPIClient is a client that implements the ListV2LoggingLevels operation.

type ListV2LoggingLevelsInput 

type ListV2LoggingLevelsInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int32

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string

	// The type of resource for which you are configuring logging. Must be THING_Group .
	TargetType types.LogTargetType
	// contains filtered or unexported fields
}

type ListV2LoggingLevelsOutput 

type ListV2LoggingLevelsOutput struct {

	// The logging configuration for a target.
	LogTargetConfigurations []types.LogTargetConfiguration

	// The token to use 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
	// contains filtered or unexported fields
}

type ListV2LoggingLevelsPaginator added in v0.30.0 

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

ListV2LoggingLevelsPaginator is a paginator for ListV2LoggingLevels

func NewListV2LoggingLevelsPaginator added in v0.30.0 

func NewListV2LoggingLevelsPaginator(client ListV2LoggingLevelsAPIClient, params *ListV2LoggingLevelsInput, optFns ...func(*ListV2LoggingLevelsPaginatorOptions)) *ListV2LoggingLevelsPaginator

NewListV2LoggingLevelsPaginator returns a new ListV2LoggingLevelsPaginator

func (*ListV2LoggingLevelsPaginator) HasMorePages added in v0.30.0 

func (p *ListV2LoggingLevelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListV2LoggingLevelsPaginator) NextPage added in v0.30.0 

func (p *ListV2LoggingLevelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListV2LoggingLevelsOutput, error)

NextPage retrieves the next ListV2LoggingLevels page.

type ListV2LoggingLevelsPaginatorOptions added in v0.30.0 

type ListV2LoggingLevelsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListV2LoggingLevelsPaginatorOptions is the paginator options for ListV2LoggingLevels

type ListViolationEventsAPIClient added in v0.30.0 

type ListViolationEventsAPIClient interface {
	ListViolationEvents(context.Context, *ListViolationEventsInput, ...func(*Options)) (*ListViolationEventsOutput, error)
}

ListViolationEventsAPIClient is a client that implements the ListViolationEvents operation.

type ListViolationEventsInput 

type ListViolationEventsInput struct {

	// The end time for the alerts to be listed.
	//
	// This member is required.
	EndTime *time.Time

	// The start time for the alerts to be listed.
	//
	// This member is required.
	StartTime *time.Time

	//  The criteria for a behavior.
	BehaviorCriteriaType types.BehaviorCriteriaType

	//  A list of all suppressed alerts.
	ListSuppressedAlerts *bool

	// The maximum number of results to return at one time.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// 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 verification state of the violation (detect alarm).
	VerificationState types.VerificationState
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListViolationEventsPaginator added in v0.30.0 

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

ListViolationEventsPaginator is a paginator for ListViolationEvents

func NewListViolationEventsPaginator added in v0.30.0 

func NewListViolationEventsPaginator(client ListViolationEventsAPIClient, params *ListViolationEventsInput, optFns ...func(*ListViolationEventsPaginatorOptions)) *ListViolationEventsPaginator

NewListViolationEventsPaginator returns a new ListViolationEventsPaginator

func (*ListViolationEventsPaginator) HasMorePages added in v0.30.0 

func (p *ListViolationEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListViolationEventsPaginator) NextPage added in v0.30.0 

func (p *ListViolationEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListViolationEventsOutput, error)

NextPage retrieves the next ListViolationEvents page.

type ListViolationEventsPaginatorOptions added in v0.30.0 

type ListViolationEventsPaginatorOptions struct {
	// The maximum number of results to return at one time.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListViolationEventsPaginatorOptions is the paginator options for ListViolationEvents

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

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

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.44.1 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutVerificationStateOnViolationInput added in v1.13.0 

type PutVerificationStateOnViolationInput struct {

	// The verification state of the violation.
	//
	// This member is required.
	VerificationState types.VerificationState

	// The violation ID.
	//
	// This member is required.
	ViolationId *string

	// The description of the verification state of the violation (detect alarm).
	VerificationStateDescription *string
	// contains filtered or unexported fields
}

type PutVerificationStateOnViolationOutput added in v1.13.0 

type PutVerificationStateOnViolationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterCACertificateInput 

type RegisterCACertificateInput struct {

	// The CA certificate.
	//
	// This member is required.
	CaCertificate *string

	// Allows this CA certificate to be used for auto registration of device
	// certificates.
	AllowAutoRegistration bool

	// Describes the certificate mode in which the Certificate Authority (CA) will be
	// registered. If the verificationCertificate field is not provided, set
	// certificateMode to be SNI_ONLY . If the verificationCertificate field is
	// provided, set certificateMode to be DEFAULT . When certificateMode is not
	// provided, it defaults to DEFAULT . All the device certificates that are
	// registered using this CA will be registered in the same certificate mode as the
	// CA. For more information about certificate mode for device certificates, see [certificate mode].
	//
	// [certificate mode]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode
	CertificateMode types.CertificateMode

	// Information about the registration configuration.
	RegistrationConfig *types.RegistrationConfig

	// A boolean value that specifies if the CA certificate is set to active.
	//
	// Valid values: ACTIVE | INACTIVE
	SetAsActive bool

	// 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

	// The private key verification certificate. If certificateMode is SNI_ONLY , the
	// verificationCertificate field must be empty. If certificateMode is DEFAULT or
	// not provided, the verificationCertificate field must not be empty.
	VerificationCertificate *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the RegisterCACertificateResponse operation.

type RegisterCertificateInput 

type RegisterCertificateInput struct {

	// The certificate data, in PEM format.
	//
	// This member is required.
	CertificatePem *string

	// The CA certificate used to sign the device certificate being registered.
	CaCertificatePem *string

	// A boolean value that specifies if the certificate is set to active.
	//
	// Valid values: ACTIVE | INACTIVE
	//
	// Deprecated: This member has been deprecated.
	SetAsActive *bool

	// The status of the register certificate request. Valid values that you can use
	// include ACTIVE , INACTIVE , and REVOKED .
	Status types.CertificateStatus
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the RegisterCertificate operation.

type RegisterCertificateWithoutCAInput 

type RegisterCertificateWithoutCAInput struct {

	// The certificate data, in PEM format.
	//
	// This member is required.
	CertificatePem *string

	// The status of the register certificate request.
	Status types.CertificateStatus
	// contains filtered or unexported fields
}

type RegisterCertificateWithoutCAOutput 

type RegisterCertificateWithoutCAOutput struct {

	// The Amazon Resource Name (ARN) of the registered certificate.
	CertificateArn *string

	// The ID of the registered certificate. (The last part of the certificate ARN
	// contains the certificate ID.
	CertificateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterThingInput 

type RegisterThingInput struct {

	// The provisioning template. See [Provisioning Devices That Have Device Certificates] for more information.
	//
	// [Provisioning Devices That Have Device Certificates]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html
	//
	// This member is required.
	TemplateBody *string

	// The parameters for provisioning a thing. See [Provisioning Templates] for more information.
	//
	// [Provisioning Templates]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html
	Parameters map[string]string
	// contains filtered or unexported fields
}

type RegisterThingOutput 

type RegisterThingOutput struct {

	// The certificate data, in PEM format.
	CertificatePem *string

	// ARNs for the generated resources.
	ResourceArns map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RejectCertificateTransferInput 

type RejectCertificateTransferInput struct {

	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	//
	// This member is required.
	CertificateId *string

	// The reason the certificate transfer was rejected.
	RejectReason *string
	// contains filtered or unexported fields
}

The input for the RejectCertificateTransfer operation.

type RejectCertificateTransferOutput 

type RejectCertificateTransferOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveThingFromBillingGroupInput 

type RemoveThingFromBillingGroupInput struct {

	// The ARN of the billing group.
	BillingGroupArn *string

	// The name of the billing group.
	BillingGroupName *string

	// 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
	// contains filtered or unexported fields
}

type RemoveThingFromBillingGroupOutput 

type RemoveThingFromBillingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveThingFromThingGroupInput 

type RemoveThingFromThingGroupInput struct {

	// The ARN of the thing to remove from the group.
	ThingArn *string

	// The group ARN.
	ThingGroupArn *string

	// The group name.
	ThingGroupName *string

	// The name of the thing to remove from the group.
	ThingName *string
	// contains filtered or unexported fields
}

type RemoveThingFromThingGroupOutput 

type RemoveThingFromThingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ReplaceTopicRuleInput 

type ReplaceTopicRuleInput struct {

	// The name of the rule.
	//
	// This member is required.
	RuleName *string

	// The rule payload.
	//
	// This member is required.
	TopicRulePayload *types.TopicRulePayload
	// contains filtered or unexported fields
}

The input for the ReplaceTopicRule operation.

type ReplaceTopicRuleOutput 

type ReplaceTopicRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchIndexInput 

type SearchIndexInput struct {

	// The search query string. For more information about the search query syntax,
	// see [Query syntax].
	//
	// [Query syntax]: https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html
	//
	// This member is required.
	QueryString *string

	// The search index name.
	IndexName *string

	// The maximum number of results to return per page at one time. This maximum
	// number cannot exceed 100. The response might contain fewer results but will
	// never contain more. You can use [nextToken]nextToken to retrieve the next set of results
	// until nextToken returns NULL .
	//
	// [nextToken]: https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken
	MaxResults *int32

	// The token used to get the next set of results, or null if there are no
	// additional results.
	NextToken *string

	// The query version.
	QueryVersion *string
	// contains filtered or unexported fields
}

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 thing groups that match the search query.
	ThingGroups []types.ThingGroupDocument

	// The things that match the search query.
	Things []types.ThingDocument

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetDefaultAuthorizerInput 

type SetDefaultAuthorizerInput struct {

	// The authorizer name.
	//
	// This member is required.
	AuthorizerName *string
	// contains filtered or unexported fields
}

type SetDefaultAuthorizerOutput 

type SetDefaultAuthorizerOutput struct {

	// The authorizer ARN.
	AuthorizerArn *string

	// The authorizer name.
	AuthorizerName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetDefaultPolicyVersionInput 

type SetDefaultPolicyVersionInput struct {

	// The policy name.
	//
	// This member is required.
	PolicyName *string

	// The policy version ID.
	//
	// This member is required.
	PolicyVersionId *string
	// contains filtered or unexported fields
}

The input for the SetDefaultPolicyVersion operation.

type SetDefaultPolicyVersionOutput 

type SetDefaultPolicyVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetLoggingOptionsInput 

type SetLoggingOptionsInput struct {

	// The logging options payload.
	//
	// This member is required.
	LoggingOptionsPayload *types.LoggingOptionsPayload
	// contains filtered or unexported fields
}

The input for the SetLoggingOptions operation.

type SetLoggingOptionsOutput 

type SetLoggingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetV2LoggingLevelInput 

type SetV2LoggingLevelInput struct {

	// The log level.
	//
	// This member is required.
	LogLevel types.LogLevel

	// The log target.
	//
	// This member is required.
	LogTarget *types.LogTarget
	// contains filtered or unexported fields
}

type SetV2LoggingLevelOutput 

type SetV2LoggingLevelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SetV2LoggingOptionsInput 

type SetV2LoggingOptionsInput struct {

	// The default logging level.
	DefaultLogLevel types.LogLevel

	// If true all logs are disabled. The default is false.
	DisableAllLogs bool

	// The ARN of the role that allows IoT to write to Cloudwatch logs.
	RoleArn *string
	// contains filtered or unexported fields
}

type SetV2LoggingOptionsOutput 

type SetV2LoggingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartAuditMitigationActionsTaskInput 

type StartAuditMitigationActionsTaskInput struct {

	// For an audit check, specifies which mitigation actions to apply. Those actions
	// must be defined in your Amazon Web Services accounts.
	//
	// This member is required.
	AuditCheckToActionsMapping map[string][]string

	// 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.
	//
	// This member is required.
	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
	// specific set of findings.
	//
	// This member is required.
	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.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type StartDetectMitigationActionsTaskInput added in v1.2.0 

type StartDetectMitigationActionsTaskInput struct {

	//  The actions to be performed when a device has unexpected behavior.
	//
	// This member is required.
	Actions []string

	//  Each mitigation action task must have a unique client request token. If you
	// try to create a new task with the same token as a task that already exists, an
	// exception occurs. If you omit this value, Amazon Web Services SDKs will
	// automatically generate a unique client request.
	//
	// This member is required.
	ClientRequestToken *string

	//  Specifies the ML Detect findings to which the mitigation actions are applied.
	//
	// This member is required.
	Target *types.DetectMitigationActionsTaskTarget

	//  The unique identifier of the task.
	//
	// This member is required.
	TaskId *string

	//  Specifies to list only active violations.
	IncludeOnlyActiveViolations *bool

	//  Specifies to include suppressed alerts.
	IncludeSuppressedAlerts *bool

	//  Specifies the time period of which violation events occurred between.
	ViolationEventOccurrenceRange *types.ViolationEventOccurrenceRange
	// contains filtered or unexported fields
}

type StartDetectMitigationActionsTaskOutput added in v1.2.0 

type StartDetectMitigationActionsTaskOutput struct {

	//  The unique identifier of the task.
	TaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	TargetCheckNames []string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type StartThingRegistrationTaskInput 

type StartThingRegistrationTaskInput struct {

	// The S3 bucket that contains the input file.
	//
	// This member is required.
	InputFileBucket *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).
	//
	// This member is required.
	InputFileKey *string

	// The IAM role ARN that grants permission the input file.
	//
	// This member is required.
	RoleArn *string

	// The provisioning template.
	//
	// This member is required.
	TemplateBody *string
	// contains filtered or unexported fields
}

type StartThingRegistrationTaskOutput 

type StartThingRegistrationTaskOutput struct {

	// The bulk thing provisioning task ID.
	TaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopThingRegistrationTaskInput 

type StopThingRegistrationTaskInput struct {

	// The bulk thing provisioning task ID.
	//
	// This member is required.
	TaskId *string
	// contains filtered or unexported fields
}

type StopThingRegistrationTaskOutput 

type StopThingRegistrationTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The new or modified tags for the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TestAuthorizationInput 

type TestAuthorizationInput struct {

	// A list of authorization info objects. Simulating authorization will create a
	// response for each authInfo object in the list.
	//
	// This member is required.
	AuthInfos []types.AuthInfo

	// The MQTT client ID.
	ClientId *string

	// The Cognito identity pool ID.
	CognitoIdentityPoolId *string

	// 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. Valid principals are CertificateArn
	// (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
	// (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
	Principal *string
	// contains filtered or unexported fields
}

type TestAuthorizationOutput 

type TestAuthorizationOutput struct {

	// The authentication results.
	AuthResults []types.AuthResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TestInvokeAuthorizerInput 

type TestInvokeAuthorizerInput struct {

	// The custom authorizer name.
	//
	// This member is required.
	AuthorizerName *string

	// Specifies a test HTTP authorization request.
	HttpContext *types.HttpContext

	// Specifies a test MQTT authorization request.
	MqttContext *types.MqttContext

	// Specifies a test TLS authorization request.
	TlsContext *types.TlsContext

	// 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
	// contains filtered or unexported fields
}

type TestInvokeAuthorizerOutput 

type TestInvokeAuthorizerOutput struct {

	// The number of seconds after which the connection is terminated.
	DisconnectAfterInSeconds *int32

	// True if the token is authenticated, otherwise false.
	IsAuthenticated *bool

	// IAM policy documents.
	PolicyDocuments []string

	// The principal ID.
	PrincipalId *string

	// The number of seconds after which the temporary credentials are refreshed.
	RefreshAfterInSeconds *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TransferCertificateInput 

type TransferCertificateInput struct {

	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	//
	// This member is required.
	CertificateId *string

	// The Amazon Web Services account.
	//
	// This member is required.
	TargetAwsAccount *string

	// The transfer message.
	TransferMessage *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

The output from the TransferCertificate operation.

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceArn *string

	// A list of the keys of the tags to be removed from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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's 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 Amazon Resource Name (ARN) of the role that grants permission to IoT to
	// access information about your devices, policies, certificates, and other items
	// as required when performing an audit.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateAccountAuditConfigurationOutput 

type UpdateAccountAuditConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAuditSuppressionInput added in v0.29.0 

type UpdateAuditSuppressionInput struct {

	// An audit check name. 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.)
	//
	// This member is required.
	CheckName *string

	// Information that identifies the noncompliant resource.
	//
	// This member is required.
	ResourceIdentifier *types.ResourceIdentifier

	//  The description of the audit suppression.
	Description *string

	//  The expiration date (epoch timestamp in seconds) that you want the suppression
	// to adhere to.
	ExpirationDate *time.Time

	//  Indicates whether a suppression should exist indefinitely or not.
	SuppressIndefinitely *bool
	// contains filtered or unexported fields
}

type UpdateAuditSuppressionOutput added in v0.29.0 

type UpdateAuditSuppressionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAuthorizerInput 

type UpdateAuthorizerInput struct {

	// The authorizer name.
	//
	// This member is required.
	AuthorizerName *string

	// The ARN of the authorizer's Lambda function.
	AuthorizerFunctionArn *string

	// When true , the result from the authorizer’s Lambda function is cached for the
	// time specified in refreshAfterInSeconds . The cached result is used while the
	// device reuses the same HTTP connection.
	EnableCachingForHttp *bool

	// The status of the update authorizer request.
	Status types.AuthorizerStatus

	// 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
	// contains filtered or unexported fields
}

type UpdateAuthorizerOutput 

type UpdateAuthorizerOutput struct {

	// The authorizer ARN.
	AuthorizerArn *string

	// The authorizer name.
	AuthorizerName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateBillingGroupInput 

type UpdateBillingGroupInput struct {

	// The name of the billing group.
	//
	// This member is required.
	BillingGroupName *string

	// The properties of the billing group.
	//
	// This member is required.
	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
	// contains filtered or unexported fields
}

type UpdateBillingGroupOutput 

type UpdateBillingGroupOutput struct {

	// The latest version of the billing group.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCACertificateInput 

type UpdateCACertificateInput struct {

	// The CA certificate identifier.
	//
	// This member is required.
	CertificateId *string

	// The new value for the auto registration status. Valid values are: "ENABLE" or
	// "DISABLE".
	NewAutoRegistrationStatus types.AutoRegistrationStatus

	// The updated status of the CA certificate.
	//
	// Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
	NewStatus types.CACertificateStatus

	// Information about the registration configuration.
	RegistrationConfig *types.RegistrationConfig

	// If true, removes auto registration.
	RemoveAutoRegistration bool
	// contains filtered or unexported fields
}

The input to the UpdateCACertificate operation.

type UpdateCACertificateOutput 

type UpdateCACertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCertificateInput 

type UpdateCertificateInput struct {

	// The ID of the certificate. (The last part of the certificate ARN contains the
	// certificate ID.)
	//
	// This member is required.
	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 IoT. They are not intended for developer use.
	//
	// Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
	//
	// This member is required.
	NewStatus types.CertificateStatus
	// contains filtered or unexported fields
}

The input for the UpdateCertificate operation.

type UpdateCertificateOutput 

type UpdateCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCertificateProviderInput added in v1.47.0 

type UpdateCertificateProviderInput struct {

	// The name of the certificate provider.
	//
	// This member is required.
	CertificateProviderName *string

	// A list of the operations that the certificate provider will use to generate
	// certificates. Valid value: CreateCertificateFromCsr .
	AccountDefaultForOperations []types.CertificateProviderOperation

	// The Lambda function ARN that's associated with the certificate provider.
	LambdaFunctionArn *string
	// contains filtered or unexported fields
}

type UpdateCertificateProviderOutput added in v1.47.0 

type UpdateCertificateProviderOutput struct {

	// The ARN of the certificate provider.
	CertificateProviderArn *string

	// The name of the certificate provider.
	CertificateProviderName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCommandInput added in v1.61.0 

type UpdateCommandInput struct {

	// The unique identifier of the command to be updated.
	//
	// This member is required.
	CommandId *string

	// A boolean that you can use to specify whether to deprecate a command.
	Deprecated *bool

	// A short text description of the command.
	Description *string

	// The new user-friendly name to use in the console for the command.
	DisplayName *string
	// contains filtered or unexported fields
}

type UpdateCommandOutput added in v1.61.0 

type UpdateCommandOutput struct {

	// The unique identifier of the command.
	CommandId *string

	// The boolean that indicates whether the command was deprecated.
	Deprecated *bool

	// The updated text description of the command.
	Description *string

	// The updated user-friendly display name in the console for the command.
	DisplayName *string

	// The date and time (epoch timestamp in seconds) when the command was last
	// updated.
	LastUpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCustomMetricInput added in v1.2.0 

type UpdateCustomMetricInput struct {

	//  Field represents a friendly name in the console for the custom metric, it
	// doesn't have to be unique. Don't use this name as the metric identifier in the
	// device metric report. Can be updated.
	//
	// This member is required.
	DisplayName *string

	//  The name of the custom metric. Cannot be updated.
	//
	// This member is required.
	MetricName *string
	// contains filtered or unexported fields
}

type UpdateCustomMetricOutput added in v1.2.0 

type UpdateCustomMetricOutput struct {

	//  The creation date of the custom metric in milliseconds since epoch.
	CreationDate *time.Time

	//  A friendly name in the console for the custom metric
	DisplayName *string

	//  The time the custom metric was last modified in milliseconds since epoch.
	LastModifiedDate *time.Time

	//  The Amazon Resource Number (ARN) of the custom metric.
	MetricArn *string

	//  The name of the custom metric.
	MetricName *string

	//  The type of the custom metric.
	//
	// The type number only takes a single metric value as an input, but while
	// submitting the metrics value in the DeviceMetrics report, it must be passed as
	// an array with a single value.
	MetricType types.CustomMetricType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	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/#").
	//
	// This member is required.
	StringValues []string
	// contains filtered or unexported fields
}

type UpdateDimensionOutput 

type UpdateDimensionOutput struct {

	// The Amazon Resource Name (ARN)of the created dimension.
	Arn *string

	// The date and time, in milliseconds since epoch, when the dimension was
	// initially created.
	CreationDate *time.Time

	// The date and time, in milliseconds since epoch, when the dimension was most
	// recently updated.
	LastModifiedDate *time.Time

	// A unique identifier for the dimension.
	Name *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

	// The type of the dimension.
	Type types.DimensionType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDomainConfigurationInput 

type UpdateDomainConfigurationInput struct {

	// The name of the domain configuration to be updated.
	//
	// This member is required.
	DomainConfigurationName *string

	// An enumerated string that specifies the application-layer protocol.
	//
	//   - SECURE_MQTT - MQTT over TLS.
	//
	//   - MQTT_WSS - MQTT over WebSocket.
	//
	//   - HTTPS - HTTP over TLS.
	//
	//   - DEFAULT - Use a combination of port and Application Layer Protocol
	//   Negotiation (ALPN) to specify application_layer protocol. For more information,
	//   see [Device communication protocols].
	//
	// [Device communication protocols]: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html
	ApplicationProtocol types.ApplicationProtocol

	// An enumerated string that specifies the authentication type.
	//
	//   - CUSTOM_AUTH_X509 - Use custom authentication and authorization with
	//   additional details from the X.509 client certificate.
	//
	//   - CUSTOM_AUTH - Use custom authentication and authorization. For more
	//   information, see [Custom authentication and authorization].
	//
	//   - AWS_X509 - Use X.509 client certificates without custom authentication and
	//   authorization. For more information, see [X.509 client certificates].
	//
	//   - AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more
	//   information, see [IAM users, groups, and roles].
	//
	//   - DEFAULT - Use a combination of port and Application Layer Protocol
	//   Negotiation (ALPN) to specify authentication type. For more information, see [Device communication protocols].
	//
	// [Custom authentication and authorization]: https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
	// [X.509 client certificates]: https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html
	// [IAM users, groups, and roles]: https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html
	// [Device communication protocols]: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html
	AuthenticationType types.AuthenticationType

	// An object that specifies the authorization service for a domain.
	AuthorizerConfig *types.AuthorizerConfig

	// An object that specifies the client certificate configuration for a domain.
	ClientCertificateConfig *types.ClientCertificateConfig

	// The status to which the domain configuration should be updated.
	DomainConfigurationStatus types.DomainConfigurationStatus

	// Removes the authorization configuration from a domain.
	RemoveAuthorizerConfig bool

	// The server certificate configuration.
	ServerCertificateConfig *types.ServerCertificateConfig

	// An object that specifies the TLS configuration for a domain.
	TlsConfig *types.TlsConfig
	// contains filtered or unexported fields
}

type UpdateDomainConfigurationOutput 

type UpdateDomainConfigurationOutput struct {

	// The ARN of the domain configuration that was updated.
	DomainConfigurationArn *string

	// The name of the domain configuration that was updated.
	DomainConfigurationName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDynamicThingGroupInput 

type UpdateDynamicThingGroupInput struct {

	// The name of the dynamic thing group to update.
	//
	// This member is required.
	ThingGroupName *string

	// The dynamic thing group properties to update.
	//
	// This member is required.
	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
	// contains filtered or unexported fields
}

type UpdateDynamicThingGroupOutput 

type UpdateDynamicThingGroupOutput struct {

	// The dynamic thing group version.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEventConfigurationsInput 

type UpdateEventConfigurationsInput struct {

	// The new event configuration values.
	EventConfigurations map[string]types.Configuration
	// contains filtered or unexported fields
}

type UpdateEventConfigurationsOutput 

type UpdateEventConfigurationsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFleetMetricInput added in v1.11.0 

type UpdateFleetMetricInput struct {

	// The name of the index to search.
	//
	// This member is required.
	IndexName *string

	// The name of the fleet metric to update.
	//
	// This member is required.
	MetricName *string

	// The field to aggregate.
	AggregationField *string

	// The type of the aggregation query.
	AggregationType *types.AggregationType

	// The description of the fleet metric.
	Description *string

	// The expected version of the fleet metric record in the registry.
	ExpectedVersion *int64

	// The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1
	// day)] and must be multiple of 60.
	Period *int32

	// The search query string.
	QueryString *string

	// The version of the query.
	QueryVersion *string

	// Used to support unit transformation such as milliseconds to seconds. The unit
	// must be supported by [CW metric].
	//
	// [CW metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
	Unit types.FleetMetricUnit
	// contains filtered or unexported fields
}

type UpdateFleetMetricOutput added in v1.11.0 

type UpdateFleetMetricOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateIndexingConfigurationInput 

type UpdateIndexingConfigurationInput struct {

	// Thing group indexing configuration.
	ThingGroupIndexingConfiguration *types.ThingGroupIndexingConfiguration

	// Thing indexing configuration.
	ThingIndexingConfiguration *types.ThingIndexingConfiguration
	// contains filtered or unexported fields
}

type UpdateIndexingConfigurationOutput 

type UpdateIndexingConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateJobInput 

type UpdateJobInput struct {

	// The ID of the job to be updated.
	//
	// This member is required.
	JobId *string

	// Allows you to create criteria to abort a job.
	AbortConfig *types.AbortConfig

	// A short text description of the job.
	Description *string

	// Allows you to create the criteria to retry a job.
	JobExecutionsRetryConfig *types.JobExecutionsRetryConfig

	// Allows you to create a staged rollout of the job.
	JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig

	// The namespace used to indicate that a job is a customer-managed job.
	//
	// When you specify a value for this parameter, Amazon Web Services IoT Core sends
	// jobs notifications to MQTT topics that contain the value in the following
	// format.
	//
	//     $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
	//
	// The namespaceId feature is only supported by IoT Greengrass at this time. For
	// more information, see [Setting up IoT Greengrass core devices.]
	//
	// [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html
	NamespaceId *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
	// contains filtered or unexported fields
}

type UpdateJobOutput 

type UpdateJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMitigationActionInput 

type UpdateMitigationActionInput struct {

	// The friendly name for the mitigation action. You cannot change the name by
	// using UpdateMitigationAction . Instead, you must delete and recreate the
	// mitigation action with the new name.
	//
	// This member is required.
	ActionName *string

	// Defines the type of action and the parameters for that action.
	ActionParams *types.MitigationActionParams

	// The ARN of the IAM role that is used to apply the mitigation action.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateMitigationActionOutput 

type UpdateMitigationActionOutput struct {

	// The ARN for the new mitigation action.
	ActionArn *string

	// A unique identifier for the mitigation action.
	ActionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePackageConfigurationInput added in v1.38.0 

type UpdatePackageConfigurationInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string

	// Configuration to manage job's package version reporting. This updates the
	// thing's reserved named shadow that the job targets.
	VersionUpdateByJobsConfig *types.VersionUpdateByJobsConfig
	// contains filtered or unexported fields
}

type UpdatePackageConfigurationOutput added in v1.38.0 

type UpdatePackageConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePackageInput added in v1.38.0 

type UpdatePackageInput struct {

	// The name of the target software package.
	//
	// This member is required.
	PackageName *string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string

	// The name of the default package version.
	//
	// Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true
	// at the same time.
	DefaultVersionName *string

	// The package description.
	Description *string

	// Indicates whether you want to remove the named default package version from the
	// software package. Set as true to remove the default package version.
	//
	// Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true
	// at the same time.
	UnsetDefaultVersion *bool
	// contains filtered or unexported fields
}

type UpdatePackageOutput added in v1.38.0 

type UpdatePackageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePackageVersionInput added in v1.38.0 

type UpdatePackageVersionInput struct {

	// The name of the associated software package.
	//
	// This member is required.
	PackageName *string

	// The name of the target package version.
	//
	// This member is required.
	VersionName *string

	// The status that the package version should be assigned. For more information,
	// see [Package version lifecycle].
	//
	// [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
	Action types.PackageVersionAction

	// The various components that make up a software package version.
	Artifact *types.PackageVersionArtifact

	// Metadata that can be used to define a package version’s configuration. For
	// example, the Amazon S3 file location, configuration options that are being sent
	// to the device or fleet.
	//
	// Note: Attributes can be updated only when the package version is in a draft
	// state.
	//
	// The combined size of all the attributes on a package version is limited to 3KB.
	Attributes map[string]string

	// A unique case-sensitive identifier that you can provide to ensure the
	// idempotency of the request. Don't reuse this client token if a new idempotent
	// request is required.
	ClientToken *string

	// The package version description.
	Description *string

	// The inline job document associated with a software package version used for a
	// quick job deployment.
	Recipe *string
	// contains filtered or unexported fields
}

type UpdatePackageVersionOutput added in v1.38.0 

type UpdatePackageVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateProvisioningTemplateInput 

type UpdateProvisioningTemplateInput struct {

	// The name of the provisioning template.
	//
	// This member is required.
	TemplateName *string

	// The ID of the default provisioning template version.
	DefaultVersionId *int32

	// The description of the provisioning template.
	Description *string

	// True to enable the provisioning template, otherwise false.
	Enabled *bool

	// Updates the pre-provisioning hook template. Only supports template of type
	// FLEET_PROVISIONING . For more information about provisioning template types, see [type]
	// .
	//
	// [type]: https://docs.aws.amazon.com/iot/latest/apireference/API_CreateProvisioningTemplate.html#iot-CreateProvisioningTemplate-request-type
	PreProvisioningHook *types.ProvisioningHook

	// The ARN of the role associated with the provisioning template. This IoT role
	// grants permission to provision a device.
	ProvisioningRoleArn *string

	// Removes pre-provisioning hook template.
	RemovePreProvisioningHook *bool
	// contains filtered or unexported fields
}

type UpdateProvisioningTemplateOutput 

type UpdateProvisioningTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRoleAliasInput 

type UpdateRoleAliasInput struct {

	// The role alias to update.
	//
	// This member is required.
	RoleAlias *string

	// The number of seconds the credential will be valid.
	//
	// This value must be less than or equal to the maximum session duration of the
	// IAM role that the role alias references.
	CredentialDurationSeconds *int32

	// The role ARN.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateRoleAliasOutput 

type UpdateRoleAliasOutput struct {

	// The role alias.
	RoleAlias *string

	// The role alias ARN.
	RoleAliasArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateScheduledAuditInput 

type UpdateScheduledAuditInput struct {

	// The name of the scheduled audit. (Max. 128 chars)
	//
	// This member is required.
	ScheduledAuditName *string

	// The day of the month on which the scheduled audit takes place. This 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 day of the week on which the scheduled audit takes place. This 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

	// How often the scheduled audit takes place, either DAILY , WEEKLY , BIWEEKLY , or
	// MONTHLY . The start time of each audit is determined by the system.
	Frequency types.AuditFrequency

	// 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
	// contains filtered or unexported fields
}

type UpdateScheduledAuditOutput 

type UpdateScheduledAuditOutput struct {

	// The ARN of the scheduled audit.
	ScheduledAuditArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSecurityProfileInput 

type UpdateSecurityProfileInput struct {

	// The name of the security profile you want to update.
	//
	// This member is required.
	SecurityProfileName *string

	//  Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
	//
	// 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. Can be used with custom metrics; cannot be used with
	// dimensions.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []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. Can be used with custom metrics; cannot be used with
	// dimensions.
	AdditionalMetricsToRetainV2 []types.MetricToRetain

	// 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

	// If true, delete all additionalMetricsToRetain defined for this security
	// profile. If any additionalMetricsToRetain are defined in the current
	// invocation, an exception occurs.
	DeleteAdditionalMetricsToRetain bool

	// If true, delete all alertTargets defined for this security profile. If any
	// alertTargets are defined in the current invocation, an exception occurs.
	DeleteAlertTargets bool

	// If true, delete all behaviors defined for this security profile. If any
	// behaviors are defined in the current invocation, an exception occurs.
	DeleteBehaviors bool

	// Set the value as true to delete metrics export related configurations.
	DeleteMetricsExportConfig bool

	// 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

	// Specifies the MQTT topic and role ARN required for metric export.
	MetricsExportConfig *types.MetricsExportConfig

	// A description of the security profile.
	SecurityProfileDescription *string
	// contains filtered or unexported fields
}

type UpdateSecurityProfileOutput 

type UpdateSecurityProfileOutput struct {

	//  Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.
	//
	// 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.
	//
	// Deprecated: Use additionalMetricsToRetainV2.
	AdditionalMetricsToRetain []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. Can be used with custom metrics; cannot be used with
	// dimensions.
	AdditionalMetricsToRetainV2 []types.MetricToRetain

	// 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

	// The time the security profile was created.
	CreationDate *time.Time

	// The time the security profile was last modified.
	LastModifiedDate *time.Time

	// Specifies the MQTT topic and role ARN required for metric export.
	MetricsExportConfig *types.MetricsExportConfig

	// The ARN of the security profile that was updated.
	SecurityProfileArn *string

	// The description of the security profile.
	SecurityProfileDescription *string

	// The name of the security profile that was updated.
	SecurityProfileName *string

	// The updated version of the security profile.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateStreamInput 

type UpdateStreamInput struct {

	// The stream ID.
	//
	// This member is required.
	StreamId *string

	// The description of the stream.
	Description *string

	// The files associated with the stream.
	Files []types.StreamFile

	// An IAM role that allows the IoT service principal assumes to access your S3
	// files.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateStreamOutput 

type UpdateStreamOutput struct {

	// A description of the stream.
	Description *string

	// The stream ARN.
	StreamArn *string

	// The stream ID.
	StreamId *string

	// The stream version.
	StreamVersion *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateThingGroupInput 

type UpdateThingGroupInput struct {

	// The thing group to update.
	//
	// This member is required.
	ThingGroupName *string

	// The thing group properties.
	//
	// This member is required.
	ThingGroupProperties *types.ThingGroupProperties

	// 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
	// contains filtered or unexported fields
}

type UpdateThingGroupOutput 

type UpdateThingGroupOutput struct {

	// The version of the updated thing group.
	Version int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 to which the thing will be added.
	ThingGroupsToAdd []string

	// The groups from which the thing will be removed.
	ThingGroupsToRemove []string

	// The thing whose group memberships will be updated.
	ThingName *string
	// contains filtered or unexported fields
}

type UpdateThingGroupsForThingOutput 

type UpdateThingGroupsForThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateThingInput 

type UpdateThingInput struct {

	// 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.
	//
	// This member is required.
	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

	// 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

	// Remove a thing type association. If true, the association is removed.
	RemoveThingType bool

	// The name of the thing type.
	ThingTypeName *string
	// contains filtered or unexported fields
}

The input for the UpdateThing operation.

type UpdateThingOutput 

type UpdateThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The output from the UpdateThing operation.

type UpdateThingTypeInput added in v1.60.0 

type UpdateThingTypeInput struct {

	// The name of a thing type.
	//
	// This member is required.
	ThingTypeName *string

	// The ThingTypeProperties contains information about the thing type including: a
	// thing type description, and a list of searchable thing attribute names.
	ThingTypeProperties *types.ThingTypeProperties
	// contains filtered or unexported fields
}

type UpdateThingTypeOutput added in v1.60.0 

type UpdateThingTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTopicRuleDestinationInput 

type UpdateTopicRuleDestinationInput struct {

	// The ARN of the topic rule destination.
	//
	// This member is required.
	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.
	//
	// This member is required.
	Status types.TopicRuleDestinationStatus
	// contains filtered or unexported fields
}

type UpdateTopicRuleDestinationOutput 

type UpdateTopicRuleDestinationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ValidateSecurityProfileBehaviorsInput 

type ValidateSecurityProfileBehaviorsInput struct {

	// Specifies the behaviors that, when violated by a device (thing), cause an alert.
	//
	// This member is required.
	Behaviors []types.Behavior
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.