greengrass

package module
v1.23.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 38 Imported by: 17

Documentation

Overview

Package greengrass provides the API client, operations, and parameter types for AWS Greengrass.

AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.

Index

Constants

View Source
const ServiceAPIVersion = "2017-06-07"
View Source
const ServiceID = "Greengrass"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.20.2

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

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 AssociateRoleToGroupInput

type AssociateRoleToGroupInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// The ARN of the role you wish to associate with this group. The existence of the
	// role is not validated.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

type AssociateRoleToGroupOutput

type AssociateRoleToGroupOutput struct {

	// The time, in milliseconds since the epoch, when the role ARN was associated
	// with the group.
	AssociatedAt *string

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

type AssociateServiceRoleToAccountInput

type AssociateServiceRoleToAccountInput struct {

	// The ARN of the service role you wish to associate with your account.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

type AssociateServiceRoleToAccountOutput

type AssociateServiceRoleToAccountOutput struct {

	// The time when the service role was associated with the account.
	AssociatedAt *string

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

type AuthResolverParameters added in v1.20.2

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

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

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

type Client

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

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

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

func (c *Client) AssociateRoleToGroup(ctx context.Context, params *AssociateRoleToGroupInput, optFns ...func(*Options)) (*AssociateRoleToGroupOutput, error)

Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.

func (*Client) AssociateServiceRoleToAccount

func (c *Client) AssociateServiceRoleToAccount(ctx context.Context, params *AssociateServiceRoleToAccountInput, optFns ...func(*Options)) (*AssociateServiceRoleToAccountOutput, error)

Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ”AWSGreengrassResourceAccessRolePolicy”.

func (*Client) CreateConnectorDefinition

func (c *Client) CreateConnectorDefinition(ctx context.Context, params *CreateConnectorDefinitionInput, optFns ...func(*Options)) (*CreateConnectorDefinitionOutput, error)

Creates a connector definition. You may provide the initial version of the connector definition now or use ”CreateConnectorDefinitionVersion” at a later time.

func (*Client) CreateConnectorDefinitionVersion

func (c *Client) CreateConnectorDefinitionVersion(ctx context.Context, params *CreateConnectorDefinitionVersionInput, optFns ...func(*Options)) (*CreateConnectorDefinitionVersionOutput, error)

Creates a version of a connector definition which has already been defined.

func (*Client) CreateCoreDefinition

func (c *Client) CreateCoreDefinition(ctx context.Context, params *CreateCoreDefinitionInput, optFns ...func(*Options)) (*CreateCoreDefinitionOutput, error)

Creates a core definition. You may provide the initial version of the core definition now or use ”CreateCoreDefinitionVersion” at a later time. Greengrass groups must each contain exactly one Greengrass core.

func (*Client) CreateCoreDefinitionVersion

func (c *Client) CreateCoreDefinitionVersion(ctx context.Context, params *CreateCoreDefinitionVersionInput, optFns ...func(*Options)) (*CreateCoreDefinitionVersionOutput, error)

Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.

func (*Client) CreateDeployment

func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error)

Creates a deployment. ”CreateDeployment” requests are idempotent with respect to the ”X-Amzn-Client-Token” token and the request parameters.

func (*Client) CreateDeviceDefinition

func (c *Client) CreateDeviceDefinition(ctx context.Context, params *CreateDeviceDefinitionInput, optFns ...func(*Options)) (*CreateDeviceDefinitionOutput, error)

Creates a device definition. You may provide the initial version of the device definition now or use ”CreateDeviceDefinitionVersion” at a later time.

func (*Client) CreateDeviceDefinitionVersion

func (c *Client) CreateDeviceDefinitionVersion(ctx context.Context, params *CreateDeviceDefinitionVersionInput, optFns ...func(*Options)) (*CreateDeviceDefinitionVersionOutput, error)

Creates a version of a device definition that has already been defined.

func (*Client) CreateFunctionDefinition

func (c *Client) CreateFunctionDefinition(ctx context.Context, params *CreateFunctionDefinitionInput, optFns ...func(*Options)) (*CreateFunctionDefinitionOutput, error)

Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ”CreateFunctionDefinitionVersion” later.

func (*Client) CreateFunctionDefinitionVersion

func (c *Client) CreateFunctionDefinitionVersion(ctx context.Context, params *CreateFunctionDefinitionVersionInput, optFns ...func(*Options)) (*CreateFunctionDefinitionVersionOutput, error)

Creates a version of a Lambda function definition that has already been defined.

func (*Client) CreateGroup

func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)

Creates a group. You may provide the initial version of the group or use ”CreateGroupVersion” at a later time. Tip: You can use the ”gg_group_setup” package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.

func (*Client) CreateGroupCertificateAuthority

func (c *Client) CreateGroupCertificateAuthority(ctx context.Context, params *CreateGroupCertificateAuthorityInput, optFns ...func(*Options)) (*CreateGroupCertificateAuthorityOutput, error)

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

func (*Client) CreateGroupVersion

func (c *Client) CreateGroupVersion(ctx context.Context, params *CreateGroupVersionInput, optFns ...func(*Options)) (*CreateGroupVersionOutput, error)

Creates a version of a group which has already been defined.

func (*Client) CreateLoggerDefinition

func (c *Client) CreateLoggerDefinition(ctx context.Context, params *CreateLoggerDefinitionInput, optFns ...func(*Options)) (*CreateLoggerDefinitionOutput, error)

Creates a logger definition. You may provide the initial version of the logger definition now or use ”CreateLoggerDefinitionVersion” at a later time.

func (*Client) CreateLoggerDefinitionVersion

func (c *Client) CreateLoggerDefinitionVersion(ctx context.Context, params *CreateLoggerDefinitionVersionInput, optFns ...func(*Options)) (*CreateLoggerDefinitionVersionOutput, error)

Creates a version of a logger definition that has already been defined.

func (*Client) CreateResourceDefinition

func (c *Client) CreateResourceDefinition(ctx context.Context, params *CreateResourceDefinitionInput, optFns ...func(*Options)) (*CreateResourceDefinitionOutput, error)

Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ”CreateResourceDefinitionVersion” later.

func (*Client) CreateResourceDefinitionVersion

func (c *Client) CreateResourceDefinitionVersion(ctx context.Context, params *CreateResourceDefinitionVersionInput, optFns ...func(*Options)) (*CreateResourceDefinitionVersionOutput, error)

Creates a version of a resource definition that has already been defined.

func (*Client) CreateSoftwareUpdateJob

func (c *Client) CreateSoftwareUpdateJob(ctx context.Context, params *CreateSoftwareUpdateJobInput, optFns ...func(*Options)) (*CreateSoftwareUpdateJobOutput, error)

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

func (*Client) CreateSubscriptionDefinition

func (c *Client) CreateSubscriptionDefinition(ctx context.Context, params *CreateSubscriptionDefinitionInput, optFns ...func(*Options)) (*CreateSubscriptionDefinitionOutput, error)

Creates a subscription definition. You may provide the initial version of the subscription definition now or use ”CreateSubscriptionDefinitionVersion” at a later time.

func (*Client) CreateSubscriptionDefinitionVersion

func (c *Client) CreateSubscriptionDefinitionVersion(ctx context.Context, params *CreateSubscriptionDefinitionVersionInput, optFns ...func(*Options)) (*CreateSubscriptionDefinitionVersionOutput, error)

Creates a version of a subscription definition which has already been defined.

func (*Client) DeleteConnectorDefinition

func (c *Client) DeleteConnectorDefinition(ctx context.Context, params *DeleteConnectorDefinitionInput, optFns ...func(*Options)) (*DeleteConnectorDefinitionOutput, error)

Deletes a connector definition.

func (*Client) DeleteCoreDefinition

func (c *Client) DeleteCoreDefinition(ctx context.Context, params *DeleteCoreDefinitionInput, optFns ...func(*Options)) (*DeleteCoreDefinitionOutput, error)

Deletes a core definition.

func (*Client) DeleteDeviceDefinition

func (c *Client) DeleteDeviceDefinition(ctx context.Context, params *DeleteDeviceDefinitionInput, optFns ...func(*Options)) (*DeleteDeviceDefinitionOutput, error)

Deletes a device definition.

func (*Client) DeleteFunctionDefinition

func (c *Client) DeleteFunctionDefinition(ctx context.Context, params *DeleteFunctionDefinitionInput, optFns ...func(*Options)) (*DeleteFunctionDefinitionOutput, error)

Deletes a Lambda function definition.

func (*Client) DeleteGroup

func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

Deletes a group.

func (*Client) DeleteLoggerDefinition

func (c *Client) DeleteLoggerDefinition(ctx context.Context, params *DeleteLoggerDefinitionInput, optFns ...func(*Options)) (*DeleteLoggerDefinitionOutput, error)

Deletes a logger definition.

func (*Client) DeleteResourceDefinition

func (c *Client) DeleteResourceDefinition(ctx context.Context, params *DeleteResourceDefinitionInput, optFns ...func(*Options)) (*DeleteResourceDefinitionOutput, error)

Deletes a resource definition.

func (*Client) DeleteSubscriptionDefinition

func (c *Client) DeleteSubscriptionDefinition(ctx context.Context, params *DeleteSubscriptionDefinitionInput, optFns ...func(*Options)) (*DeleteSubscriptionDefinitionOutput, error)

Deletes a subscription definition.

func (*Client) DisassociateRoleFromGroup

func (c *Client) DisassociateRoleFromGroup(ctx context.Context, params *DisassociateRoleFromGroupInput, optFns ...func(*Options)) (*DisassociateRoleFromGroupOutput, error)

Disassociates the role from a group.

func (*Client) DisassociateServiceRoleFromAccount

func (c *Client) DisassociateServiceRoleFromAccount(ctx context.Context, params *DisassociateServiceRoleFromAccountInput, optFns ...func(*Options)) (*DisassociateServiceRoleFromAccountOutput, error)

Disassociates the service role from your account. Without a service role, deployments will not work.

func (*Client) GetAssociatedRole

func (c *Client) GetAssociatedRole(ctx context.Context, params *GetAssociatedRoleInput, optFns ...func(*Options)) (*GetAssociatedRoleOutput, error)

Retrieves the role associated with a particular group.

func (*Client) GetBulkDeploymentStatus

func (c *Client) GetBulkDeploymentStatus(ctx context.Context, params *GetBulkDeploymentStatusInput, optFns ...func(*Options)) (*GetBulkDeploymentStatusOutput, error)

Returns the status of a bulk deployment.

func (*Client) GetConnectivityInfo

func (c *Client) GetConnectivityInfo(ctx context.Context, params *GetConnectivityInfoInput, optFns ...func(*Options)) (*GetConnectivityInfoOutput, error)

Retrieves the connectivity information for a core.

func (*Client) GetConnectorDefinition

func (c *Client) GetConnectorDefinition(ctx context.Context, params *GetConnectorDefinitionInput, optFns ...func(*Options)) (*GetConnectorDefinitionOutput, error)

Retrieves information about a connector definition.

func (*Client) GetConnectorDefinitionVersion

func (c *Client) GetConnectorDefinitionVersion(ctx context.Context, params *GetConnectorDefinitionVersionInput, optFns ...func(*Options)) (*GetConnectorDefinitionVersionOutput, error)

Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.

func (*Client) GetCoreDefinition

func (c *Client) GetCoreDefinition(ctx context.Context, params *GetCoreDefinitionInput, optFns ...func(*Options)) (*GetCoreDefinitionOutput, error)

Retrieves information about a core definition version.

func (*Client) GetCoreDefinitionVersion

func (c *Client) GetCoreDefinitionVersion(ctx context.Context, params *GetCoreDefinitionVersionInput, optFns ...func(*Options)) (*GetCoreDefinitionVersionOutput, error)

Retrieves information about a core definition version.

func (*Client) GetDeploymentStatus

func (c *Client) GetDeploymentStatus(ctx context.Context, params *GetDeploymentStatusInput, optFns ...func(*Options)) (*GetDeploymentStatusOutput, error)

Returns the status of a deployment.

func (*Client) GetDeviceDefinition

func (c *Client) GetDeviceDefinition(ctx context.Context, params *GetDeviceDefinitionInput, optFns ...func(*Options)) (*GetDeviceDefinitionOutput, error)

Retrieves information about a device definition.

func (*Client) GetDeviceDefinitionVersion

func (c *Client) GetDeviceDefinitionVersion(ctx context.Context, params *GetDeviceDefinitionVersionInput, optFns ...func(*Options)) (*GetDeviceDefinitionVersionOutput, error)

Retrieves information about a device definition version.

func (*Client) GetFunctionDefinition

func (c *Client) GetFunctionDefinition(ctx context.Context, params *GetFunctionDefinitionInput, optFns ...func(*Options)) (*GetFunctionDefinitionOutput, error)

Retrieves information about a Lambda function definition, including its creation time and latest version.

func (*Client) GetFunctionDefinitionVersion

func (c *Client) GetFunctionDefinitionVersion(ctx context.Context, params *GetFunctionDefinitionVersionInput, optFns ...func(*Options)) (*GetFunctionDefinitionVersionOutput, error)

Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.

func (*Client) GetGroup

func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error)

