panorama

package module
v1.21.3 Latest Latest
Warning

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

Go to latest
Published: Sep 27, 2024 License: Apache-2.0 Imports: 44 Imported by: 7

Documentation

Overview

Package panorama provides the API client, operations, and parameter types for AWS Panorama.

AWS Panorama

Overview

This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide.

Index

Constants

View Source
const ServiceAPIVersion = "2019-07-24"
View Source
const ServiceID = "Panorama"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.15.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.15.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 AuthResolverParameters added in v1.15.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.15.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 Panorama.

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

func (c *Client) CreateApplicationInstance(ctx context.Context, params *CreateApplicationInstanceInput, optFns ...func(*Options)) (*CreateApplicationInstanceOutput, error)

Creates an application instance and deploys it to a device.

func (*Client) CreateJobForDevices

func (c *Client) CreateJobForDevices(ctx context.Context, params *CreateJobForDevicesInput, optFns ...func(*Options)) (*CreateJobForDevicesOutput, error)

Creates a job to run on a device. A job can update a device's software or reboot it.

func (*Client) CreateNodeFromTemplateJob

func (c *Client) CreateNodeFromTemplateJob(ctx context.Context, params *CreateNodeFromTemplateJobInput, optFns ...func(*Options)) (*CreateNodeFromTemplateJobOutput, error)

Creates a camera stream node.

func (*Client) CreatePackage

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

Creates a package and storage location in an Amazon S3 access point.

func (*Client) CreatePackageImportJob

func (c *Client) CreatePackageImportJob(ctx context.Context, params *CreatePackageImportJobInput, optFns ...func(*Options)) (*CreatePackageImportJobOutput, error)

Imports a node package.

func (*Client) DeleteDevice

func (c *Client) DeleteDevice(ctx context.Context, params *DeleteDeviceInput, optFns ...func(*Options)) (*DeleteDeviceOutput, error)

Deletes a device.

func (*Client) DeletePackage

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

Deletes a package.

To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.

func (*Client) DeregisterPackageVersion

func (c *Client) DeregisterPackageVersion(ctx context.Context, params *DeregisterPackageVersionInput, optFns ...func(*Options)) (*DeregisterPackageVersionOutput, error)

Deregisters a package version.

func (*Client) DescribeApplicationInstance

func (c *Client) DescribeApplicationInstance(ctx context.Context, params *DescribeApplicationInstanceInput, optFns ...func(*Options)) (*DescribeApplicationInstanceOutput, error)

Returns information about an application instance on a device.

func (*Client) DescribeApplicationInstanceDetails

func (c *Client) DescribeApplicationInstanceDetails(ctx context.Context, params *DescribeApplicationInstanceDetailsInput, optFns ...func(*Options)) (*DescribeApplicationInstanceDetailsOutput, error)

Returns information about an application instance's configuration manifest.

func (*Client) DescribeDevice

func (c *Client) DescribeDevice(ctx context.Context, params *DescribeDeviceInput, optFns ...func(*Options)) (*DescribeDeviceOutput, error)

Returns information about a device.

func (*Client) DescribeDeviceJob

func (c *Client) DescribeDeviceJob(ctx context.Context, params *DescribeDeviceJobInput, optFns ...func(*Options)) (*DescribeDeviceJobOutput, error)

Returns information about a device job.

func (*Client) DescribeNode

func (c *Client) DescribeNode(ctx context.Context, params *DescribeNodeInput, optFns ...func(*Options)) (*DescribeNodeOutput, error)

Returns information about a node.

func (*Client) DescribeNodeFromTemplateJob

func (c *Client) DescribeNodeFromTemplateJob(ctx context.Context, params *DescribeNodeFromTemplateJobInput, optFns ...func(*Options)) (*DescribeNodeFromTemplateJobOutput, error)

Returns information about a job to create a camera stream node.

func (*Client) DescribePackage

func (c *Client) DescribePackage(ctx context.Context, params *DescribePackageInput, optFns ...func(*Options)) (*DescribePackageOutput, error)

Returns information about a package.

func (*Client) DescribePackageImportJob

func (c *Client) DescribePackageImportJob(ctx context.Context, params *DescribePackageImportJobInput, optFns ...func(*Options)) (*DescribePackageImportJobOutput, error)

Returns information about a package import job.

func (*Client) DescribePackageVersion

func (c *Client) DescribePackageVersion(ctx context.Context, params *DescribePackageVersionInput, optFns ...func(*Options)) (*DescribePackageVersionOutput, error)

Returns information about a package version.

func (*Client) ListApplicationInstanceDependencies

func (c *Client) ListApplicationInstanceDependencies(ctx context.Context, params *ListApplicationInstanceDependenciesInput, optFns ...func(*Options)) (*ListApplicationInstanceDependenciesOutput, error)

Returns a list of application instance dependencies.

func (*Client) ListApplicationInstanceNodeInstances