Retrieves information about a group.

func (*Client) GetGroupCertificateAuthority

func (c *Client) GetGroupCertificateAuthority(ctx context.Context, params *GetGroupCertificateAuthorityInput, optFns ...func(*Options)) (*GetGroupCertificateAuthorityOutput, error)

Retreives the CA associated with a group. Returns the public key of the CA.

func (*Client) GetGroupCertificateConfiguration

func (c *Client) GetGroupCertificateConfiguration(ctx context.Context, params *GetGroupCertificateConfigurationInput, optFns ...func(*Options)) (*GetGroupCertificateConfigurationOutput, error)

Retrieves the current configuration for the CA used by the group.

func (*Client) GetGroupVersion

func (c *Client) GetGroupVersion(ctx context.Context, params *GetGroupVersionInput, optFns ...func(*Options)) (*GetGroupVersionOutput, error)

Retrieves information about a group version.

func (*Client) GetLoggerDefinition

func (c *Client) GetLoggerDefinition(ctx context.Context, params *GetLoggerDefinitionInput, optFns ...func(*Options)) (*GetLoggerDefinitionOutput, error)

Retrieves information about a logger definition.

func (*Client) GetLoggerDefinitionVersion

func (c *Client) GetLoggerDefinitionVersion(ctx context.Context, params *GetLoggerDefinitionVersionInput, optFns ...func(*Options)) (*GetLoggerDefinitionVersionOutput, error)

Retrieves information about a logger definition version.

func (*Client) GetResourceDefinition

func (c *Client) GetResourceDefinition(ctx context.Context, params *GetResourceDefinitionInput, optFns ...func(*Options)) (*GetResourceDefinitionOutput, error)

Retrieves information about a resource definition, including its creation time and latest version.

func (*Client) GetResourceDefinitionVersion

func (c *Client) GetResourceDefinitionVersion(ctx context.Context, params *GetResourceDefinitionVersionInput, optFns ...func(*Options)) (*GetResourceDefinitionVersionOutput, error)

Retrieves information about a resource definition version, including which resources are included in the version.

func (*Client) GetServiceRoleForAccount

func (c *Client) GetServiceRoleForAccount(ctx context.Context, params *GetServiceRoleForAccountInput, optFns ...func(*Options)) (*GetServiceRoleForAccountOutput, error)

Retrieves the service role that is attached to your account.

func (*Client) GetSubscriptionDefinition

func (c *Client) GetSubscriptionDefinition(ctx context.Context, params *GetSubscriptionDefinitionInput, optFns ...func(*Options)) (*GetSubscriptionDefinitionOutput, error)

Retrieves information about a subscription definition.

func (*Client) GetSubscriptionDefinitionVersion

func (c *Client) GetSubscriptionDefinitionVersion(ctx context.Context, params *GetSubscriptionDefinitionVersionInput, optFns ...func(*Options)) (*GetSubscriptionDefinitionVersionOutput, error)

Retrieves information about a subscription definition version.

func (*Client) GetThingRuntimeConfiguration added in v0.29.0

func (c *Client) GetThingRuntimeConfiguration(ctx context.Context, params *GetThingRuntimeConfigurationInput, optFns ...func(*Options)) (*GetThingRuntimeConfigurationOutput, error)

Get the runtime configuration of a thing.

func (*Client) ListBulkDeploymentDetailedReports

func (c *Client) ListBulkDeploymentDetailedReports(ctx context.Context, params *ListBulkDeploymentDetailedReportsInput, optFns ...func(*Options)) (*ListBulkDeploymentDetailedReportsOutput, error)

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

func (*Client) ListBulkDeployments

func (c *Client) ListBulkDeployments(ctx context.Context, params *ListBulkDeploymentsInput, optFns ...func(*Options)) (*ListBulkDeploymentsOutput, error)

Returns a list of bulk deployments.

func (*Client) ListConnectorDefinitionVersions

func (c *Client) ListConnectorDefinitionVersions(ctx context.Context, params *ListConnectorDefinitionVersionsInput, optFns ...func(*Options)) (*ListConnectorDefinitionVersionsOutput, error)

Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

func (*Client) ListConnectorDefinitions

func (c *Client) ListConnectorDefinitions(ctx context.Context, params *ListConnectorDefinitionsInput, optFns ...func(*Options)) (*ListConnectorDefinitionsOutput, error)

Retrieves a list of connector definitions.

func (*Client) ListCoreDefinitionVersions

func (c *Client) ListCoreDefinitionVersions(ctx context.Context, params *ListCoreDefinitionVersionsInput, optFns ...func(*Options)) (*ListCoreDefinitionVersionsOutput, error)

Lists the versions of a core definition.

func (*Client) ListCoreDefinitions

func (c *Client) ListCoreDefinitions(ctx context.Context, params *ListCoreDefinitionsInput, optFns ...func(*Options)) (*ListCoreDefinitionsOutput, error)

Retrieves a list of core definitions.

func (*Client) ListDeployments

func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInput, optFns ...func(*Options)) (*ListDeploymentsOutput, error)

Returns a history of deployments for the group.

func (*Client) ListDeviceDefinitionVersions

func (c *Client) ListDeviceDefinitionVersions(ctx context.Context, params *ListDeviceDefinitionVersionsInput, optFns ...func(*Options)) (*ListDeviceDefinitionVersionsOutput, error)

Lists the versions of a device definition.

func (*Client) ListDeviceDefinitions

func (c *Client) ListDeviceDefinitions(ctx context.Context, params *ListDeviceDefinitionsInput, optFns ...func(*Options)) (*ListDeviceDefinitionsOutput, error)

Retrieves a list of device definitions.

func (*Client) ListFunctionDefinitionVersions

func (c *Client) ListFunctionDefinitionVersions(ctx context.Context, params *ListFunctionDefinitionVersionsInput, optFns ...func(*Options)) (*ListFunctionDefinitionVersionsOutput, error)

Lists the versions of a Lambda function definition.

func (*Client) ListFunctionDefinitions

func (c *Client) ListFunctionDefinitions(ctx context.Context, params *ListFunctionDefinitionsInput, optFns ...func(*Options)) (*ListFunctionDefinitionsOutput, error)

Retrieves a list of Lambda function definitions.

func (*Client) ListGroupCertificateAuthorities

func (c *Client) ListGroupCertificateAuthorities(ctx context.Context, params *ListGroupCertificateAuthoritiesInput, optFns ...func(*Options)) (*ListGroupCertificateAuthoritiesOutput, error)

Retrieves the current CAs for a group.

func (*Client) ListGroupVersions

func (c *Client) ListGroupVersions(ctx context.Context, params *ListGroupVersionsInput, optFns ...func(*Options)) (*ListGroupVersionsOutput, error)

Lists the versions of a group.

func (*Client) ListGroups

func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)

Retrieves a list of groups.

func (*Client) ListLoggerDefinitionVersions

func (c *Client) ListLoggerDefinitionVersions(ctx context.Context, params *ListLoggerDefinitionVersionsInput, optFns ...func(*Options)) (*ListLoggerDefinitionVersionsOutput, error)

Lists the versions of a logger definition.

func (*Client) ListLoggerDefinitions

func (c *Client) ListLoggerDefinitions(ctx context.Context, params *ListLoggerDefinitionsInput, optFns ...func(*Options)) (*ListLoggerDefinitionsOutput, error)

Retrieves a list of logger definitions.

func (*Client) ListResourceDefinitionVersions

func (c *Client) ListResourceDefinitionVersions(ctx context.Context, params *ListResourceDefinitionVersionsInput, optFns ...func(*Options)) (*ListResourceDefinitionVersionsOutput, error)

Lists the versions of a resource definition.

func (*Client) ListResourceDefinitions

func (c *Client) ListResourceDefinitions(ctx context.Context, params *ListResourceDefinitionsInput, optFns ...func(*Options)) (*ListResourceDefinitionsOutput, error)

Retrieves a list of resource definitions.

func (*Client) ListSubscriptionDefinitionVersions

func (c *Client) ListSubscriptionDefinitionVersions(ctx context.Context, params *ListSubscriptionDefinitionVersionsInput, optFns ...func(*Options)) (*ListSubscriptionDefinitionVersionsOutput, error)

Lists the versions of a subscription definition.

func (*Client) ListSubscriptionDefinitions

func (c *Client) ListSubscriptionDefinitions(ctx context.Context, params *ListSubscriptionDefinitionsInput, optFns ...func(*Options)) (*ListSubscriptionDefinitionsOutput, error)

Retrieves a list of subscription definitions.

func (*Client) ListTagsForResource

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

Retrieves a list of resource tags for a resource arn.

func (*Client) Options added in v1.21.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) ResetDeployments

func (c *Client) ResetDeployments(ctx context.Context, params *ResetDeploymentsInput, optFns ...func(*Options)) (*ResetDeploymentsOutput, error)

Resets a group's deployments.

func (*Client) StartBulkDeployment

func (c *Client) StartBulkDeployment(ctx context.Context, params *StartBulkDeploymentInput, optFns ...func(*Options)) (*StartBulkDeploymentOutput, error)

Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ”X-Amzn-Client-Token” token in every ”StartBulkDeployment” request. These requests are idempotent with respect to the token and the request parameters.

func (*Client) StopBulkDeployment

func (c *Client) StopBulkDeployment(ctx context.Context, params *StopBulkDeploymentInput, optFns ...func(*Options)) (*StopBulkDeploymentOutput, error)

Stops the execution of a bulk deployment. This action returns a status of ”Stopping” until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ”Stopping” state. This action doesn't rollback completed deployments or cancel pending deployments.

func (*Client) TagResource

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

Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.

func (*Client) UntagResource

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

Remove resource tags from a Greengrass Resource.

func (*Client) UpdateConnectivityInfo