func (c *Client) ListApplicationInstanceNodeInstances(ctx context.Context, params *ListApplicationInstanceNodeInstancesInput, optFns ...func(*Options)) (*ListApplicationInstanceNodeInstancesOutput, error)

Returns a list of application node instances.

func (*Client) ListApplicationInstances

func (c *Client) ListApplicationInstances(ctx context.Context, params *ListApplicationInstancesInput, optFns ...func(*Options)) (*ListApplicationInstancesOutput, error)

Returns a list of application instances.

func (*Client) ListDevices

func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error)

Returns a list of devices.

func (*Client) ListDevicesJobs

func (c *Client) ListDevicesJobs(ctx context.Context, params *ListDevicesJobsInput, optFns ...func(*Options)) (*ListDevicesJobsOutput, error)

Returns a list of jobs.

func (*Client) ListNodeFromTemplateJobs

func (c *Client) ListNodeFromTemplateJobs(ctx context.Context, params *ListNodeFromTemplateJobsInput, optFns ...func(*Options)) (*ListNodeFromTemplateJobsOutput, error)

Returns a list of camera stream node jobs.

func (*Client) ListNodes

func (c *Client) ListNodes(ctx context.Context, params *ListNodesInput, optFns ...func(*Options)) (*ListNodesOutput, error)

Returns a list of nodes.

func (*Client) ListPackageImportJobs

func (c *Client) ListPackageImportJobs(ctx context.Context, params *ListPackageImportJobsInput, optFns ...func(*Options)) (*ListPackageImportJobsOutput, error)

Returns a list of package import jobs.

func (*Client) ListPackages

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

Returns a list of packages.

func (*Client) ListTagsForResource

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

Returns a list of tags for a resource.

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

func (c *Client) ProvisionDevice(ctx context.Context, params *ProvisionDeviceInput, optFns ...func(*Options)) (*ProvisionDeviceOutput, error)

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

func (*Client) RegisterPackageVersion

func (c *Client) RegisterPackageVersion(ctx context.Context, params *RegisterPackageVersionInput, optFns ...func(*Options)) (*RegisterPackageVersionOutput, error)

Registers a package version.

func (*Client) RemoveApplicationInstance

func (c *Client) RemoveApplicationInstance(ctx context.Context, params *RemoveApplicationInstanceInput, optFns ...func(*Options)) (*RemoveApplicationInstanceOutput, error)

Removes an application instance.

func (*Client) SignalApplicationInstanceNodeInstances added in v1.9.0

func (c *Client) SignalApplicationInstanceNodeInstances(ctx context.Context, params *SignalApplicationInstanceNodeInstancesInput, optFns ...func(*Options)) (*SignalApplicationInstanceNodeInstancesOutput, error)

Signal camera nodes to stop or resume.

func (*Client) TagResource

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

Tags a resource.

func (*Client) UntagResource

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

Removes tags from a resource.

func (*Client) UpdateDeviceMetadata

func (c *Client) UpdateDeviceMetadata(ctx context.Context, params *UpdateDeviceMetadataInput, optFns ...func(*Options)) (*UpdateDeviceMetadataOutput, error)

Updates a device's metadata.

type CreateApplicationInstanceInput