func (c *Client) UpdateConnectivityInfo(ctx context.Context, params *UpdateConnectivityInfoInput, optFns ...func(*Options)) (*UpdateConnectivityInfoOutput, error)

Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.

func (*Client) UpdateConnectorDefinition

func (c *Client) UpdateConnectorDefinition(ctx context.Context, params *UpdateConnectorDefinitionInput, optFns ...func(*Options)) (*UpdateConnectorDefinitionOutput, error)

Updates a connector definition.

func (*Client) UpdateCoreDefinition

func (c *Client) UpdateCoreDefinition(ctx context.Context, params *UpdateCoreDefinitionInput, optFns ...func(*Options)) (*UpdateCoreDefinitionOutput, error)

Updates a core definition.

func (*Client) UpdateDeviceDefinition

func (c *Client) UpdateDeviceDefinition(ctx context.Context, params *UpdateDeviceDefinitionInput, optFns ...func(*Options)) (*UpdateDeviceDefinitionOutput, error)

Updates a device definition.

func (*Client) UpdateFunctionDefinition

func (c *Client) UpdateFunctionDefinition(ctx context.Context, params *UpdateFunctionDefinitionInput, optFns ...func(*Options)) (*UpdateFunctionDefinitionOutput, error)

Updates a Lambda function definition.

func (*Client) UpdateGroup

func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)

Updates a group.

func (*Client) UpdateGroupCertificateConfiguration

func (c *Client) UpdateGroupCertificateConfiguration(ctx context.Context, params *UpdateGroupCertificateConfigurationInput, optFns ...func(*Options)) (*UpdateGroupCertificateConfigurationOutput, error)

Updates the Certificate expiry time for a group.

func (*Client) UpdateLoggerDefinition

func (c *Client) UpdateLoggerDefinition(ctx context.Context, params *UpdateLoggerDefinitionInput, optFns ...func(*Options)) (*UpdateLoggerDefinitionOutput, error)

Updates a logger definition.

func (*Client) UpdateResourceDefinition

func (c *Client) UpdateResourceDefinition(ctx context.Context, params *UpdateResourceDefinitionInput, optFns ...func(*Options)) (*UpdateResourceDefinitionOutput, error)

Updates a resource definition.

func (*Client) UpdateSubscriptionDefinition

func (c *Client) UpdateSubscriptionDefinition(ctx context.Context, params *UpdateSubscriptionDefinitionInput, optFns ...func(*Options)) (*UpdateSubscriptionDefinitionOutput, error)

Updates a subscription definition.

func (*Client) UpdateThingRuntimeConfiguration added in v0.29.0

func (c *Client) UpdateThingRuntimeConfiguration(ctx context.Context, params *UpdateThingRuntimeConfigurationInput, optFns ...func(*Options)) (*UpdateThingRuntimeConfigurationOutput, error)

Updates the runtime configuration of a thing.

type CreateConnectorDefinitionInput