type CreateApplicationInstanceInput struct {

	// A device's ID.
	//
	// This member is required.
	DefaultRuntimeContextDevice *string

	// The application's manifest document.
	//
	// This member is required.
	ManifestPayload types.ManifestPayload

	// The ID of an application instance to replace with the new instance.
	ApplicationInstanceIdToReplace *string

	// A description for the application instance.
	Description *string

	// Setting overrides for the application manifest.
	ManifestOverridesPayload types.ManifestOverridesPayload

	// A name for the application instance.
	Name *string

	// The ARN of a runtime role for the application instance.
	RuntimeRoleArn *string

	// Tags for the application instance.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateApplicationInstanceOutput

type CreateApplicationInstanceOutput struct {

	// The application instance's ID.
	//
	// This member is required.
	ApplicationInstanceId *string

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

type CreateJobForDevicesInput

type CreateJobForDevicesInput struct {

	// ID of target device.
	//
	// This member is required.
	DeviceIds []string

	// The type of job to run.
	//
	// This member is required.
	JobType types.JobType

	// Configuration settings for a software update job.
	DeviceJobConfig *types.DeviceJobConfig
	// contains filtered or unexported fields
}

type CreateJobForDevicesOutput

type CreateJobForDevicesOutput struct {

	// A list of jobs.
	//
	// This member is required.
	Jobs []types.Job

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

type CreateNodeFromTemplateJobInput

type CreateNodeFromTemplateJobInput struct {

	// A name for the node.
	//
	// This member is required.
	NodeName *string

	// An output package name for the node.
	//
	// This member is required.
	OutputPackageName *string

	// An output package version for the node.
	//
	// This member is required.
	OutputPackageVersion *string

	// Template parameters for the node.
	//
	// This member is required.
	TemplateParameters map[string]string

	// The type of node.
	//
	// This member is required.
	TemplateType types.TemplateType

	// Tags for the job.
	JobTags []types.JobResourceTags

	// A description for the node.
	NodeDescription *string
	// contains filtered or unexported fields
}

type CreateNodeFromTemplateJobOutput

type CreateNodeFromTemplateJobOutput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string

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

type CreatePackageImportJobInput

type CreatePackageImportJobInput struct {

	// A client token for the package import job.
	//
	// This member is required.
	ClientToken *string

	// An input config for the package import job.
	//
	// This member is required.
	InputConfig *types.PackageImportJobInputConfig

	// A job type for the package import job.
	//
	// This member is required.
	JobType types.PackageImportJobType

	// An output config for the package import job.
	//
	// This member is required.
	OutputConfig *types.PackageImportJobOutputConfig

	// Tags for the package import job.
	JobTags []types.JobResourceTags
	// contains filtered or unexported fields
}

type CreatePackageImportJobOutput

type CreatePackageImportJobOutput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string

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

type CreatePackageInput

type CreatePackageInput struct {

	// A name for the package.
	//
	// This member is required.
	PackageName *string

	// Tags for the package.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreatePackageOutput

type CreatePackageOutput struct {

	// The package's storage location.
	//
	// This member is required.
	StorageLocation *types.StorageLocation

	// The package's ARN.
	Arn *string

	// The package's ID.
	PackageId *string

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

type DeleteDeviceInput

type DeleteDeviceInput struct {

	// The device's ID.
	//
	// This member is required.
	DeviceId *string
	// contains filtered or unexported fields
}

type DeleteDeviceOutput

type DeleteDeviceOutput struct {

	// The device's ID.
	DeviceId *string

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

type DeletePackageInput

type DeletePackageInput struct {

	// The package's ID.
	//
	// This member is required.
	PackageId *string

	// Delete the package even if it has artifacts stored in its access point. Deletes
	// the package's artifacts from Amazon S3.
	ForceDelete bool
	// contains filtered or unexported fields
}

type DeletePackageOutput

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

type DeregisterPackageVersionInput

type DeregisterPackageVersionInput struct {

	// A package ID.
	//
	// This member is required.
	PackageId *string

	// A package version.
	//
	// This member is required.
	PackageVersion *string

	// A patch version.
	//
	// This member is required.
	PatchVersion *string

	// An owner account.
	OwnerAccount *string

	// If the version was marked latest, the new version to maker as latest.
	UpdatedLatestPatchVersion *string
	// contains filtered or unexported fields
}

type DeregisterPackageVersionOutput

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

type DescribeApplicationInstanceDetailsInput

type DescribeApplicationInstanceDetailsInput struct {

	// The application instance's ID.
	//
	// This member is required.
	ApplicationInstanceId *string
	// contains filtered or unexported fields
}

type DescribeApplicationInstanceDetailsOutput

type DescribeApplicationInstanceDetailsOutput struct {

	// The application instance's ID.
	ApplicationInstanceId *string

	// The ID of the application instance that this instance replaced.
	ApplicationInstanceIdToReplace *string

	// When the application instance was created.
	CreatedTime *time.Time

	// The application instance's default runtime context device.
	DefaultRuntimeContextDevice *string

	// The application instance's description.
	Description *string

	// Parameter overrides for the configuration manifest.
	ManifestOverridesPayload types.ManifestOverridesPayload

	// The application instance's configuration manifest.
	ManifestPayload types.ManifestPayload

	// The application instance's name.
	Name *string

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

type DescribeApplicationInstanceInput

type DescribeApplicationInstanceInput struct {

	// The application instance's ID.
	//
	// This member is required.
	ApplicationInstanceId *string
	// contains filtered or unexported fields
}

type DescribeApplicationInstanceOutput

type DescribeApplicationInstanceOutput struct {

	// The application instance's ID.
	ApplicationInstanceId *string

	// The ID of the application instance that this instance replaced.
	ApplicationInstanceIdToReplace *string

	// The application instance's ARN.
	Arn *string

	// When the application instance was created.
	CreatedTime *time.Time

	// The device's ID.
	DefaultRuntimeContextDevice *string

	// The device's bane.
	DefaultRuntimeContextDeviceName *string

	// The application instance's description.
	Description *string

	// The application instance's health status.
	HealthStatus types.ApplicationInstanceHealthStatus

	// The application instance was updated.
	LastUpdatedTime *time.Time

	// The application instance's name.
	Name *string

	// The application instance's state.
	RuntimeContextStates []types.ReportedRuntimeContextState

	// The application instance's runtime role ARN.
	RuntimeRoleArn *string

	// The application instance's status.
	Status types.ApplicationInstanceStatus

	// The application instance's status description.
	StatusDescription *string

	// The application instance's tags.
	Tags map[string]string

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

type DescribeDeviceInput

type DescribeDeviceInput struct {

	// The device's ID.
	//
	// This member is required.
	DeviceId *string
	// contains filtered or unexported fields
}

type DescribeDeviceJobInput

type DescribeDeviceJobInput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeDeviceJobOutput

type DescribeDeviceJobOutput struct {

	// When the job was created.
	CreatedTime *time.Time

	// The device's ARN.
	DeviceArn *string

	// The device's ID.
	DeviceId *string

	// The device's name.
	DeviceName *string

	// The device's type.
	DeviceType types.DeviceType

	// For an OTA job, the target version of the device software.
	ImageVersion *string

	// The job's ID.
	JobId *string

	// The job's type.
	JobType types.JobType

	// The job's status.
	Status types.UpdateProgress

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

type DescribeDeviceOutput

type DescribeDeviceOutput struct {

	// Beta software releases available for the device.
	AlternateSoftwares []types.AlternateSoftwareMetadata

	// The device's ARN.
	Arn *string

	// The device's maker.
	Brand types.DeviceBrand

	// When the device was created.
	CreatedTime *time.Time

	// The device's networking status.
	CurrentNetworkingStatus *types.NetworkStatus

	// The device's current software version.
	CurrentSoftware *string

	// The device's description.
	Description *string

	// A device's aggregated status. Including the device's connection status,
	// provisioning status, and lease status.
	DeviceAggregatedStatus types.DeviceAggregatedStatus

	// The device's connection status.
	DeviceConnectionStatus types.DeviceConnectionStatus

	// The device's ID.
	DeviceId *string

	// The most recent beta software release.
	LatestAlternateSoftware *string

	// A device's latest job. Includes the target image version, and the job status.
	LatestDeviceJob *types.LatestDeviceJob

	// The latest software version available for the device.
	LatestSoftware *string

	// The device's lease expiration time.
	LeaseExpirationTime *time.Time

	// The device's name.
	Name *string

	// The device's networking configuration.
	NetworkingConfiguration *types.NetworkPayload

	// The device's provisioning status.
	ProvisioningStatus types.DeviceStatus

	// The device's serial number.
	SerialNumber *string

	// The device's tags.
	Tags map[string]string

	// The device's type.
	Type types.DeviceType

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

type DescribeNodeFromTemplateJobInput

type DescribeNodeFromTemplateJobInput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribeNodeFromTemplateJobOutput

type DescribeNodeFromTemplateJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The job's ID.
	//
	// This member is required.
	JobId *string

	// When the job was updated.
	//
	// This member is required.
	LastUpdatedTime *time.Time

	// The node's name.
	//
	// This member is required.
	NodeName *string

	// The job's output package name.
	//
	// This member is required.
	OutputPackageName *string

	// The job's output package version.
	//
	// This member is required.
	OutputPackageVersion *string

	// The job's status.
	//
	// This member is required.
	Status types.NodeFromTemplateJobStatus

	// The job's status message.
	//
	// This member is required.
	StatusMessage *string

	// The job's template parameters.
	//
	// This member is required.
	TemplateParameters map[string]string

	// The job's template type.
	//
	// This member is required.
	TemplateType types.TemplateType

	// The job's tags.
	JobTags []types.JobResourceTags

	// The node's description.
	NodeDescription *string

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

type DescribeNodeInput

type DescribeNodeInput struct {

	// The node's ID.
	//
	// This member is required.
	NodeId *string

	// The account ID of the node's owner.
	OwnerAccount *string
	// contains filtered or unexported fields
}

type DescribeNodeOutput

type DescribeNodeOutput struct {

	// The node's category.
	//
	// This member is required.
	Category types.NodeCategory

	// When the node was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The node's description.
	//
	// This member is required.
	Description *string

	// When the node was updated.
	//
	// This member is required.
	LastUpdatedTime *time.Time

	// The node's name.
	//
	// This member is required.
	Name *string

	// The node's ID.
	//
	// This member is required.
	NodeId *string

	// The node's interface.
	//
	// This member is required.
	NodeInterface *types.NodeInterface

	// The account ID of the node's owner.
	//
	// This member is required.
	OwnerAccount *string

	// The node's package ID.
	//
	// This member is required.
	PackageId *string

	// The node's package name.
	//
	// This member is required.
	PackageName *string

	// The node's package version.
	//
	// This member is required.
	PackageVersion *string

	// The node's patch version.
	//
	// This member is required.
	PatchVersion *string

	// The node's asset name.
	AssetName *string

	// The node's ARN.
	PackageArn *string

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

type DescribePackageImportJobInput

type DescribePackageImportJobInput struct {

	// The job's ID.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DescribePackageImportJobOutput

type DescribePackageImportJobOutput struct {

	// When the job was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The job's input config.
	//
	// This member is required.
	InputConfig *types.PackageImportJobInputConfig

	// The job's ID.
	//
	// This member is required.
	JobId *string

	// The job's type.
	//
	// This member is required.
	JobType types.PackageImportJobType

	// When the job was updated.
	//
	// This member is required.
	LastUpdatedTime *time.Time

	// The job's output.
	//
	// This member is required.
	Output *types.PackageImportJobOutput

	// The job's output config.
	//
	// This member is required.
	OutputConfig *types.PackageImportJobOutputConfig

	// The job's status.
	//
	// This member is required.
	Status types.PackageImportJobStatus

	// The job's status message.
	//
	// This member is required.
	StatusMessage *string

	// The job's client token.
	ClientToken *string

	// The job's tags.
	JobTags []types.JobResourceTags

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

type DescribePackageInput

type DescribePackageInput struct {

	// The package's ID.
	//
	// This member is required.
	PackageId *string
	// contains filtered or unexported fields
}

type DescribePackageOutput

type DescribePackageOutput struct {

	// The package's ARN.
	//
	// This member is required.
	Arn *string

	// When the package was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The package's ID.
	//
	// This member is required.
	PackageId *string

	// The package's name.
	//
	// This member is required.
	PackageName *string

	// The package's storage location.
	//
	// This member is required.
	StorageLocation *types.StorageLocation

	// The package's tags.
	//
	// This member is required.
	Tags map[string]string

	// ARNs of accounts that have read access to the package.
	ReadAccessPrincipalArns []string

	// ARNs of accounts that have write access to the package.
	WriteAccessPrincipalArns []string

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

type DescribePackageVersionInput

type DescribePackageVersionInput struct {

	// The version's ID.
	//
	// This member is required.
	PackageId *string

	// The version's version.
	//
	// This member is required.
	PackageVersion *string

	// The version's owner account.
	OwnerAccount *string

	// The version's patch version.
	PatchVersion *string
	// contains filtered or unexported fields
}

type DescribePackageVersionOutput

type DescribePackageVersionOutput struct {

	// Whether the version is the latest available.
	//
	// This member is required.
	IsLatestPatch bool

	// The version's ID.
	//
	// This member is required.
	PackageId *string

	// The version's name.
	//
	// This member is required.
	PackageName *string

	// The version's version.
	//
	// This member is required.
	PackageVersion *string

	// The version's patch version.
	//
	// This member is required.
	PatchVersion *string

	// The version's status.
	//
	// This member is required.
	Status types.PackageVersionStatus

	// The account ID of the version's owner.
	OwnerAccount *string

	// The ARN of the package.
	PackageArn *string

	// The version's registered time.
	RegisteredTime *time.Time

	// The version's status description.
	StatusDescription *string

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

type EndpointParameters added in v1.12.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.12.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

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

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

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.12.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.12.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

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 ListApplicationInstanceDependenciesAPIClient

type ListApplicationInstanceDependenciesAPIClient interface {
	ListApplicationInstanceDependencies(context.Context, *ListApplicationInstanceDependenciesInput, ...func(*Options)) (*ListApplicationInstanceDependenciesOutput, error)
}

ListApplicationInstanceDependenciesAPIClient is a client that implements the ListApplicationInstanceDependencies operation.

type ListApplicationInstanceDependenciesInput

type ListApplicationInstanceDependenciesInput struct {

	// The application instance's ID.
	//
	// This member is required.
	ApplicationInstanceId *string

	// The maximum number of application instance dependencies to return in one page
	// of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListApplicationInstanceDependenciesOutput

type ListApplicationInstanceDependenciesOutput struct {

	// A pagination token that's included if more results are available.
	NextToken *string

	// A list of package objects.
	PackageObjects []types.PackageObject

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

type ListApplicationInstanceDependenciesPaginator

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

ListApplicationInstanceDependenciesPaginator is a paginator for ListApplicationInstanceDependencies

func NewListApplicationInstanceDependenciesPaginator

NewListApplicationInstanceDependenciesPaginator returns a new ListApplicationInstanceDependenciesPaginator

func (*ListApplicationInstanceDependenciesPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationInstanceDependenciesPaginator) NextPage

NextPage retrieves the next ListApplicationInstanceDependencies page.

type ListApplicationInstanceDependenciesPaginatorOptions

type ListApplicationInstanceDependenciesPaginatorOptions struct {
	// The maximum number of application instance dependencies to return in one page
	// of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListApplicationInstanceDependenciesPaginatorOptions is the paginator options for ListApplicationInstanceDependencies

type ListApplicationInstanceNodeInstancesAPIClient

type ListApplicationInstanceNodeInstancesAPIClient interface {
	ListApplicationInstanceNodeInstances(context.Context, *ListApplicationInstanceNodeInstancesInput, ...func(*Options)) (*ListApplicationInstanceNodeInstancesOutput, error)
}

ListApplicationInstanceNodeInstancesAPIClient is a client that implements the ListApplicationInstanceNodeInstances operation.

type ListApplicationInstanceNodeInstancesInput

type ListApplicationInstanceNodeInstancesInput struct {

	// The node instances' application instance ID.
	//
	// This member is required.
	ApplicationInstanceId *string

	// The maximum number of node instances to return in one page of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListApplicationInstanceNodeInstancesOutput

type ListApplicationInstanceNodeInstancesOutput struct {

	// A pagination token that's included if more results are available.
	NextToken *string

	// A list of node instances.
	NodeInstances []types.NodeInstance

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

type ListApplicationInstanceNodeInstancesPaginator

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

ListApplicationInstanceNodeInstancesPaginator is a paginator for ListApplicationInstanceNodeInstances

func NewListApplicationInstanceNodeInstancesPaginator

NewListApplicationInstanceNodeInstancesPaginator returns a new ListApplicationInstanceNodeInstancesPaginator

func (*ListApplicationInstanceNodeInstancesPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationInstanceNodeInstancesPaginator) NextPage

NextPage retrieves the next ListApplicationInstanceNodeInstances page.

type ListApplicationInstanceNodeInstancesPaginatorOptions

type ListApplicationInstanceNodeInstancesPaginatorOptions struct {
	// The maximum number of node instances to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListApplicationInstanceNodeInstancesPaginatorOptions is the paginator options for ListApplicationInstanceNodeInstances

type ListApplicationInstancesAPIClient

type ListApplicationInstancesAPIClient interface {
	ListApplicationInstances(context.Context, *ListApplicationInstancesInput, ...func(*Options)) (*ListApplicationInstancesOutput, error)
}

ListApplicationInstancesAPIClient is a client that implements the ListApplicationInstances operation.

type ListApplicationInstancesInput

type ListApplicationInstancesInput struct {

	// The application instances' device ID.
	DeviceId *string

	// The maximum number of application instances to return in one page of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string

	// Only include instances with a specific status.
	StatusFilter types.StatusFilter
	// contains filtered or unexported fields
}

type ListApplicationInstancesOutput

type ListApplicationInstancesOutput struct {

	// A list of application instances.
	ApplicationInstances []types.ApplicationInstance

	// A pagination token that's included if more results are available.
	NextToken *string

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

type ListApplicationInstancesPaginator

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

ListApplicationInstancesPaginator is a paginator for ListApplicationInstances

func NewListApplicationInstancesPaginator

NewListApplicationInstancesPaginator returns a new ListApplicationInstancesPaginator

func (*ListApplicationInstancesPaginator) HasMorePages

func (p *ListApplicationInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListApplicationInstancesPaginator) NextPage

NextPage retrieves the next ListApplicationInstances page.

type ListApplicationInstancesPaginatorOptions

type ListApplicationInstancesPaginatorOptions struct {
	// The maximum number of application instances to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListApplicationInstancesPaginatorOptions is the paginator options for ListApplicationInstances

type ListDevicesAPIClient

type ListDevicesAPIClient interface {
	ListDevices(context.Context, *ListDevicesInput, ...func(*Options)) (*ListDevicesOutput, error)
}

ListDevicesAPIClient is a client that implements the ListDevices operation.

type ListDevicesInput

type ListDevicesInput struct {

	// Filter based on a device's status.
	DeviceAggregatedStatusFilter types.DeviceAggregatedStatus

	// The maximum number of devices to return in one page of results.
	MaxResults int32

	// Filter based on device's name. Prefixes supported.
	NameFilter *string

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string

	// The target column to be sorted on. Default column sort is CREATED_TIME.
	SortBy types.ListDevicesSortBy

	// The sorting order for the returned list. SortOrder is DESCENDING by default
	// based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListDevicesJobsAPIClient

type ListDevicesJobsAPIClient interface {
	ListDevicesJobs(context.Context, *ListDevicesJobsInput, ...func(*Options)) (*ListDevicesJobsOutput, error)
}

ListDevicesJobsAPIClient is a client that implements the ListDevicesJobs operation.

type ListDevicesJobsInput

type ListDevicesJobsInput struct {

	// Filter results by the job's target device ID.
	DeviceId *string

	// The maximum number of device jobs to return in one page of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDevicesJobsOutput

type ListDevicesJobsOutput struct {

	// A list of jobs.
	DeviceJobs []types.DeviceJob

	// A pagination token that's included if more results are available.
	NextToken *string

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

type ListDevicesJobsPaginator

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

ListDevicesJobsPaginator is a paginator for ListDevicesJobs

func NewListDevicesJobsPaginator

func NewListDevicesJobsPaginator(client ListDevicesJobsAPIClient, params *ListDevicesJobsInput, optFns ...func(*ListDevicesJobsPaginatorOptions)) *ListDevicesJobsPaginator

NewListDevicesJobsPaginator returns a new ListDevicesJobsPaginator

func (*ListDevicesJobsPaginator) HasMorePages

func (p *ListDevicesJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevicesJobsPaginator) NextPage

func (p *ListDevicesJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevicesJobsOutput, error)

NextPage retrieves the next ListDevicesJobs page.

type ListDevicesJobsPaginatorOptions

type ListDevicesJobsPaginatorOptions struct {
	// The maximum number of device jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDevicesJobsPaginatorOptions is the paginator options for ListDevicesJobs

type ListDevicesOutput

type ListDevicesOutput struct {

	// A list of devices.
	//
	// This member is required.
	Devices []types.Device

	// A pagination token that's included if more results are available.
	NextToken *string

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

type ListDevicesPaginator

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

ListDevicesPaginator is a paginator for ListDevices

func NewListDevicesPaginator

func NewListDevicesPaginator(client ListDevicesAPIClient, params *ListDevicesInput, optFns ...func(*ListDevicesPaginatorOptions)) *ListDevicesPaginator

NewListDevicesPaginator returns a new ListDevicesPaginator

func (*ListDevicesPaginator) HasMorePages

func (p *ListDevicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevicesPaginator) NextPage

func (p *ListDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevicesOutput, error)

NextPage retrieves the next ListDevices page.

type ListDevicesPaginatorOptions

type ListDevicesPaginatorOptions struct {
	// The maximum number of devices to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDevicesPaginatorOptions is the paginator options for ListDevices

type ListNodeFromTemplateJobsAPIClient

type ListNodeFromTemplateJobsAPIClient interface {
	ListNodeFromTemplateJobs(context.Context, *ListNodeFromTemplateJobsInput, ...func(*Options)) (*ListNodeFromTemplateJobsOutput, error)
}

ListNodeFromTemplateJobsAPIClient is a client that implements the ListNodeFromTemplateJobs operation.

type ListNodeFromTemplateJobsInput

type ListNodeFromTemplateJobsInput struct {

	// The maximum number of node from template jobs to return in one page of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNodeFromTemplateJobsOutput

type ListNodeFromTemplateJobsOutput struct {

	// A list of jobs.
	//
	// This member is required.
	NodeFromTemplateJobs []types.NodeFromTemplateJob

	// A pagination token that's included if more results are available.
	NextToken *string

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

type ListNodeFromTemplateJobsPaginator

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

ListNodeFromTemplateJobsPaginator is a paginator for ListNodeFromTemplateJobs

func NewListNodeFromTemplateJobsPaginator

NewListNodeFromTemplateJobsPaginator returns a new ListNodeFromTemplateJobsPaginator

func (*ListNodeFromTemplateJobsPaginator) HasMorePages

func (p *ListNodeFromTemplateJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNodeFromTemplateJobsPaginator) NextPage

NextPage retrieves the next ListNodeFromTemplateJobs page.

type ListNodeFromTemplateJobsPaginatorOptions

type ListNodeFromTemplateJobsPaginatorOptions struct {
	// The maximum number of node from template jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNodeFromTemplateJobsPaginatorOptions is the paginator options for ListNodeFromTemplateJobs

type ListNodesAPIClient

type ListNodesAPIClient interface {
	ListNodes(context.Context, *ListNodesInput, ...func(*Options)) (*ListNodesOutput, error)
}

ListNodesAPIClient is a client that implements the ListNodes operation.

type ListNodesInput

type ListNodesInput struct {

	// Search for nodes by category.
	Category types.NodeCategory

	// The maximum number of nodes to return in one page of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string

	// Search for nodes by the account ID of the nodes' owner.
	OwnerAccount *string

	// Search for nodes by name.
	PackageName *string

	// Search for nodes by version.
	PackageVersion *string

	// Search for nodes by patch version.
	PatchVersion *string
	// contains filtered or unexported fields
}

type ListNodesOutput

type ListNodesOutput struct {

	// A pagination token that's included if more results are available.
	NextToken *string

	// A list of nodes.
	Nodes []types.Node

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

type ListNodesPaginator

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

ListNodesPaginator is a paginator for ListNodes

func NewListNodesPaginator

func NewListNodesPaginator(client ListNodesAPIClient, params *ListNodesInput, optFns ...func(*ListNodesPaginatorOptions)) *ListNodesPaginator

NewListNodesPaginator returns a new ListNodesPaginator

func (*ListNodesPaginator) HasMorePages

func (p *ListNodesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNodesPaginator) NextPage

func (p *ListNodesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNodesOutput, error)

NextPage retrieves the next ListNodes page.

type ListNodesPaginatorOptions

type ListNodesPaginatorOptions struct {
	// The maximum number of nodes to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNodesPaginatorOptions is the paginator options for ListNodes

type ListPackageImportJobsAPIClient

type ListPackageImportJobsAPIClient interface {
	ListPackageImportJobs(context.Context, *ListPackageImportJobsInput, ...func(*Options)) (*ListPackageImportJobsOutput, error)
}

ListPackageImportJobsAPIClient is a client that implements the ListPackageImportJobs operation.

type ListPackageImportJobsInput

type ListPackageImportJobsInput struct {

	// The maximum number of package import jobs to return in one page of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPackageImportJobsOutput

type ListPackageImportJobsOutput struct {

	// A list of package import jobs.
	//
	// This member is required.
	PackageImportJobs []types.PackageImportJob

	// A pagination token that's included if more results are available.
	NextToken *string

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

type ListPackageImportJobsPaginator

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

ListPackageImportJobsPaginator is a paginator for ListPackageImportJobs

func NewListPackageImportJobsPaginator

NewListPackageImportJobsPaginator returns a new ListPackageImportJobsPaginator

func (*ListPackageImportJobsPaginator) HasMorePages

func (p *ListPackageImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackageImportJobsPaginator) NextPage

NextPage retrieves the next ListPackageImportJobs page.

type ListPackageImportJobsPaginatorOptions

type ListPackageImportJobsPaginatorOptions struct {
	// The maximum number of package import jobs to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackageImportJobsPaginatorOptions is the paginator options for ListPackageImportJobs

type ListPackagesAPIClient

type ListPackagesAPIClient interface {
	ListPackages(context.Context, *ListPackagesInput, ...func(*Options)) (*ListPackagesOutput, error)
}

ListPackagesAPIClient is a client that implements the ListPackages operation.

type ListPackagesInput

type ListPackagesInput struct {

	// The maximum number of packages to return in one page of results.
	MaxResults int32

	// Specify the pagination token from a previous request to retrieve the next page
	// of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPackagesOutput

type ListPackagesOutput struct {

	// A pagination token that's included if more results are available.
	NextToken *string

	// A list of packages.
	Packages []types.PackageListItem

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

type ListPackagesPaginator

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

ListPackagesPaginator is a paginator for ListPackages

func NewListPackagesPaginator

func NewListPackagesPaginator(client ListPackagesAPIClient, params *ListPackagesInput, optFns ...func(*ListPackagesPaginatorOptions)) *ListPackagesPaginator

NewListPackagesPaginator returns a new ListPackagesPaginator

func (*ListPackagesPaginator) HasMorePages

func (p *ListPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPackagesPaginator) NextPage

func (p *ListPackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPackagesOutput, error)

NextPage retrieves the next ListPackages page.

type ListPackagesPaginatorOptions

type ListPackagesPaginatorOptions struct {
	// The maximum number of packages to return in one page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPackagesPaginatorOptions is the paginator options for ListPackages

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The resource's ARN.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// A list of tags.
	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 client meter provider.
	MeterProvider metrics.MeterProvider

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.15.2

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

type ProvisionDeviceInput

type ProvisionDeviceInput struct {

	// A name for the device.
	//
	// This member is required.
	Name *string

	// A description for the device.
	Description *string

	// A networking configuration for the device.
	NetworkingConfiguration *types.NetworkPayload

	// Tags for the device.
	Tags map[string]string
	// contains filtered or unexported fields
}

type ProvisionDeviceOutput

type ProvisionDeviceOutput struct {

	// The device's ARN.
	//
	// This member is required.
	Arn *string

	// The device's status.
	//
	// This member is required.
	Status types.DeviceStatus

	// The device's configuration bundle.
	Certificates []byte

	// The device's ID.
	DeviceId *string

	// The device's IoT thing name.
	IotThingName *string

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

type RegisterPackageVersionInput

type RegisterPackageVersionInput struct {

	// A package ID.
	//
	// This member is required.
	PackageId *string

	// A package version.
	//
	// This member is required.
	PackageVersion *string

	// A patch version.
	//
	// This member is required.
	PatchVersion *string

	// Whether to mark the new version as the latest version.
	MarkLatest bool

	// An owner account.
	OwnerAccount *string
	// contains filtered or unexported fields
}

type RegisterPackageVersionOutput

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

type RemoveApplicationInstanceInput

type RemoveApplicationInstanceInput struct {

	// An application instance ID.
	//
	// This member is required.
	ApplicationInstanceId *string
	// contains filtered or unexported fields
}

type RemoveApplicationInstanceOutput

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type SignalApplicationInstanceNodeInstancesInput added in v1.9.0

type SignalApplicationInstanceNodeInstancesInput struct {

	// An application instance ID.
	//
	// This member is required.
	ApplicationInstanceId *string

	// A list of signals.
	//
	// This member is required.
	NodeSignals []types.NodeSignal
	// contains filtered or unexported fields
}

type SignalApplicationInstanceNodeInstancesOutput added in v1.9.0

type SignalApplicationInstanceNodeInstancesOutput struct {

	// An application instance ID.
	//
	// This member is required.
	ApplicationInstanceId *string

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

type TagResourceInput

type TagResourceInput struct {

	// The resource's ARN.
	//
	// This member is required.
	ResourceArn *string

	// Tags for the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

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

type UntagResourceInput

type UntagResourceInput struct {

	// The resource's ARN.
	//
	// This member is required.
	ResourceArn *string

	// Tag keys to remove.
	//
	// 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 UpdateDeviceMetadataInput

type UpdateDeviceMetadataInput struct {

	// The device's ID.
	//
	// This member is required.
	DeviceId *string

	// A description for the device.
	Description *string
	// contains filtered or unexported fields
}

type UpdateDeviceMetadataOutput

type UpdateDeviceMetadataOutput struct {

	// The device's ID.
	DeviceId *string

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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