type CreateConnectorDefinitionInput struct {

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the connector definition.
	InitialVersion *types.ConnectorDefinitionVersion

	// The name of the connector definition.
	Name *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateConnectorDefinitionOutput

type CreateConnectorDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateConnectorDefinitionVersionInput

type CreateConnectorDefinitionVersionInput struct {

	// The ID of the connector definition.
	//
	// This member is required.
	ConnectorDefinitionId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// A list of references to connectors in this version, with their corresponding
	// configuration settings.
	Connectors []types.Connector
	// contains filtered or unexported fields
}

type CreateConnectorDefinitionVersionOutput

type CreateConnectorDefinitionVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type CreateCoreDefinitionInput

type CreateCoreDefinitionInput struct {

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the core definition.
	InitialVersion *types.CoreDefinitionVersion

	// The name of the core definition.
	Name *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

Information needed to create a core definition.

type CreateCoreDefinitionOutput

type CreateCoreDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateCoreDefinitionVersionInput

type CreateCoreDefinitionVersionInput struct {

	// The ID of the core definition.
	//
	// This member is required.
	CoreDefinitionId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// A list of cores in the core definition version.
	Cores []types.Core
	// contains filtered or unexported fields
}

type CreateCoreDefinitionVersionOutput

type CreateCoreDefinitionVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type CreateDeploymentInput

type CreateDeploymentInput struct {

	// The type of deployment. When used for ”CreateDeployment”, only
	// ”NewDeployment” and ”Redeployment” are valid.
	//
	// This member is required.
	DeploymentType types.DeploymentType

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// The ID of the deployment if you wish to redeploy a previous deployment.
	DeploymentId *string

	// The ID of the group version to be deployed.
	GroupVersionId *string
	// contains filtered or unexported fields
}

type CreateDeploymentOutput

type CreateDeploymentOutput struct {

	// The ARN of the deployment.
	DeploymentArn *string

	// The ID of the deployment.
	DeploymentId *string

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

type CreateDeviceDefinitionInput

type CreateDeviceDefinitionInput struct {

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the device definition.
	InitialVersion *types.DeviceDefinitionVersion

	// The name of the device definition.
	Name *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDeviceDefinitionOutput

type CreateDeviceDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateDeviceDefinitionVersionInput

type CreateDeviceDefinitionVersionInput struct {

	// The ID of the device definition.
	//
	// This member is required.
	DeviceDefinitionId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// A list of devices in the definition version.
	Devices []types.Device
	// contains filtered or unexported fields
}

type CreateDeviceDefinitionVersionOutput

type CreateDeviceDefinitionVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type CreateFunctionDefinitionInput

type CreateFunctionDefinitionInput struct {

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the function definition.
	InitialVersion *types.FunctionDefinitionVersion

	// The name of the function definition.
	Name *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFunctionDefinitionOutput

type CreateFunctionDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateFunctionDefinitionVersionInput

type CreateFunctionDefinitionVersionInput struct {

	// The ID of the Lambda function definition.
	//
	// This member is required.
	FunctionDefinitionId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// The default configuration that applies to all Lambda functions in this function
	// definition version. Individual Lambda functions can override these settings.
	DefaultConfig *types.FunctionDefaultConfig

	// A list of Lambda functions in this function definition version.
	Functions []types.Function
	// contains filtered or unexported fields
}

Information needed to create a function definition version.

type CreateFunctionDefinitionVersionOutput

type CreateFunctionDefinitionVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type CreateGroupCertificateAuthorityInput

type CreateGroupCertificateAuthorityInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string
	// contains filtered or unexported fields
}

type CreateGroupCertificateAuthorityOutput

type CreateGroupCertificateAuthorityOutput struct {

	// The ARN of the group certificate authority.
	GroupCertificateAuthorityArn *string

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

type CreateGroupInput

type CreateGroupInput struct {

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

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the group.
	InitialVersion *types.GroupVersion

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateGroupOutput

type CreateGroupOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateGroupVersionInput

type CreateGroupVersionInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// The ARN of the connector definition version for this group.
	ConnectorDefinitionVersionArn *string

	// The ARN of the core definition version for this group.
	CoreDefinitionVersionArn *string

	// The ARN of the device definition version for this group.
	DeviceDefinitionVersionArn *string

	// The ARN of the function definition version for this group.
	FunctionDefinitionVersionArn *string

	// The ARN of the logger definition version for this group.
	LoggerDefinitionVersionArn *string

	// The ARN of the resource definition version for this group.
	ResourceDefinitionVersionArn *string

	// The ARN of the subscription definition version for this group.
	SubscriptionDefinitionVersionArn *string
	// contains filtered or unexported fields
}

type CreateGroupVersionOutput

type CreateGroupVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type CreateLoggerDefinitionInput

type CreateLoggerDefinitionInput struct {

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the logger definition.
	InitialVersion *types.LoggerDefinitionVersion

	// The name of the logger definition.
	Name *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateLoggerDefinitionOutput

type CreateLoggerDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateLoggerDefinitionVersionInput

type CreateLoggerDefinitionVersionInput struct {

	// The ID of the logger definition.
	//
	// This member is required.
	LoggerDefinitionId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// A list of loggers.
	Loggers []types.Logger
	// contains filtered or unexported fields
}

type CreateLoggerDefinitionVersionOutput

type CreateLoggerDefinitionVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type CreateResourceDefinitionInput

type CreateResourceDefinitionInput struct {

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the resource definition.
	InitialVersion *types.ResourceDefinitionVersion

	// The name of the resource definition.
	Name *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateResourceDefinitionOutput

type CreateResourceDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateResourceDefinitionVersionInput

type CreateResourceDefinitionVersionInput struct {

	// The ID of the resource definition.
	//
	// This member is required.
	ResourceDefinitionId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// A list of resources.
	Resources []types.Resource
	// contains filtered or unexported fields
}

type CreateResourceDefinitionVersionOutput

type CreateResourceDefinitionVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type CreateSoftwareUpdateJobInput

type CreateSoftwareUpdateJobInput struct {

	// The IAM Role that Greengrass will use to create pre-signed URLs pointing
	// towards the update artifact.
	//
	// This member is required.
	S3UrlSignerRole *string

	// The piece of software on the Greengrass core that will be updated.
	//
	// This member is required.
	SoftwareToUpdate types.SoftwareToUpdate

	// The ARNs of the targets (IoT things or IoT thing groups) that this update will
	// be applied to.
	//
	// This member is required.
	UpdateTargets []string

	// The architecture of the cores which are the targets of an update.
	//
	// This member is required.
	UpdateTargetsArchitecture types.UpdateTargetsArchitecture

	// The operating system of the cores which are the targets of an update.
	//
	// This member is required.
	UpdateTargetsOperatingSystem types.UpdateTargetsOperatingSystem

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// The minimum level of log statements that should be logged by the OTA Agent
	// during an update.
	UpdateAgentLogLevel types.UpdateAgentLogLevel
	// contains filtered or unexported fields
}

type CreateSoftwareUpdateJobOutput

type CreateSoftwareUpdateJobOutput struct {

	// The IoT Job ARN corresponding to this update.
	IotJobArn *string

	// The IoT Job Id corresponding to this update.
	IotJobId *string

	// The software version installed on the device or devices after the update.
	PlatformSoftwareVersion *string

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

type CreateSubscriptionDefinitionInput

type CreateSubscriptionDefinitionInput struct {

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Information about the initial version of the subscription definition.
	InitialVersion *types.SubscriptionDefinitionVersion

	// The name of the subscription definition.
	Name *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSubscriptionDefinitionOutput

type CreateSubscriptionDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

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

type CreateSubscriptionDefinitionVersionInput

type CreateSubscriptionDefinitionVersionInput struct {

	// The ID of the subscription definition.
	//
	// This member is required.
	SubscriptionDefinitionId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// A list of subscriptions.
	Subscriptions []types.Subscription
	// contains filtered or unexported fields
}

type CreateSubscriptionDefinitionVersionOutput

type CreateSubscriptionDefinitionVersionOutput struct {

	// The ARN of the version.
	Arn *string

	// The time, in milliseconds since the epoch, when the version was created.
	CreationTimestamp *string

	// The ID of the parent definition that the version is associated with.
	Id *string

	// The ID of the version.
	Version *string

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

type DeleteConnectorDefinitionInput

type DeleteConnectorDefinitionInput struct {

	// The ID of the connector definition.
	//
	// This member is required.
	ConnectorDefinitionId *string
	// contains filtered or unexported fields
}

type DeleteConnectorDefinitionOutput

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

type DeleteCoreDefinitionInput

type DeleteCoreDefinitionInput struct {

	// The ID of the core definition.
	//
	// This member is required.
	CoreDefinitionId *string
	// contains filtered or unexported fields
}

type DeleteCoreDefinitionOutput

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

type DeleteDeviceDefinitionInput

type DeleteDeviceDefinitionInput struct {

	// The ID of the device definition.
	//
	// This member is required.
	DeviceDefinitionId *string
	// contains filtered or unexported fields
}

type DeleteDeviceDefinitionOutput

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

type DeleteFunctionDefinitionInput

type DeleteFunctionDefinitionInput struct {

	// The ID of the Lambda function definition.
	//
	// This member is required.
	FunctionDefinitionId *string
	// contains filtered or unexported fields
}

type DeleteFunctionDefinitionOutput

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

type DeleteGroupInput

type DeleteGroupInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type DeleteGroupOutput

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

type DeleteLoggerDefinitionInput

type DeleteLoggerDefinitionInput struct {

	// The ID of the logger definition.
	//
	// This member is required.
	LoggerDefinitionId *string
	// contains filtered or unexported fields
}

type DeleteLoggerDefinitionOutput

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

type DeleteResourceDefinitionInput

type DeleteResourceDefinitionInput struct {

	// The ID of the resource definition.
	//
	// This member is required.
	ResourceDefinitionId *string
	// contains filtered or unexported fields
}

type DeleteResourceDefinitionOutput

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

type DeleteSubscriptionDefinitionInput

type DeleteSubscriptionDefinitionInput struct {

	// The ID of the subscription definition.
	//
	// This member is required.
	SubscriptionDefinitionId *string
	// contains filtered or unexported fields
}

type DeleteSubscriptionDefinitionOutput

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

type DisassociateRoleFromGroupInput

type DisassociateRoleFromGroupInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type DisassociateRoleFromGroupOutput

type DisassociateRoleFromGroupOutput struct {

	// The time, in milliseconds since the epoch, when the role was disassociated from
	// the group.
	DisassociatedAt *string

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

type DisassociateServiceRoleFromAccountInput

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

type DisassociateServiceRoleFromAccountOutput

type DisassociateServiceRoleFromAccountOutput struct {

	// The time when the service role was disassociated from the account.
	DisassociatedAt *string

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

type EndpointParameters added in v1.16.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.16.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.16.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.16.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.16.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAssociatedRoleInput

type GetAssociatedRoleInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type GetAssociatedRoleOutput

type GetAssociatedRoleOutput struct {

	// The time when the role was associated with the group.
	AssociatedAt *string

	// The ARN of the role that is associated with the group.
	RoleArn *string

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

type GetBulkDeploymentStatusInput

type GetBulkDeploymentStatusInput struct {

	// The ID of the bulk deployment.
	//
	// This member is required.
	BulkDeploymentId *string
	// contains filtered or unexported fields
}

type GetBulkDeploymentStatusOutput

type GetBulkDeploymentStatusOutput struct {

	// Relevant metrics on input records processed during bulk deployment.
	BulkDeploymentMetrics *types.BulkDeploymentMetrics

	// The status of the bulk deployment.
	BulkDeploymentStatus types.BulkDeploymentStatus

	// The time, in ISO format, when the deployment was created.
	CreatedAt *string

	// Error details
	ErrorDetails []types.ErrorDetail

	// Error message
	ErrorMessage *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetConnectivityInfoInput

type GetConnectivityInfoInput struct {

	// The thing name.
	//
	// This member is required.
	ThingName *string
	// contains filtered or unexported fields
}

type GetConnectivityInfoOutput

type GetConnectivityInfoOutput struct {

	// Connectivity info list.
	ConnectivityInfo []types.ConnectivityInfo

	// A message about the connectivity info request.
	Message *string

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

type GetConnectorDefinitionInput

type GetConnectorDefinitionInput struct {

	// The ID of the connector definition.
	//
	// This member is required.
	ConnectorDefinitionId *string
	// contains filtered or unexported fields
}

type GetConnectorDefinitionOutput

type GetConnectorDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetConnectorDefinitionVersionInput

type GetConnectorDefinitionVersionInput struct {

	// The ID of the connector definition.
	//
	// This member is required.
	ConnectorDefinitionId *string

	// The ID of the connector definition version. This value maps to the ”Version”
	// property of the corresponding ”VersionInformation” object, which is returned
	// by ”ListConnectorDefinitionVersions” requests. If the version is the last one
	// that was associated with a connector definition, the value also maps to the
	// ”LatestVersion” property of the corresponding ”DefinitionInformation”
	// object.
	//
	// This member is required.
	ConnectorDefinitionVersionId *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetConnectorDefinitionVersionOutput

type GetConnectorDefinitionVersionOutput struct {

	// The ARN of the connector definition version.
	Arn *string

	// The time, in milliseconds since the epoch, when the connector definition
	// version was created.
	CreationTimestamp *string

	// Information about the connector definition version.
	Definition *types.ConnectorDefinitionVersion

	// The ID of the connector definition version.
	Id *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// The version of the connector definition version.
	Version *string

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

type GetCoreDefinitionInput

type GetCoreDefinitionInput struct {

	// The ID of the core definition.
	//
	// This member is required.
	CoreDefinitionId *string
	// contains filtered or unexported fields
}

type GetCoreDefinitionOutput

type GetCoreDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetCoreDefinitionVersionInput

type GetCoreDefinitionVersionInput struct {

	// The ID of the core definition.
	//
	// This member is required.
	CoreDefinitionId *string

	// The ID of the core definition version. This value maps to the ”Version”
	// property of the corresponding ”VersionInformation” object, which is returned
	// by ”ListCoreDefinitionVersions” requests. If the version is the last one that
	// was associated with a core definition, the value also maps to the
	// ”LatestVersion” property of the corresponding ”DefinitionInformation”
	// object.
	//
	// This member is required.
	CoreDefinitionVersionId *string
	// contains filtered or unexported fields
}

type GetCoreDefinitionVersionOutput

type GetCoreDefinitionVersionOutput struct {

	// The ARN of the core definition version.
	Arn *string

	// The time, in milliseconds since the epoch, when the core definition version was
	// created.
	CreationTimestamp *string

	// Information about the core definition version.
	Definition *types.CoreDefinitionVersion

	// The ID of the core definition version.
	Id *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// The version of the core definition version.
	Version *string

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

type GetDeploymentStatusInput

type GetDeploymentStatusInput struct {

	// The ID of the deployment.
	//
	// This member is required.
	DeploymentId *string

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type GetDeploymentStatusOutput

type GetDeploymentStatusOutput struct {

	// The status of the deployment: ”InProgress”, ”Building”, ”Success”, or
	// ”Failure”.
	DeploymentStatus *string

	// The type of the deployment.
	DeploymentType types.DeploymentType

	// Error details
	ErrorDetails []types.ErrorDetail

	// Error message
	ErrorMessage *string

	// The time, in milliseconds since the epoch, when the deployment status was
	// updated.
	UpdatedAt *string

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

type GetDeviceDefinitionInput

type GetDeviceDefinitionInput struct {

	// The ID of the device definition.
	//
	// This member is required.
	DeviceDefinitionId *string
	// contains filtered or unexported fields
}

type GetDeviceDefinitionOutput

type GetDeviceDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetDeviceDefinitionVersionInput

type GetDeviceDefinitionVersionInput struct {

	// The ID of the device definition.
	//
	// This member is required.
	DeviceDefinitionId *string

	// The ID of the device definition version. This value maps to the ”Version”
	// property of the corresponding ”VersionInformation” object, which is returned
	// by ”ListDeviceDefinitionVersions” requests. If the version is the last one
	// that was associated with a device definition, the value also maps to the
	// ”LatestVersion” property of the corresponding ”DefinitionInformation”
	// object.
	//
	// This member is required.
	DeviceDefinitionVersionId *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetDeviceDefinitionVersionOutput

type GetDeviceDefinitionVersionOutput struct {

	// The ARN of the device definition version.
	Arn *string

	// The time, in milliseconds since the epoch, when the device definition version
	// was created.
	CreationTimestamp *string

	// Information about the device definition version.
	Definition *types.DeviceDefinitionVersion

	// The ID of the device definition version.
	Id *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// The version of the device definition version.
	Version *string

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

type GetFunctionDefinitionInput

type GetFunctionDefinitionInput struct {

	// The ID of the Lambda function definition.
	//
	// This member is required.
	FunctionDefinitionId *string
	// contains filtered or unexported fields
}

type GetFunctionDefinitionOutput

type GetFunctionDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetFunctionDefinitionVersionInput

type GetFunctionDefinitionVersionInput struct {

	// The ID of the Lambda function definition.
	//
	// This member is required.
	FunctionDefinitionId *string

	// The ID of the function definition version. This value maps to the ”Version”
	// property of the corresponding ”VersionInformation” object, which is returned
	// by ”ListFunctionDefinitionVersions” requests. If the version is the last one
	// that was associated with a function definition, the value also maps to the
	// ”LatestVersion” property of the corresponding ”DefinitionInformation”
	// object.
	//
	// This member is required.
	FunctionDefinitionVersionId *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetFunctionDefinitionVersionOutput

type GetFunctionDefinitionVersionOutput struct {

	// The ARN of the function definition version.
	Arn *string

	// The time, in milliseconds since the epoch, when the function definition version
	// was created.
	CreationTimestamp *string

	// Information on the definition.
	Definition *types.FunctionDefinitionVersion

	// The ID of the function definition version.
	Id *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// The version of the function definition version.
	Version *string

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

type GetGroupCertificateAuthorityInput

type GetGroupCertificateAuthorityInput struct {

	// The ID of the certificate authority.
	//
	// This member is required.
	CertificateAuthorityId *string

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type GetGroupCertificateAuthorityOutput

type GetGroupCertificateAuthorityOutput struct {

	// The ARN of the certificate authority for the group.
	GroupCertificateAuthorityArn *string

	// The ID of the certificate authority for the group.
	GroupCertificateAuthorityId *string

	// The PEM encoded certificate for the group.
	PemEncodedCertificate *string

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

type GetGroupCertificateConfigurationInput

type GetGroupCertificateConfigurationInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type GetGroupCertificateConfigurationOutput

type GetGroupCertificateConfigurationOutput struct {

	// The amount of time remaining before the certificate authority expires, in
	// milliseconds.
	CertificateAuthorityExpiryInMilliseconds *string

	// The amount of time remaining before the certificate expires, in milliseconds.
	CertificateExpiryInMilliseconds *string

	// The ID of the group certificate configuration.
	GroupId *string

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

type GetGroupInput

type GetGroupInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type GetGroupOutput

type GetGroupOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetGroupVersionInput

type GetGroupVersionInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// The ID of the group version. This value maps to the ”Version” property of the
	// corresponding ”VersionInformation” object, which is returned by
	// ”ListGroupVersions” requests. If the version is the last one that was
	// associated with a group, the value also maps to the ”LatestVersion” property
	// of the corresponding ”GroupInformation” object.
	//
	// This member is required.
	GroupVersionId *string
	// contains filtered or unexported fields
}

type GetGroupVersionOutput

type GetGroupVersionOutput struct {

	// The ARN of the group version.
	Arn *string

	// The time, in milliseconds since the epoch, when the group version was created.
	CreationTimestamp *string

	// Information about the group version definition.
	Definition *types.GroupVersion

	// The ID of the group that the version is associated with.
	Id *string

	// The ID of the group version.
	Version *string

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

type GetLoggerDefinitionInput

type GetLoggerDefinitionInput struct {

	// The ID of the logger definition.
	//
	// This member is required.
	LoggerDefinitionId *string
	// contains filtered or unexported fields
}

type GetLoggerDefinitionOutput

type GetLoggerDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetLoggerDefinitionVersionInput

type GetLoggerDefinitionVersionInput struct {

	// The ID of the logger definition.
	//
	// This member is required.
	LoggerDefinitionId *string

	// The ID of the logger definition version. This value maps to the ”Version”
	// property of the corresponding ”VersionInformation” object, which is returned
	// by ”ListLoggerDefinitionVersions” requests. If the version is the last one
	// that was associated with a logger definition, the value also maps to the
	// ”LatestVersion” property of the corresponding ”DefinitionInformation”
	// object.
	//
	// This member is required.
	LoggerDefinitionVersionId *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetLoggerDefinitionVersionOutput

type GetLoggerDefinitionVersionOutput struct {

	// The ARN of the logger definition version.
	Arn *string

	// The time, in milliseconds since the epoch, when the logger definition version
	// was created.
	CreationTimestamp *string

	// Information about the logger definition version.
	Definition *types.LoggerDefinitionVersion

	// The ID of the logger definition version.
	Id *string

	// The version of the logger definition version.
	Version *string

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

type GetResourceDefinitionInput

type GetResourceDefinitionInput struct {

	// The ID of the resource definition.
	//
	// This member is required.
	ResourceDefinitionId *string
	// contains filtered or unexported fields
}

type GetResourceDefinitionOutput

type GetResourceDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetResourceDefinitionVersionInput

type GetResourceDefinitionVersionInput struct {

	// The ID of the resource definition.
	//
	// This member is required.
	ResourceDefinitionId *string

	// The ID of the resource definition version. This value maps to the ”Version”
	// property of the corresponding ”VersionInformation” object, which is returned
	// by ”ListResourceDefinitionVersions” requests. If the version is the last one
	// that was associated with a resource definition, the value also maps to the
	// ”LatestVersion” property of the corresponding ”DefinitionInformation”
	// object.
	//
	// This member is required.
	ResourceDefinitionVersionId *string
	// contains filtered or unexported fields
}

type GetResourceDefinitionVersionOutput

type GetResourceDefinitionVersionOutput struct {

	// Arn of the resource definition version.
	Arn *string

	// The time, in milliseconds since the epoch, when the resource definition version
	// was created.
	CreationTimestamp *string

	// Information about the definition.
	Definition *types.ResourceDefinitionVersion

	// The ID of the resource definition version.
	Id *string

	// The version of the resource definition version.
	Version *string

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

type GetServiceRoleForAccountInput

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

type GetServiceRoleForAccountOutput

type GetServiceRoleForAccountOutput struct {

	// The time when the service role was associated with the account.
	AssociatedAt *string

	// The ARN of the role which is associated with the account.
	RoleArn *string

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

type GetSubscriptionDefinitionInput

type GetSubscriptionDefinitionInput struct {

	// The ID of the subscription definition.
	//
	// This member is required.
	SubscriptionDefinitionId *string
	// contains filtered or unexported fields
}

type GetSubscriptionDefinitionOutput

type GetSubscriptionDefinitionOutput struct {

	// The ARN of the definition.
	Arn *string

	// The time, in milliseconds since the epoch, when the definition was created.
	CreationTimestamp *string

	// The ID of the definition.
	Id *string

	// The time, in milliseconds since the epoch, when the definition was last updated.
	LastUpdatedTimestamp *string

	// The ID of the latest version associated with the definition.
	LatestVersion *string

	// The ARN of the latest version associated with the definition.
	LatestVersionArn *string

	// The name of the definition.
	Name *string

	// Tag(s) attached to the resource arn.
	Tags map[string]string

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

type GetSubscriptionDefinitionVersionInput

type GetSubscriptionDefinitionVersionInput struct {

	// The ID of the subscription definition.
	//
	// This member is required.
	SubscriptionDefinitionId *string

	// The ID of the subscription definition version. This value maps to the
	// ”Version” property of the corresponding ”VersionInformation” object, which
	// is returned by ”ListSubscriptionDefinitionVersions” requests. If the version
	// is the last one that was associated with a subscription definition, the value
	// also maps to the ”LatestVersion” property of the corresponding
	// ”DefinitionInformation” object.
	//
	// This member is required.
	SubscriptionDefinitionVersionId *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetSubscriptionDefinitionVersionOutput

type GetSubscriptionDefinitionVersionOutput struct {

	// The ARN of the subscription definition version.
	Arn *string

	// The time, in milliseconds since the epoch, when the subscription definition
	// version was created.
	CreationTimestamp *string

	// Information about the subscription definition version.
	Definition *types.SubscriptionDefinitionVersion

	// The ID of the subscription definition version.
	Id *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// The version of the subscription definition version.
	Version *string

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

type GetThingRuntimeConfigurationInput added in v0.29.0

type GetThingRuntimeConfigurationInput struct {

	// The thing name.
	//
	// This member is required.
	ThingName *string
	// contains filtered or unexported fields
}

type GetThingRuntimeConfigurationOutput added in v0.29.0

type GetThingRuntimeConfigurationOutput struct {

	// Runtime configuration for a thing.
	RuntimeConfiguration *types.RuntimeConfiguration

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

type ListBulkDeploymentDetailedReportsInput struct {

	// The ID of the bulk deployment.
	//
	// This member is required.
	BulkDeploymentId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBulkDeploymentDetailedReportsOutput

type ListBulkDeploymentDetailedReportsOutput struct {

	// A list of the individual group deployments in the bulk deployment operation.
	Deployments []types.BulkDeploymentResult

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

type ListBulkDeploymentsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBulkDeploymentsOutput

type ListBulkDeploymentsOutput struct {

	// A list of bulk deployments.
	BulkDeployments []types.BulkDeployment

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

type ListConnectorDefinitionVersionsInput struct {

	// The ID of the connector definition.
	//
	// This member is required.
	ConnectorDefinitionId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListConnectorDefinitionVersionsOutput

type ListConnectorDefinitionVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListConnectorDefinitionsInput

type ListConnectorDefinitionsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListConnectorDefinitionsOutput

type ListConnectorDefinitionsOutput struct {

	// Information about a definition.
	Definitions []types.DefinitionInformation

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

type ListCoreDefinitionVersionsInput struct {

	// The ID of the core definition.
	//
	// This member is required.
	CoreDefinitionId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCoreDefinitionVersionsOutput

type ListCoreDefinitionVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListCoreDefinitionsInput

type ListCoreDefinitionsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCoreDefinitionsOutput

type ListCoreDefinitionsOutput struct {

	// Information about a definition.
	Definitions []types.DefinitionInformation

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

type ListDeploymentsInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDeploymentsOutput

type ListDeploymentsOutput struct {

	// A list of deployments for the requested groups.
	Deployments []types.Deployment

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

type ListDeviceDefinitionVersionsInput struct {

	// The ID of the device definition.
	//
	// This member is required.
	DeviceDefinitionId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDeviceDefinitionVersionsOutput

type ListDeviceDefinitionVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListDeviceDefinitionsInput

type ListDeviceDefinitionsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDeviceDefinitionsOutput

type ListDeviceDefinitionsOutput struct {

	// Information about a definition.
	Definitions []types.DefinitionInformation

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

type ListFunctionDefinitionVersionsInput struct {

	// The ID of the Lambda function definition.
	//
	// This member is required.
	FunctionDefinitionId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFunctionDefinitionVersionsOutput

type ListFunctionDefinitionVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListFunctionDefinitionsInput

type ListFunctionDefinitionsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFunctionDefinitionsOutput

type ListFunctionDefinitionsOutput struct {

	// Information about a definition.
	Definitions []types.DefinitionInformation

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

type ListGroupCertificateAuthoritiesInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type ListGroupCertificateAuthoritiesOutput

type ListGroupCertificateAuthoritiesOutput struct {

	// A list of certificate authorities associated with the group.
	GroupCertificateAuthorities []types.GroupCertificateAuthorityProperties

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

type ListGroupVersionsInput

type ListGroupVersionsInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupVersionsOutput

type ListGroupVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListGroupsInput

type ListGroupsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupsOutput

type ListGroupsOutput struct {

	// Information about a group.
	Groups []types.GroupInformation

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

type ListLoggerDefinitionVersionsInput struct {

	// The ID of the logger definition.
	//
	// This member is required.
	LoggerDefinitionId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLoggerDefinitionVersionsOutput

type ListLoggerDefinitionVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListLoggerDefinitionsInput

type ListLoggerDefinitionsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLoggerDefinitionsOutput

type ListLoggerDefinitionsOutput struct {

	// Information about a definition.
	Definitions []types.DefinitionInformation

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

type ListResourceDefinitionVersionsInput struct {

	// The ID of the resource definition.
	//
	// This member is required.
	ResourceDefinitionId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourceDefinitionVersionsOutput

type ListResourceDefinitionVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListResourceDefinitionsInput

type ListResourceDefinitionsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourceDefinitionsOutput

type ListResourceDefinitionsOutput struct {

	// Information about a definition.
	Definitions []types.DefinitionInformation

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

type ListSubscriptionDefinitionVersionsInput struct {

	// The ID of the subscription definition.
	//
	// This member is required.
	SubscriptionDefinitionId *string

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSubscriptionDefinitionVersionsOutput

type ListSubscriptionDefinitionVersionsOutput struct {

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string

	// Information about a version.
	Versions []types.VersionInformation

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

type ListSubscriptionDefinitionsInput

type ListSubscriptionDefinitionsInput struct {

	// The maximum number of results to be returned per request.
	MaxResults *string

	// The token for the next set of results, or ”null” if there are no additional
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSubscriptionDefinitionsOutput

type ListSubscriptionDefinitionsOutput struct {

	// Information about a definition.
	Definitions []types.DefinitionInformation

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

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The key-value pair for the resource tag.
	Tags map[string]string

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

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

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

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

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResetDeploymentsInput

type ResetDeploymentsInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// If true, performs a best-effort only core reset.
	Force *bool
	// contains filtered or unexported fields
}

Information needed to reset deployments.

type ResetDeploymentsOutput

type ResetDeploymentsOutput struct {

	// The ARN of the deployment.
	DeploymentArn *string

	// The ID of the deployment.
	DeploymentId *string

	// 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 (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartBulkDeploymentInput

type StartBulkDeploymentInput struct {

	// The ARN of the execution role to associate with the bulk deployment operation.
	// This IAM role must allow the ”greengrass:CreateDeployment” action for all
	// group versions that are listed in the input file. This IAM role must have access
	// to the S3 bucket containing the input file.
	//
	// This member is required.
	ExecutionRoleArn *string

	// The URI of the input file contained in the S3 bucket. The execution role must
	// have ”getObject” permissions on this bucket to access the input file. The
	// input file is a JSON-serialized, line delimited file with UTF-8 encoding that
	// provides a list of group and version IDs and the deployment type. This file must
	// be less than 100 MB. Currently, AWS IoT Greengrass supports only
	// ”NewDeployment” deployment types.
	//
	// This member is required.
	InputFileUri *string

	// A client token used to correlate requests and responses.
	AmznClientToken *string

	// Tag(s) to add to the new resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type StartBulkDeploymentOutput

type StartBulkDeploymentOutput struct {

	// The ARN of the bulk deployment.
	BulkDeploymentArn *string

	// The ID of the bulk deployment.
	BulkDeploymentId *string

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

type StopBulkDeploymentInput

type StopBulkDeploymentInput struct {

	// The ID of the bulk deployment.
	//
	// This member is required.
	BulkDeploymentId *string
	// contains filtered or unexported fields
}

type StopBulkDeploymentOutput

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

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The key-value pair for the resource tag.
	Tags map[string]string
	// contains filtered or unexported fields
}

A map of the key-value pairs for the resource tag.

type TagResourceOutput

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

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string

	// An array of tag keys to delete
	//
	// 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 UpdateConnectivityInfoInput

type UpdateConnectivityInfoInput struct {

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

	// A list of connectivity info.
	ConnectivityInfo []types.ConnectivityInfo
	// contains filtered or unexported fields
}

Connectivity information.

type UpdateConnectivityInfoOutput

type UpdateConnectivityInfoOutput struct {

	// A message about the connectivity info update request.
	Message *string

	// The new version of the connectivity info.
	Version *string

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

type UpdateConnectorDefinitionInput

type UpdateConnectorDefinitionInput struct {

	// The ID of the connector definition.
	//
	// This member is required.
	ConnectorDefinitionId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateConnectorDefinitionOutput

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

type UpdateCoreDefinitionInput

type UpdateCoreDefinitionInput struct {

	// The ID of the core definition.
	//
	// This member is required.
	CoreDefinitionId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateCoreDefinitionOutput

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

type UpdateDeviceDefinitionInput

type UpdateDeviceDefinitionInput struct {

	// The ID of the device definition.
	//
	// This member is required.
	DeviceDefinitionId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateDeviceDefinitionOutput

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

type UpdateFunctionDefinitionInput

type UpdateFunctionDefinitionInput struct {

	// The ID of the Lambda function definition.
	//
	// This member is required.
	FunctionDefinitionId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateFunctionDefinitionOutput

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

type UpdateGroupCertificateConfigurationInput

type UpdateGroupCertificateConfigurationInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// The amount of time remaining before the certificate expires, in milliseconds.
	CertificateExpiryInMilliseconds *string
	// contains filtered or unexported fields
}

type UpdateGroupCertificateConfigurationOutput

type UpdateGroupCertificateConfigurationOutput struct {

	// The amount of time remaining before the certificate authority expires, in
	// milliseconds.
	CertificateAuthorityExpiryInMilliseconds *string

	// The amount of time remaining before the certificate expires, in milliseconds.
	CertificateExpiryInMilliseconds *string

	// The ID of the group certificate configuration.
	GroupId *string

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

type UpdateGroupInput

type UpdateGroupInput struct {

	// The ID of the Greengrass group.
	//
	// This member is required.
	GroupId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateGroupOutput

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

type UpdateLoggerDefinitionInput

type UpdateLoggerDefinitionInput struct {

	// The ID of the logger definition.
	//
	// This member is required.
	LoggerDefinitionId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateLoggerDefinitionOutput

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

type UpdateResourceDefinitionInput

type UpdateResourceDefinitionInput struct {

	// The ID of the resource definition.
	//
	// This member is required.
	ResourceDefinitionId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateResourceDefinitionOutput

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

type UpdateSubscriptionDefinitionInput

type UpdateSubscriptionDefinitionInput struct {

	// The ID of the subscription definition.
	//
	// This member is required.
	SubscriptionDefinitionId *string

	// The name of the definition.
	Name *string
	// contains filtered or unexported fields
}

type UpdateSubscriptionDefinitionOutput

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

type UpdateThingRuntimeConfigurationInput added in v0.29.0

type UpdateThingRuntimeConfigurationInput struct {

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

	// Configuration for telemetry service.
	TelemetryConfiguration *types.TelemetryConfigurationUpdate
	// contains filtered or unexported fields
}

type UpdateThingRuntimeConfigurationOutput added in v0.29.0

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

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL