ssm

package module
v0.26.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2014-11-06"
View Source
const ServiceID = "SSM"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

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

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AddTagsToResourceInput

type AddTagsToResourceInput struct {
	// Specifies the type of resource you are tagging. The ManagedInstance type for
	// this API action is for on-premises managed instances. You must specify the name
	// of the managed instance in the following format: mi-ID_number. For example,
	// mi-1a2b3c4d5e6f.
	ResourceType types.ResourceTypeForTagging
	// One or more tags. The value parameter is required, but if you don't want the tag
	// to have a value, specify the parameter with no value, and we set the value to an
	// empty string. Do not enter personally identifiable information in this field.
	Tags []*types.Tag
	// The resource ID you want to tag. Use the ID of the resource. Here are some
	// examples: ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde
	// PatchBaseline: pb-012345abcde For the Document and Parameter values, use the
	// name of the resource. The ManagedInstance type for this API action is only for
	// on-premises managed instances. You must specify the name of the managed instance
	// in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
	ResourceId *string
}

type AddTagsToResourceOutput

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

type CancelCommandInput

type CancelCommandInput struct {
	// (Optional) A list of instance IDs on which you want to cancel the command. If
	// not provided, the command is canceled on every instance on which it was
	// requested.
	InstanceIds []*string
	// The ID of the command you want to cancel.
	CommandId *string
}

type CancelCommandOutput

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

Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.

type CancelMaintenanceWindowExecutionInput

type CancelMaintenanceWindowExecutionInput struct {
	// The ID of the maintenance window execution to stop.
	WindowExecutionId *string
}

type CancelMaintenanceWindowExecutionOutput

type CancelMaintenanceWindowExecutionOutput struct {
	// The ID of the maintenance window execution that has been stopped.
	WindowExecutionId *string

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

type Client

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

AWS Systems Manager AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager. This reference is intended to be used with the AWS Systems Manager User Guide (https://docs.aws.amazon.com/systems-manager/latest/userguide/). To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html) in the AWS Systems Manager User Guide. For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/). For information about how to use a Query API, see Making API requests (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/making-api-requests.html).

func New

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

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

func NewFromConfig

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

NewFromConfig returns a new client from the provided config.

func (*Client) AddTagsToResource

func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. <p>Each resource can have a maximum of 50 tags. </p> <p>We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters. For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the Amazon EC2 User Guide.

func (*Client) CancelCommand

func (c *Client) CancelCommand(ctx context.Context, params *CancelCommandInput, optFns ...func(*Options)) (*CancelCommandOutput, error)

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

func (*Client) CancelMaintenanceWindowExecution

func (c *Client) CancelMaintenanceWindowExecution(ctx context.Context, params *CancelMaintenanceWindowExecutionInput, optFns ...func(*Options)) (*CancelMaintenanceWindowExecutionOutput, error)

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)

func (*Client) CreateActivation

func (c *Client) CreateActivation(ctx context.Context, params *CreateActivationInput, optFns ...func(*Options)) (*CreateActivationOutput, error)

Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) in the AWS Systems Manager User Guide. On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.

func (*Client) CreateAssociation

func (c *Client) CreateAssociation(ctx context.Context, params *CreateAssociationInput, optFns ...func(*Options)) (*CreateAssociationOutput, error)

A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.

func (*Client) CreateAssociationBatch

func (c *Client) CreateAssociationBatch(ctx context.Context, params *CreateAssociationBatchInput, optFns ...func(*Options)) (*CreateAssociationBatchOutput, error)

Associates the specified Systems Manager document with the specified instances or targets. When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified. If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

func (*Client) CreateDocument

func (c *Client) CreateDocument(ctx context.Context, params *CreateDocumentInput, optFns ...func(*Options)) (*CreateDocumentOutput, error)

Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html) in the AWS Systems Manager User Guide.

func (*Client) CreateMaintenanceWindow

func (c *Client) CreateMaintenanceWindow(ctx context.Context, params *CreateMaintenanceWindowInput, optFns ...func(*Options)) (*CreateMaintenanceWindowOutput, error)

Creates a new maintenance window. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

func (*Client) CreateOpsItem

func (c *Client) CreateOpsItem(ctx context.Context, params *CreateOpsItemInput, optFns ...func(*Options)) (*CreateOpsItemOutput, error)

Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

func (*Client) CreatePatchBaseline

func (c *Client) CreatePatchBaseline(ctx context.Context, params *CreatePatchBaselineInput, optFns ...func(*Options)) (*CreatePatchBaselineOutput, error)

Creates a patch baseline. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter (http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html).

func (*Client) CreateResourceDataSync

func (c *Client) CreateResourceDataSync(ctx context.Context, params *CreateResourceDataSyncInput, optFns ...func(*Options)) (*CreateResourceDataSyncOutput, error)

A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring Resource Data Sync for Inventory (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html) in the AWS Systems Manager User Guide. <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization by using AWS Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions (https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) in the AWS Systems Manager User Guide. <p>A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync (). <note> <p>By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </p> </note>

func (*Client) DeleteActivation

func (c *Client) DeleteActivation(ctx context.Context, params *DeleteActivationInput, optFns ...func(*Options)) (*DeleteActivationOutput, error)

Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

func (*Client) DeleteAssociation

func (c *Client) DeleteAssociation(ctx context.Context, params *DeleteAssociationInput, optFns ...func(*Options)) (*DeleteAssociationOutput, error)

Disassociates the specified Systems Manager document from the specified instance. When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

func (*Client) DeleteDocument

func (c *Client) DeleteDocument(ctx context.Context, params *DeleteDocumentInput, optFns ...func(*Options)) (*DeleteDocumentOutput, error)

Deletes the Systems Manager document and all instance associations to the document. Before you delete the document, we recommend that you use DeleteAssociation () to disassociate all instances that are associated with the document.

func (*Client) DeleteInventory

func (c *Client) DeleteInventory(ctx context.Context, params *DeleteInventoryInput, optFns ...func(*Options)) (*DeleteInventoryOutput, error)

Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

func (*Client) DeleteMaintenanceWindow

func (c *Client) DeleteMaintenanceWindow(ctx context.Context, params *DeleteMaintenanceWindowInput, optFns ...func(*Options)) (*DeleteMaintenanceWindowOutput, error)

Deletes a maintenance window.

func (*Client) DeleteParameter

func (c *Client) DeleteParameter(ctx context.Context, params *DeleteParameterInput, optFns ...func(*Options)) (*DeleteParameterOutput, error)

Delete a parameter from the system.

func (*Client) DeleteParameters

func (c *Client) DeleteParameters(ctx context.Context, params *DeleteParametersInput, optFns ...func(*Options)) (*DeleteParametersOutput, error)

Delete a list of parameters.

func (*Client) DeletePatchBaseline

func (c *Client) DeletePatchBaseline(ctx context.Context, params *DeletePatchBaselineInput, optFns ...func(*Options)) (*DeletePatchBaselineOutput, error)

Deletes a patch baseline.

func (*Client) DeleteResourceDataSync

func (c *Client) DeleteResourceDataSync(ctx context.Context, params *DeleteResourceDataSyncInput, optFns ...func(*Options)) (*DeleteResourceDataSyncOutput, error)

Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.

func (*Client) DeregisterManagedInstance

func (c *Client) DeregisterManagedInstance(ctx context.Context, params *DeregisterManagedInstanceInput, optFns ...func(*Options)) (*DeregisterManagedInstanceOutput, error)

Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.

func (*Client) DeregisterPatchBaselineForPatchGroup

func (c *Client) DeregisterPatchBaselineForPatchGroup(ctx context.Context, params *DeregisterPatchBaselineForPatchGroupInput, optFns ...func(*Options)) (*DeregisterPatchBaselineForPatchGroupOutput, error)

Removes a patch group from a patch baseline.

func (*Client) DeregisterTargetFromMaintenanceWindow

func (c *Client) DeregisterTargetFromMaintenanceWindow(ctx context.Context, params *DeregisterTargetFromMaintenanceWindowInput, optFns ...func(*Options)) (*DeregisterTargetFromMaintenanceWindowOutput, error)

Removes a target from a maintenance window.

func (*Client) DeregisterTaskFromMaintenanceWindow

func (c *Client) DeregisterTaskFromMaintenanceWindow(ctx context.Context, params *DeregisterTaskFromMaintenanceWindowInput, optFns ...func(*Options)) (*DeregisterTaskFromMaintenanceWindowOutput, error)

Removes a task from a maintenance window.

func (*Client) DescribeActivations

func (c *Client) DescribeActivations(ctx context.Context, params *DescribeActivationsInput, optFns ...func(*Options)) (*DescribeActivationsOutput, error)

Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.

func (*Client) DescribeAssociation

func (c *Client) DescribeAssociation(ctx context.Context, params *DescribeAssociationInput, optFns ...func(*Options)) (*DescribeAssociationOutput, error)

Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.

func (*Client) DescribeAssociationExecutionTargets

func (c *Client) DescribeAssociationExecutionTargets(ctx context.Context, params *DescribeAssociationExecutionTargetsInput, optFns ...func(*Options)) (*DescribeAssociationExecutionTargetsOutput, error)

Use this API action to view information about a specific execution of a specific association.

func (*Client) DescribeAssociationExecutions

func (c *Client) DescribeAssociationExecutions(ctx context.Context, params *DescribeAssociationExecutionsInput, optFns ...func(*Options)) (*DescribeAssociationExecutionsOutput, error)

Use this API action to view all executions for a specific association ID.

func (*Client) DescribeAutomationExecutions

func (c *Client) DescribeAutomationExecutions(ctx context.Context, params *DescribeAutomationExecutionsInput, optFns ...func(*Options)) (*DescribeAutomationExecutionsOutput, error)

Provides details about all active and terminated Automation executions.

func (*Client) DescribeAutomationStepExecutions

func (c *Client) DescribeAutomationStepExecutions(ctx context.Context, params *DescribeAutomationStepExecutionsInput, optFns ...func(*Options)) (*DescribeAutomationStepExecutionsOutput, error)

Information about all active and terminated step executions in an Automation workflow.

func (*Client) DescribeAvailablePatches

func (c *Client) DescribeAvailablePatches(ctx context.Context, params *DescribeAvailablePatchesInput, optFns ...func(*Options)) (*DescribeAvailablePatchesOutput, error)

Lists all patches eligible to be included in a patch baseline.

func (*Client) DescribeDocument

func (c *Client) DescribeDocument(ctx context.Context, params *DescribeDocumentInput, optFns ...func(*Options)) (*DescribeDocumentOutput, error)

Describes the specified Systems Manager document.

func (*Client) DescribeDocumentPermission

func (c *Client) DescribeDocumentPermission(ctx context.Context, params *DescribeDocumentPermissionInput, optFns ...func(*Options)) (*DescribeDocumentPermissionOutput, error)

Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).

func (*Client) DescribeEffectiveInstanceAssociations

func (c *Client) DescribeEffectiveInstanceAssociations(ctx context.Context, params *DescribeEffectiveInstanceAssociationsInput, optFns ...func(*Options)) (*DescribeEffectiveInstanceAssociationsOutput, error)

All associations for the instance(s).

func (*Client) DescribeEffectivePatchesForPatchBaseline

func (c *Client) DescribeEffectivePatchesForPatchBaseline(ctx context.Context, params *DescribeEffectivePatchesForPatchBaselineInput, optFns ...func(*Options)) (*DescribeEffectivePatchesForPatchBaselineOutput, error)

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.

func (*Client) DescribeInstanceAssociationsStatus

func (c *Client) DescribeInstanceAssociationsStatus(ctx context.Context, params *DescribeInstanceAssociationsStatusInput, optFns ...func(*Options)) (*DescribeInstanceAssociationsStatusOutput, error)

The status of the associations for the instance(s).

func (*Client) DescribeInstanceInformation

func (c *Client) DescribeInstanceInformation(ctx context.Context, params *DescribeInstanceInformationInput, optFns ...func(*Options)) (*DescribeInstanceInformationOutput, error)

Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error. The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.

func (*Client) DescribeInstancePatchStates

func (c *Client) DescribeInstancePatchStates(ctx context.Context, params *DescribeInstancePatchStatesInput, optFns ...func(*Options)) (*DescribeInstancePatchStatesOutput, error)

Retrieves the high-level patch state of one or more instances.

func (*Client) DescribeInstancePatchStatesForPatchGroup

func (c *Client) DescribeInstancePatchStatesForPatchGroup(ctx context.Context, params *DescribeInstancePatchStatesForPatchGroupInput, optFns ...func(*Options)) (*DescribeInstancePatchStatesForPatchGroupOutput, error)

Retrieves the high-level patch state for the instances in the specified patch group.

func (*Client) DescribeInstancePatches

func (c *Client) DescribeInstancePatches(ctx context.Context, params *DescribeInstancePatchesInput, optFns ...func(*Options)) (*DescribeInstancePatchesOutput, error)

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

func (*Client) DescribeInventoryDeletions

func (c *Client) DescribeInventoryDeletions(ctx context.Context, params *DescribeInventoryDeletionsInput, optFns ...func(*Options)) (*DescribeInventoryDeletionsOutput, error)

Describes a specific delete inventory operation.

func (*Client) DescribeMaintenanceWindowExecutionTaskInvocations

func (c *Client) DescribeMaintenanceWindowExecutionTaskInvocations(ctx context.Context, params *DescribeMaintenanceWindowExecutionTaskInvocationsInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput, error)

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

func (*Client) DescribeMaintenanceWindowExecutionTasks

func (c *Client) DescribeMaintenanceWindowExecutionTasks(ctx context.Context, params *DescribeMaintenanceWindowExecutionTasksInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionTasksOutput, error)

For a given maintenance window execution, lists the tasks that were run.

func (*Client) DescribeMaintenanceWindowExecutions

func (c *Client) DescribeMaintenanceWindowExecutions(ctx context.Context, params *DescribeMaintenanceWindowExecutionsInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionsOutput, error)

Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

func (*Client) DescribeMaintenanceWindowSchedule

func (c *Client) DescribeMaintenanceWindowSchedule(ctx context.Context, params *DescribeMaintenanceWindowScheduleInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowScheduleOutput, error)

Retrieves information about upcoming executions of a maintenance window.

func (*Client) DescribeMaintenanceWindowTargets

func (c *Client) DescribeMaintenanceWindowTargets(ctx context.Context, params *DescribeMaintenanceWindowTargetsInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowTargetsOutput, error)

Lists the targets registered with the maintenance window.

func (*Client) DescribeMaintenanceWindowTasks

func (c *Client) DescribeMaintenanceWindowTasks(ctx context.Context, params *DescribeMaintenanceWindowTasksInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowTasksOutput, error)

Lists the tasks in a maintenance window.

func (*Client) DescribeMaintenanceWindows

func (c *Client) DescribeMaintenanceWindows(ctx context.Context, params *DescribeMaintenanceWindowsInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowsOutput, error)

Retrieves the maintenance windows in an AWS account.

func (*Client) DescribeMaintenanceWindowsForTarget

func (c *Client) DescribeMaintenanceWindowsForTarget(ctx context.Context, params *DescribeMaintenanceWindowsForTargetInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowsForTargetOutput, error)

Retrieves information about the maintenance window targets or tasks that an instance is associated with.

func (*Client) DescribeOpsItems

func (c *Client) DescribeOpsItems(ctx context.Context, params *DescribeOpsItemsInput, optFns ...func(*Options)) (*DescribeOpsItemsOutput, error)

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

func (*Client) DescribeParameters

func (c *Client) DescribeParameters(ctx context.Context, params *DescribeParametersInput, optFns ...func(*Options)) (*DescribeParametersOutput, error)

Get information about a parameter. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

func (*Client) DescribePatchBaselines

func (c *Client) DescribePatchBaselines(ctx context.Context, params *DescribePatchBaselinesInput, optFns ...func(*Options)) (*DescribePatchBaselinesOutput, error)

Lists the patch baselines in your AWS account.

func (*Client) DescribePatchGroupState

func (c *Client) DescribePatchGroupState(ctx context.Context, params *DescribePatchGroupStateInput, optFns ...func(*Options)) (*DescribePatchGroupStateOutput, error)

Returns high-level aggregated patch compliance state for a patch group.

func (*Client) DescribePatchGroups

func (c *Client) DescribePatchGroups(ctx context.Context, params *DescribePatchGroupsInput, optFns ...func(*Options)) (*DescribePatchGroupsOutput, error)

Lists all patch groups that have been registered with patch baselines.

func (*Client) DescribePatchProperties

func (c *Client) DescribePatchProperties(ctx context.Context, params *DescribePatchPropertiesInput, optFns ...func(*Options)) (*DescribePatchPropertiesOutput, error)

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline (), UpdatePatchBaseline (), DescribeAvailablePatches (), and DescribePatchBaselines (). The following section lists the properties that can be used in filters for each major operating system type: WINDOWS Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY AMAZON_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT, CLASSIFICATION, SEVERITY UBUNTU Valid properties: PRODUCT, PRIORITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY SUSE Valid properties: PRODUCT, CLASSIFICATION, SEVERITY CENTOS Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

func (*Client) DescribeSessions

func (c *Client) DescribeSessions(ctx context.Context, params *DescribeSessionsInput, optFns ...func(*Options)) (*DescribeSessionsOutput, error)

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

func (*Client) GetAutomationExecution

func (c *Client) GetAutomationExecution(ctx context.Context, params *GetAutomationExecutionInput, optFns ...func(*Options)) (*GetAutomationExecutionOutput, error)

Get detailed information about a particular Automation execution.

func (*Client) GetCalendarState

func (c *Client) GetCalendarState(ctx context.Context, params *GetCalendarStateInput, optFns ...func(*Options)) (*GetCalendarStateOutput, error)

Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, GetCalendarState returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, GetCalendarState assumes the current time. Change Calendar entries have two possible states: OPEN or CLOSED. For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) in the AWS Systems Manager User Guide.

func (*Client) GetCommandInvocation

func (c *Client) GetCommandInvocation(ctx context.Context, params *GetCommandInvocationInput, optFns ...func(*Options)) (*GetCommandInvocationOutput, error)

Returns detailed information about command execution for an invocation or plugin.

func (*Client) GetConnectionStatus

func (c *Client) GetConnectionStatus(ctx context.Context, params *GetConnectionStatusInput, optFns ...func(*Options)) (*GetConnectionStatusOutput, error)

Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.

func (*Client) GetDefaultPatchBaseline

func (c *Client) GetDefaultPatchBaseline(ctx context.Context, params *GetDefaultPatchBaselineInput, optFns ...func(*Options)) (*GetDefaultPatchBaselineOutput, error)

Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you do not specify an operating system value, the default patch baseline for Windows is returned.

func (*Client) GetDeployablePatchSnapshotForInstance

func (c *Client) GetDeployablePatchSnapshotForInstance(ctx context.Context, params *GetDeployablePatchSnapshotForInstanceInput, optFns ...func(*Options)) (*GetDeployablePatchSnapshotForInstanceOutput, error)

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.

func (*Client) GetDocument

func (c *Client) GetDocument(ctx context.Context, params *GetDocumentInput, optFns ...func(*Options)) (*GetDocumentOutput, error)

Gets the contents of the specified Systems Manager document.

func (*Client) GetInventory

func (c *Client) GetInventory(ctx context.Context, params *GetInventoryInput, optFns ...func(*Options)) (*GetInventoryOutput, error)

Query inventory information.

func (*Client) GetInventorySchema

func (c *Client) GetInventorySchema(ctx context.Context, params *GetInventorySchemaInput, optFns ...func(*Options)) (*GetInventorySchemaOutput, error)

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

func (*Client) GetMaintenanceWindow

func (c *Client) GetMaintenanceWindow(ctx context.Context, params *GetMaintenanceWindowInput, optFns ...func(*Options)) (*GetMaintenanceWindowOutput, error)

Retrieves a maintenance window.

func (*Client) GetMaintenanceWindowExecution

func (c *Client) GetMaintenanceWindowExecution(ctx context.Context, params *GetMaintenanceWindowExecutionInput, optFns ...func(*Options)) (*GetMaintenanceWindowExecutionOutput, error)

Retrieves details about a specific a maintenance window execution.

func (*Client) GetMaintenanceWindowExecutionTask

func (c *Client) GetMaintenanceWindowExecutionTask(ctx context.Context, params *GetMaintenanceWindowExecutionTaskInput, optFns ...func(*Options)) (*GetMaintenanceWindowExecutionTaskOutput, error)

Retrieves the details about a specific task run as part of a maintenance window execution.

func (*Client) GetMaintenanceWindowExecutionTaskInvocation

func (c *Client) GetMaintenanceWindowExecutionTaskInvocation(ctx context.Context, params *GetMaintenanceWindowExecutionTaskInvocationInput, optFns ...func(*Options)) (*GetMaintenanceWindowExecutionTaskInvocationOutput, error)

Retrieves information about a specific task running on a specific target.

func (*Client) GetMaintenanceWindowTask

func (c *Client) GetMaintenanceWindowTask(ctx context.Context, params *GetMaintenanceWindowTaskInput, optFns ...func(*Options)) (*GetMaintenanceWindowTaskOutput, error)

Lists the tasks in a maintenance window.

func (*Client) GetOpsItem

func (c *Client) GetOpsItem(ctx context.Context, params *GetOpsItemInput, optFns ...func(*Options)) (*GetOpsItemOutput, error)

Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

func (*Client) GetOpsSummary

func (c *Client) GetOpsSummary(ctx context.Context, params *GetOpsSummaryInput, optFns ...func(*Options)) (*GetOpsSummaryOutput, error)

View a summary of OpsItems based on specified filters and aggregators.

func (*Client) GetParameter

func (c *Client) GetParameter(ctx context.Context, params *GetParameterInput, optFns ...func(*Options)) (*GetParameterOutput, error)

Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters () API action.

func (*Client) GetParameterHistory

func (c *Client) GetParameterHistory(ctx context.Context, params *GetParameterHistoryInput, optFns ...func(*Options)) (*GetParameterHistoryOutput, error)

Query a list of all parameters used by the AWS account.

func (*Client) GetParameters

func (c *Client) GetParameters(ctx context.Context, params *GetParametersInput, optFns ...func(*Options)) (*GetParametersOutput, error)

Get details of a parameter. Don't confuse this API action with the GetParameter () API action.

func (*Client) GetParametersByPath

func (c *Client) GetParametersByPath(ctx context.Context, params *GetParametersByPathInput, optFns ...func(*Options)) (*GetParametersByPathOutput, error)

Retrieve information about one or more parameters in a specific hierarchy. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

func (*Client) GetPatchBaseline

func (c *Client) GetPatchBaseline(ctx context.Context, params *GetPatchBaselineInput, optFns ...func(*Options)) (*GetPatchBaselineOutput, error)

Retrieves information about a patch baseline.

func (*Client) GetPatchBaselineForPatchGroup

func (c *Client) GetPatchBaselineForPatchGroup(ctx context.Context, params *GetPatchBaselineForPatchGroupInput, optFns ...func(*Options)) (*GetPatchBaselineForPatchGroupOutput, error)

Retrieves the patch baseline that should be used for the specified patch group.

func (*Client) GetServiceSetting

func (c *Client) GetServiceSetting(ctx context.Context, params *GetServiceSettingInput, optFns ...func(*Options)) (*GetServiceSettingOutput, error)

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting () API action to change the default setting. Or use the ResetServiceSetting () to change the value back to the original value defined by the AWS service team. <p>Query the current service setting for the account. </p>

func (*Client) LabelParameterVersion

func (c *Client) LabelParameterVersion(ctx context.Context, params *LabelParameterVersionInput, optFns ...func(*Options)) (*LabelParameterVersionOutput, error)

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. Parameter labels have the following requirements and restrictions.

  • A version of a

parameter can have a maximum of 10 labels.

  • You can't attach the same

label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

  • You

can move a label from one version of a parameter to another.

  • You can't

create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

  • You can't delete a parameter label. If

you no longer want to use a parameter label, then you must move it to a different version of a parameter.

  • A label can have a maximum of 100

characters.

  • Labels can contain letters (case sensitive), numbers, periods

(.), hyphens (-), or underscores (_).

  • Labels can't begin with a number,

"aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.

func (*Client) ListAssociationVersions

func (c *Client) ListAssociationVersions(ctx context.Context, params *ListAssociationVersionsInput, optFns ...func(*Options)) (*ListAssociationVersionsOutput, error)

Retrieves all versions of an association for a specific association ID.

func (*Client) ListAssociations

func (c *Client) ListAssociations(ctx context.Context, params *ListAssociationsInput, optFns ...func(*Options)) (*ListAssociationsOutput, error)

Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.

func (*Client) ListCommandInvocations

func (c *Client) ListCommandInvocations(ctx context.Context, params *ListCommandInvocationsInput, optFns ...func(*Options)) (*ListCommandInvocationsOutput, error)

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

func (*Client) ListCommands

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

Lists the commands requested by users of the AWS account.

func (*Client) ListComplianceItems

func (c *Client) ListComplianceItems(ctx context.Context, params *ListComplianceItemsInput, optFns ...func(*Options)) (*ListComplianceItemsOutput, error)

For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

func (*Client) ListComplianceSummaries

func (c *Client) ListComplianceSummaries(ctx context.Context, params *ListComplianceSummariesInput, optFns ...func(*Options)) (*ListComplianceSummariesOutput, error)

Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

func (*Client) ListDocumentVersions

func (c *Client) ListDocumentVersions(ctx context.Context, params *ListDocumentVersionsInput, optFns ...func(*Options)) (*ListDocumentVersionsOutput, error)

List all versions for a document.

func (*Client) ListDocuments

func (c *Client) ListDocuments(ctx context.Context, params *ListDocumentsInput, optFns ...func(*Options)) (*ListDocumentsOutput, error)

Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.

func (*Client) ListInventoryEntries

func (c *Client) ListInventoryEntries(ctx context.Context, params *ListInventoryEntriesInput, optFns ...func(*Options)) (*ListInventoryEntriesOutput, error)

A list of inventory items returned by the request.

func (*Client) ListResourceComplianceSummaries

func (c *Client) ListResourceComplianceSummaries(ctx context.Context, params *ListResourceComplianceSummariesInput, optFns ...func(*Options)) (*ListResourceComplianceSummariesOutput, error)

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

func (*Client) ListResourceDataSync

func (c *Client) ListResourceDataSync(ctx context.Context, params *ListResourceDataSyncInput, optFns ...func(*Options)) (*ListResourceDataSyncOutput, error)

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

func (*Client) ListTagsForResource

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

Returns a list of the tags assigned to the specified resource.

func (*Client) ModifyDocumentPermission

func (c *Client) ModifyDocumentPermission(ctx context.Context, params *ModifyDocumentPermissionInput, optFns ...func(*Options)) (*ModifyDocumentPermissionOutput, error)

Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

func (*Client) PutComplianceItems

func (c *Client) PutComplianceItems(ctx context.Context, params *PutComplianceItemsInput, optFns ...func(*Options)) (*PutComplianceItemsOutput, error)

Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request. ComplianceType can be one of the following:

  • ExecutionId: The

execution ID when the patch, association, or custom compliance item was applied.

  • ExecutionType: Specify patch, association, or Custom:string.

* ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.

  • Id: The patch, association, or custom compliance

ID.

  • Title: A title.

  • Status: The status of the compliance item. For

example, approved for patches, or Failed for associations.

  • Severity: A

patch severity. For example, critical.

  • DocumentName: A SSM document name.

For example, AWS-RunPatchBaseline.

  • DocumentVersion: An SSM document

version number. For example, 4.

  • Classification: A patch classification.

For example, security updates.

  • PatchBaselineId: A patch baseline ID.

* PatchSeverity: A patch severity. For example, Critical.

  • PatchState: A

patch state. For example, InstancesWithFailedPatches.

  • PatchGroup: The

name of a patch group.

  • InstalledTime: The time the association, patch, or

custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

func (*Client) PutInventory

func (c *Client) PutInventory(ctx context.Context, params *PutInventoryInput, optFns ...func(*Options)) (*PutInventoryOutput, error)

Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

func (*Client) PutParameter

func (c *Client) PutParameter(ctx context.Context, params *PutParameterInput, optFns ...func(*Options)) (*PutParameterOutput, error)

Add a parameter to the system.

func (*Client) RegisterDefaultPatchBaseline

func (c *Client) RegisterDefaultPatchBaseline(ctx context.Context, params *RegisterDefaultPatchBaselineInput, optFns ...func(*Options)) (*RegisterDefaultPatchBaselineOutput, error)

Defines the default patch baseline for the relevant operating system. To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

func (*Client) RegisterPatchBaselineForPatchGroup

func (c *Client) RegisterPatchBaselineForPatchGroup(ctx context.Context, params *RegisterPatchBaselineForPatchGroupInput, optFns ...func(*Options)) (*RegisterPatchBaselineForPatchGroupOutput, error)

Registers a patch baseline for a patch group.

func (*Client) RegisterTargetWithMaintenanceWindow

func (c *Client) RegisterTargetWithMaintenanceWindow(ctx context.Context, params *RegisterTargetWithMaintenanceWindowInput, optFns ...func(*Options)) (*RegisterTargetWithMaintenanceWindowOutput, error)

Registers a target with a maintenance window.

func (*Client) RegisterTaskWithMaintenanceWindow

func (c *Client) RegisterTaskWithMaintenanceWindow(ctx context.Context, params *RegisterTaskWithMaintenanceWindowInput, optFns ...func(*Options)) (*RegisterTaskWithMaintenanceWindowOutput, error)

Adds a new task to a maintenance window.

func (*Client) RemoveTagsFromResource

func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error)

Removes tag keys from the specified resource.

func (*Client) ResetServiceSetting

func (c *Client) ResetServiceSetting(ctx context.Context, params *ResetServiceSettingInput, optFns ...func(*Options)) (*ResetServiceSettingOutput, error)

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting () API action to view the current value. Use the UpdateServiceSetting () API action to change the default setting. <p>Reset the service setting for the account to the default value as provisioned by the AWS service team.

func (*Client) ResumeSession

func (c *Client) ResumeSession(ctx context.Context, params *ResumeSessionInput, optFns ...func(*Options)) (*ResumeSessionOutput, error)

Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions. This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.

func (*Client) SendAutomationSignal

func (c *Client) SendAutomationSignal(ctx context.Context, params *SendAutomationSignalInput, optFns ...func(*Options)) (*SendAutomationSignalOutput, error)

Sends a signal to an Automation execution to change the current behavior or status of the execution.

func (*Client) SendCommand

func (c *Client) SendCommand(ctx context.Context, params *SendCommandInput, optFns ...func(*Options)) (*SendCommandOutput, error)

Runs commands on one or more managed instances.

func (*Client) StartAssociationsOnce

func (c *Client) StartAssociationsOnce(ctx context.Context, params *StartAssociationsOnceInput, optFns ...func(*Options)) (*StartAssociationsOnceOutput, error)

Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.

func (*Client) StartAutomationExecution

func (c *Client) StartAutomationExecution(ctx context.Context, params *StartAutomationExecutionInput, optFns ...func(*Options)) (*StartAutomationExecutionOutput, error)

Initiates execution of an Automation document.

func (*Client) StartSession

func (c *Client) StartSession(ctx context.Context, params *StartSessionInput, optFns ...func(*Options)) (*StartSessionOutput, error)

Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) in the AWS Systems Manager User Guide. AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.

func (*Client) StopAutomationExecution

func (c *Client) StopAutomationExecution(ctx context.Context, params *StopAutomationExecutionInput, optFns ...func(*Options)) (*StopAutomationExecutionOutput, error)

Stop an Automation that is currently running.

func (*Client) TerminateSession

func (c *Client) TerminateSession(ctx context.Context, params *TerminateSessionInput, optFns ...func(*Options)) (*TerminateSessionOutput, error)

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.

func (*Client) UpdateAssociation

func (c *Client) UpdateAssociation(ctx context.Context, params *UpdateAssociationInput, optFns ...func(*Options)) (*UpdateAssociationOutput, error)

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation () API action. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: is not authorized to perform: ssm:DescribeAssociation on resource: When you update an association, the association immediately runs against the specified targets.

func (*Client) UpdateAssociationStatus

func (c *Client) UpdateAssociationStatus(ctx context.Context, params *UpdateAssociationStatusInput, optFns ...func(*Options)) (*UpdateAssociationStatusOutput, error)

Updates the status of the Systems Manager document associated with the specified instance.

func (*Client) UpdateDocument

func (c *Client) UpdateDocument(ctx context.Context, params *UpdateDocumentInput, optFns ...func(*Options)) (*UpdateDocumentOutput, error)

Updates one or more values for an SSM document.

func (*Client) UpdateDocumentDefaultVersion

func (c *Client) UpdateDocumentDefaultVersion(ctx context.Context, params *UpdateDocumentDefaultVersionInput, optFns ...func(*Options)) (*UpdateDocumentDefaultVersionOutput, error)

Set the default version of a document.

func (*Client) UpdateMaintenanceWindow

func (c *Client) UpdateMaintenanceWindow(ctx context.Context, params *UpdateMaintenanceWindowInput, optFns ...func(*Options)) (*UpdateMaintenanceWindowOutput, error)

Updates an existing maintenance window. Only specified parameters are modified. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

func (*Client) UpdateMaintenanceWindowTarget

func (c *Client) UpdateMaintenanceWindowTarget(ctx context.Context, params *UpdateMaintenanceWindowTargetInput, optFns ...func(*Options)) (*UpdateMaintenanceWindowTargetOutput, error)

Modifies the target of an existing maintenance window. You can change the following: <ul> <li> <p>Name</p> </li> <li> <p>Description</p> </li> <li> <p>Owner</p> </li> <li> <p>IDs for an ID target</p> </li> <li> <p>Tags for a Tag target</p> </li> <li> <p>From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see <a>Target</a>.</p> </li> </ul> <note> <p>If a parameter is null, then the corresponding field is not modified.</p> </note>

func (*Client) UpdateMaintenanceWindowTask

func (c *Client) UpdateMaintenanceWindowTask(ctx context.Context, params *UpdateMaintenanceWindowTaskInput, optFns ...func(*Options)) (*UpdateMaintenanceWindowTaskOutput, error)

Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:

  • TaskARN. For example, you

can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

  • ServiceRoleArn

  • TaskInvocationParameters

    *

Priority

  • MaxConcurrency

  • MaxErrors

If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow () action are required for this request. Optional fields that aren't specified are set to null.

func (*Client) UpdateManagedInstanceRole

func (c *Client) UpdateManagedInstanceRole(ctx context.Context, params *UpdateManagedInstanceRoleInput, optFns ...func(*Options)) (*UpdateManagedInstanceRoleOutput, error)

Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation ().

func (*Client) UpdateOpsItem

func (c *Client) UpdateOpsItem(ctx context.Context, params *UpdateOpsItemInput, optFns ...func(*Options)) (*UpdateOpsItemOutput, error)

Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide. Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

func (*Client) UpdatePatchBaseline

func (c *Client) UpdatePatchBaseline(ctx context.Context, params *UpdatePatchBaselineInput, optFns ...func(*Options)) (*UpdatePatchBaselineOutput, error)

Modifies an existing patch baseline. Fields not specified in the request are left unchanged. For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter (http://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html).

func (*Client) UpdateResourceDataSync

func (c *Client) UpdateResourceDataSync(ctx context.Context, params *UpdateResourceDataSyncInput, optFns ...func(*Options)) (*UpdateResourceDataSyncOutput, error)

Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one. This API action only supports a resource data sync that was created with a SyncFromSource SyncType.

func (*Client) UpdateServiceSetting

func (c *Client) UpdateServiceSetting(ctx context.Context, params *UpdateServiceSettingInput, optFns ...func(*Options)) (*UpdateServiceSettingOutput, error)

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature. Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting () API action to view the current value. Or, use the ResetServiceSetting () to change the value back to the original value defined by the AWS service team. <p>Update the service setting for the account. </p>

type CreateActivationInput

type CreateActivationInput struct {
	// Specify the maximum number of managed instances you want to register. The
	// default value is 1 instance.
	RegistrationLimit *int32
	// A user-defined description of the resource that you want to register with
	// Systems Manager. Do not enter personally identifiable information in this field.
	Description *string
	// The date by which this activation request should expire. The default value is 24
	// hours.
	ExpirationDate *time.Time
	// The name of the registered, managed instance as it will appear in the Systems
	// Manager console or when you use the AWS command line tools to list Systems
	// Manager resources. Do not enter personally identifiable information in this
	// field.
	DefaultInstanceName *string
	// Optional metadata that you assign to a resource. Tags enable you to categorize a
	// resource in different ways, such as by purpose, owner, or environment. For
	// example, you might want to tag an activation to identify which servers or
	// virtual machines (VMs) in your on-premises environment you intend to activate.
	// In this case, you could specify the following key name/value pairs:
	//
	//     *
	// Key=OS,Value=Windows
	//
	//     * Key=Environment,Value=Production
	//
	// When you install
	// SSM Agent on your on-premises servers and VMs, you specify an activation ID and
	// code. When you specify the activation ID and code, tags assigned to the
	// activation are automatically applied to the on-premises servers or VMs.  <p>You
	// can't add tags to or delete tags from an existing activation. You can tag your
	// on-premises servers and VMs after they connect to Systems Manager for the first
	// time and are assigned a managed instance ID. This means they are listed in the
	// AWS Systems Manager console with an ID that is prefixed with "mi-". For
	// information about how to add tags to your managed instances, see
	// AddTagsToResource (). For information about how to remove tags from your managed
	// instances, see RemoveTagsFromResource ().
	Tags []*types.Tag
	// The Amazon Identity and Access Management (IAM) role that you want to assign to
	// the managed instance. This IAM role must provide AssumeRole permissions for the
	// Systems Manager service principal ssm.amazonaws.com. For more information, see
	// Create an IAM service role for a hybrid environment
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html)
	// in the AWS Systems Manager User Guide.
	IamRole *string
}

type CreateActivationOutput

type CreateActivationOutput struct {
	// The ID number generated by the system when it processed the activation. The
	// activation ID functions like a user name.
	ActivationId *string
	// The code the system generates when it processes the activation. The activation
	// code functions like a password to validate the activation ID.
	ActivationCode *string

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

type CreateAssociationBatchInput

type CreateAssociationBatchInput struct {
	// One or more associations.
	Entries []*types.CreateAssociationBatchRequestEntry
}

type CreateAssociationBatchOutput

type CreateAssociationBatchOutput struct {
	// Information about the associations that succeeded.
	Successful []*types.AssociationDescription
	// Information about the associations that failed.
	Failed []*types.FailedCreateAssociation

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

type CreateAssociationInput

type CreateAssociationInput struct {
	// By default, when you create a new associations, the system runs it immediately
	// after it is created and then according to the schedule you specified. Specify
	// this option if you don't want an association to run immediately after you create
	// it.
	ApplyOnlyAtCronInterval *bool
	// The document version you want to associate with the target(s). Can be a specific
	// version or the default version.
	DocumentVersion *string
	// The severity level to assign to the association.
	ComplianceSeverity types.AssociationComplianceSeverity
	// The instance ID. InstanceId has been deprecated. To specify an instance ID for
	// an association, use the Targets parameter. Requests that include the parameter
	// InstanceID with SSM documents that use schema version 2.0 or later will fail. In
	// addition, if you use the parameter InstanceId, you cannot use the parameters
	// AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or
	// ScheduleExpression. To use these parameters, you must use the Targets parameter.
	InstanceId *string
	// The targets for the association. You can target instances by using tags, AWS
	// Resource Groups, all instances in an AWS account, or individual instance IDs.
	// For more information about choosing targets for an association, see Using
	// targets and rate controls with State Manager associations
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html)
	// in the AWS Systems Manager User Guide.
	Targets []*types.Target
	// The mode for generating association compliance. You can specify AUTO or MANUAL.
	// In AUTO mode, the system uses the status of the association execution to
	// determine the compliance status. If the association execution runs successfully,
	// then the association is COMPLIANT. If the association execution doesn't run
	// successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify
	// the AssociationId as a parameter for the PutComplianceItems () API action. In
	// this case, compliance data is not managed by State Manager. It is managed by
	// your direct call to the PutComplianceItems () API action. By default, all
	// associations use AUTO mode.
	SyncCompliance types.AssociationSyncCompliance
	// A cron expression when the association will be applied to the target(s).
	ScheduleExpression *string
	// The number of errors that are allowed before the system stops sending requests
	// to run the association on additional targets. You can specify either an absolute
	// number of errors, for example 10, or a percentage of the target set, for example
	// 10%. If you specify 3, for example, the system stops sending requests when the
	// fourth error is received. If you specify 0, then the system stops sending
	// requests after the first error is returned. If you run an association on 50
	// instances and set MaxError to 10%, then the system stops sending the request
	// when the sixth error is received. Executions that are already running an
	// association when MaxErrors is reached are allowed to complete, but some of these
	// executions may fail as well. If you need to ensure that there won't be more than
	// max-errors failed executions, set MaxConcurrency to 1 so that executions proceed
	// one at a time.
	MaxErrors *string
	// Specify the target for the association. This target is required for associations
	// that use an Automation document and target resources by using rate controls.
	AutomationTargetParameterName *string
	// The name of the SSM document that contains the configuration information for the
	// instance. You can specify Command or Automation documents. You can specify
	// AWS-predefined documents, documents you created, or a document that is shared
	// with you from another account. For SSM documents that are shared with you from
	// other AWS accounts, you must specify the complete SSM document ARN, in the
	// following format: arn:partition:ssm:region:account-id:document/document-name
	// For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For
	// AWS-predefined documents and SSM documents you created in your account, you only
	// need to specify the document name. For example, AWS-ApplyPatchBaseline or
	// My-Document.
	Name *string
	// The parameters for the runtime configuration of the document.
	Parameters map[string][]*string
	// An S3 bucket where you want to store the output details of the request.
	OutputLocation *types.InstanceAssociationOutputLocation
	// Specify a descriptive name for the association.
	AssociationName *string
	// The maximum number of targets allowed to run the association at the same time.
	// You can specify a number, for example 10, or a percentage of the target set, for
	// example 10%. The default value is 100%, which means all targets run the
	// association at the same time. If a new instance starts and attempts to run an
	// association while Systems Manager is running MaxConcurrency associations, the
	// association is allowed to run. During the next association interval, the new
	// instance will process its association within the limit specified for
	// MaxConcurrency.
	MaxConcurrency *string
}

type CreateAssociationOutput

type CreateAssociationOutput struct {
	// Information about the association.
	AssociationDescription *types.AssociationDescription

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

type CreateDocumentInput

type CreateDocumentInput struct {
	// Specify a target type to define the kinds of resources the document can run on.
	// For example, to run a document on EC2 instances, specify the following value:
	// /AWS::EC2::Instance. If you specify a value of '/' the document can run on all
	// types of resources. If you don't specify a value, the document can't run on any
	// resources. For a list of valid resource types, see AWS resource and property
	// types reference
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.
	TargetType *string
	// An optional field specifying the version of the artifact you are creating with
	// the document. For example, "Release 12, Update 6". This value is unique across
	// all versions of a document, and cannot be changed.
	VersionName *string
	// The content for the new SSM document in JSON or YAML format. We recommend
	// storing the contents for your new document in an external JSON or YAML file and
	// referencing the file in a command. For examples, see the following topics in the
	// AWS Systems Manager User Guide.
	//
	//     * Create an SSM document (AWS API)
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html)
	//
	//
	// * Create an SSM document (AWS CLI)
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html)
	//
	//
	// * Create an SSM document (API)
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html)
	Content *string
	// The type of document to create.
	DocumentType types.DocumentType
	// Optional metadata that you assign to a resource. Tags enable you to categorize a
	// resource in different ways, such as by purpose, owner, or environment. For
	// example, you might want to tag an SSM document to identify the types of targets
	// or the environment where it will run. In this case, you could specify the
	// following key name/value pairs:  <ul> <li> <p> <code>Key=OS,Value=Windows</code>
	// </p> </li> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li>
	// </ul> <note> <p>To add tags to an existing SSM document, use the
	// <a>AddTagsToResource</a> action.</p> </note>
	Tags []*types.Tag
	// Specify the document format for the request. The document format can be JSON,
	// YAML, or TEXT. JSON is the default format.
	DocumentFormat types.DocumentFormat
	// A list of SSM documents required by a document. This parameter is used
	// exclusively by AWS AppConfig. When a user creates an AppConfig configuration in
	// an SSM document, the user must also specify a required document for validation
	// purposes. In this case, an ApplicationConfiguration document requires an
	// ApplicationConfigurationSchema document for validation purposes. For more
	// information, see AWS AppConfig
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html) in
	// the AWS Systems Manager User Guide.
	Requires []*types.DocumentRequires
	// A list of key and value pairs that describe attachments to a version of a
	// document.
	Attachments []*types.AttachmentsSource
	// A name for the Systems Manager document. You can't use the following strings as
	// document name prefixes. These are reserved by AWS for use as document name
	// prefixes:
	//
	//     * aws-
	//
	//     * amazon
	//
	//     * amzn
	Name *string
}

type CreateDocumentOutput

type CreateDocumentOutput struct {
	// Information about the Systems Manager document.
	DocumentDescription *types.DocumentDescription

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

type CreateMaintenanceWindowInput

type CreateMaintenanceWindowInput struct {
	// An optional description for the maintenance window. We recommend specifying a
	// description to help you organize your maintenance windows.
	Description *string
	// Optional metadata that you assign to a resource. Tags enable you to categorize a
	// resource in different ways, such as by purpose, owner, or environment. For
	// example, you might want to tag a maintenance window to identify the type of
	// tasks it will run, the types of targets, and the environment it will run in. In
	// this case, you could specify the following key name/value pairs:
	//
	//     *
	// Key=TaskType,Value=AgentUpdate
	//
	//     * Key=OS,Value=Windows
	//
	//     *
	// Key=Environment,Value=Production
	//
	// To add tags to an existing maintenance window,
	// use the AddTagsToResource () action.
	Tags []*types.Tag
	// The time zone that the scheduled maintenance window executions are based on, in
	// Internet Assigned Numbers Authority (IANA) format. For example:
	// "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the
	// Time Zone Database (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string
	// User-provided idempotency token.
	ClientToken *string
	// The date and time, in ISO-8601 Extended format, for when you want the
	// maintenance window to become active. StartDate allows you to delay activation of
	// the maintenance window until the specified future date.
	StartDate *string
	// The duration of the maintenance window in hours.
	Duration *int32
	// The name of the maintenance window.
	Name *string
	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string
	// The date and time, in ISO-8601 Extended format, for when you want the
	// maintenance window to become inactive. EndDate allows you to set a date and time
	// in the future when the maintenance window will no longer run.
	EndDate *string
	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int32
	// The number of days to wait after the date and time specified by a CRON
	// expression before running the maintenance window. For example, the following
	// cron expression schedules a maintenance window to run on the third Tuesday of
	// every month at 11:30 PM. cron(0 30 23 ? * TUE#3 *) If the schedule offset is 2,
	// the maintenance window won't run until two days later.
	ScheduleOffset *int32
	// Enables a maintenance window task to run on managed instances, even if you have
	// not registered those instances as targets. If enabled, then you must specify the
	// unregistered instances (by instance ID) when you register a task with the
	// maintenance window. If you don't enable this option, then you must specify
	// previously-registered targets when you register a task with the maintenance
	// window.
	AllowUnassociatedTargets *bool
}

type CreateMaintenanceWindowOutput

type CreateMaintenanceWindowOutput struct {
	// The ID of the created maintenance window.
	WindowId *string

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

type CreateOpsItemInput

type CreateOpsItemInput struct {
	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	Title *string
	// The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The source
	// name can't contain the following strings: aws, amazon, and amzn.
	Source *string
	// Operational data is custom data that provides useful reference details about the
	// OpsItem. For example, you can specify log files, error strings, license keys,
	// troubleshooting tips, or other relevant data. You enter operational data as
	// key-value pairs. The key has a maximum length of 128 characters. The value has a
	// maximum size of 20 KB. Operational data keys can't begin with the following:
	// amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm. You can choose to make the
	// data searchable by other users in the account or you can restrict search access.
	// Searchable data means that all users with access to the OpsItem Overview page
	// (as provided by the DescribeOpsItems () API action) can view and search on the
	// specified data. Operational data that is not searchable is only viewable by
	// users who have access to the OpsItem (as provided by the GetOpsItem () API
	// action).  <p>Use the <code>/aws/resources</code> key in OperationalData to
	// specify a related resource in  the request. Use the /aws/automations key in
	// OperationalData to associate an Automation runbook with the OpsItem. To view AWS
	// CLI example commands that use these keys, see Creating OpsItems manually
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems)
	// in the AWS Systems Manager User Guide.
	OperationalData map[string]*types.OpsItemDataValue
	// The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when
	// this OpsItem is edited or changed.
	Notifications []*types.OpsItemNotification
	// One or more OpsItems that share something in common with the current OpsItems.
	// For example, related OpsItems can include OpsItems with similar error messages,
	// impacted resources, or statuses for the impacted resource.
	RelatedOpsItems []*types.RelatedOpsItem
	// Specify a category to assign to an OpsItem.
	Category *string
	// Information about the OpsItem.
	Description *string
	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int32
	// Optional metadata that you assign to a resource. You can restrict access to
	// OpsItems by using an inline IAM policy that specifies tags. For more
	// information, see Getting started with OpsCenter
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions)
	// in the AWS Systems Manager User Guide. Tags use a key-value pair. For example:
	// <p> <code>Key=Department,Value=Finance</code> </p> <note> <p>To add tags to an
	// existing OpsItem, use the <a>AddTagsToResource</a> action.</p> </note>
	Tags []*types.Tag
	// Specify a severity to assign to an OpsItem.
	Severity *string
}

type CreateOpsItemOutput

type CreateOpsItemOutput struct {
	// The ID of the OpsItem.
	OpsItemId *string

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

type CreatePatchBaselineInput

type CreatePatchBaselineInput struct {
	// A description of the patch baseline.
	Description *string
	// User-provided idempotency token.
	ClientToken *string
	// Defines the operating system the patch baseline applies to. The Default value is
	// WINDOWS.
	OperatingSystem types.OperatingSystem
	// The name of the patch baseline.
	Name *string
	// A list of explicitly rejected patches for the baseline. For information about
	// accepted formats for lists of approved patches and rejected patches, see About
	// package name formats for approved and rejected patch lists
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	RejectedPatches []*string
	// A set of rules used to include patches in the baseline.
	ApprovalRules *types.PatchRuleGroup
	// A list of explicitly approved patches for the baseline. For information about
	// accepted formats for lists of approved patches and rejected patches, see About
	// package name formats for approved and rejected patch lists
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	ApprovedPatches []*string
	// The action for Patch Manager to take on patches included in the RejectedPackages
	// list.
	//
	//     * ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is
	// installed only if it is a dependency of another package. It is considered
	// compliant with the patch baseline, and its status is reported as InstalledOther.
	// This is the default action if no option is specified.
	//
	//     * BLOCK: Packages in
	// the RejectedPatches list, and packages that include them as dependencies, are
	// not installed under any circumstances. If a package was installed before it was
	// added to the Rejected patches list, it is considered non-compliant with the
	// patch baseline, and its status is reported as InstalledRejected.
	RejectedPatchesAction types.PatchAction
	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*types.PatchSource
	// Defines the compliance level for approved patches. This means that if an
	// approved patch is reported as missing, this is the severity of the compliance
	// violation. The default value is UNSPECIFIED.
	ApprovedPatchesComplianceLevel types.PatchComplianceLevel
	// Optional metadata that you assign to a resource. Tags enable you to categorize a
	// resource in different ways, such as by purpose, owner, or environment. For
	// example, you might want to tag a patch baseline to identify the severity level
	// of patches it specifies and the operating system family it applies to. In this
	// case, you could specify the following key name/value pairs:
	//
	//     *
	// Key=PatchSeverity,Value=Critical
	//
	//     * Key=OS,Value=Windows
	//
	// To add tags to an
	// existing patch baseline, use the AddTagsToResource () action.
	Tags []*types.Tag
	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool
	// A set of global filters used to include patches in the baseline.
	GlobalFilters *types.PatchFilterGroup
}

type CreatePatchBaselineOutput

type CreatePatchBaselineOutput struct {
	// The ID of the created patch baseline.
	BaselineId *string

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

type CreateResourceDataSyncInput

type CreateResourceDataSyncInput struct {
	// Specify SyncToDestination to create a resource data sync that synchronizes data
	// to an S3 bucket for Inventory. If you specify SyncToDestination, you must
	// provide a value for S3Destination. Specify SyncFromSource to synchronize data
	// from a single account and multiple Regions, or multiple AWS accounts and
	// Regions, as listed in AWS Organizations for Explorer. If you specify
	// SyncFromSource, you must provide a value for SyncSource. The default value is
	// SyncToDestination.
	SyncType *string
	// A name for the configuration.
	SyncName *string
	// Specify information about the data sources to synchronize. This parameter is
	// required if the SyncType value is SyncFromSource.
	SyncSource *types.ResourceDataSyncSource
	// Amazon S3 configuration details for the sync. This parameter is required if the
	// SyncType value is SyncToDestination.
	S3Destination *types.ResourceDataSyncS3Destination
}

type CreateResourceDataSyncOutput

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

type DeleteActivationInput

type DeleteActivationInput struct {
	// The ID of the activation that you want to delete.
	ActivationId *string
}

type DeleteActivationOutput

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

type DeleteAssociationInput

type DeleteAssociationInput struct {
	// The ID of the instance.
	InstanceId *string
	// The association ID that you want to delete.
	AssociationId *string
	// The name of the Systems Manager document.
	Name *string
}

type DeleteAssociationOutput

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

type DeleteDocumentInput

type DeleteDocumentInput struct {
	// Some SSM document types require that you specify a Force flag before you can
	// delete the document. For example, you must specify a Force flag to delete a
	// document of type ApplicationConfigurationSchema. You can restrict access to the
	// Force flag in an AWS Identity and Access Management (IAM) policy.
	Force *bool
	// The version name of the document that you want to delete. If not provided, all
	// versions of the document are deleted.
	VersionName *string
	// The name of the document.
	Name *string
	// The version of the document that you want to delete. If not provided, all
	// versions of the document are deleted.
	DocumentVersion *string
}

type DeleteDocumentOutput

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

type DeleteInventoryInput

type DeleteInventoryInput struct {
	// The name of the custom inventory type for which you want to delete either all
	// previously collected data, or the inventory type itself.
	TypeName *string
	// Use the SchemaDeleteOption to delete a custom inventory type (schema). If you
	// don't choose this option, the system only deletes existing inventory data
	// associated with the custom inventory type. Choose one of the following options:
	// DisableSchema: If you choose this option, the system ignores all inventory data
	// for the specified version, and any earlier versions. To enable this schema
	// again, you must call the PutInventory action for a version greater than the
	// disabled version. DeleteSchema: This option deletes the specified custom type
	// from the Inventory service. You can recreate the schema later, if you want.
	SchemaDeleteOption types.InventorySchemaDeleteOption
	// Use this option to view a summary of the deletion request without deleting any
	// data or the data type. This option is useful when you only want to understand
	// what will be deleted. Once you validate that the data to be deleted is what you
	// intend to delete, you can run the same command without specifying the DryRun
	// option.
	DryRun *bool
	// User-provided idempotency token.
	ClientToken *string
}

type DeleteInventoryOutput

type DeleteInventoryOutput struct {
	// Every DeleteInventory action is assigned a unique ID. This option returns a
	// unique ID. You can use this ID to query the status of a delete operation. This
	// option is useful for ensuring that a delete operation has completed before you
	// begin other actions.
	DeletionId *string
	// A summary of the delete operation. For more information about this summary, see
	// Deleting custom inventory
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete-summary)
	// in the AWS Systems Manager User Guide.
	DeletionSummary *types.InventoryDeletionSummary
	// The name of the inventory data type specified in the request.
	TypeName *string

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

type DeleteMaintenanceWindowInput

type DeleteMaintenanceWindowInput struct {
	// The ID of the maintenance window to delete.
	WindowId *string
}

type DeleteMaintenanceWindowOutput

type DeleteMaintenanceWindowOutput struct {
	// The ID of the deleted maintenance window.
	WindowId *string

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

type DeleteParameterInput

type DeleteParameterInput struct {
	// The name of the parameter to delete.
	Name *string
}

type DeleteParameterOutput

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

type DeleteParametersInput

type DeleteParametersInput struct {
	// The names of the parameters to delete.
	Names []*string
}

type DeleteParametersOutput

type DeleteParametersOutput struct {
	// The names of the deleted parameters.
	DeletedParameters []*string
	// The names of parameters that weren't deleted because the parameters are not
	// valid.
	InvalidParameters []*string

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

type DeletePatchBaselineInput

type DeletePatchBaselineInput struct {
	// The ID of the patch baseline to delete.
	BaselineId *string
}

type DeletePatchBaselineOutput

type DeletePatchBaselineOutput struct {
	// The ID of the deleted patch baseline.
	BaselineId *string

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

type DeleteResourceDataSyncInput

type DeleteResourceDataSyncInput struct {
	// Specify the type of resource data sync to delete.
	SyncType *string
	// The name of the configuration to delete.
	SyncName *string
}

type DeleteResourceDataSyncOutput

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

type DeregisterManagedInstanceInput

type DeregisterManagedInstanceInput struct {
	// The ID assigned to the managed instance when you registered it using the
	// activation process.
	InstanceId *string
}

type DeregisterManagedInstanceOutput

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

type DeregisterPatchBaselineForPatchGroupInput

type DeregisterPatchBaselineForPatchGroupInput struct {
	// The name of the patch group that should be deregistered from the patch baseline.
	PatchGroup *string
	// The ID of the patch baseline to deregister the patch group from.
	BaselineId *string
}

type DeregisterPatchBaselineForPatchGroupOutput

type DeregisterPatchBaselineForPatchGroupOutput struct {
	// The ID of the patch baseline the patch group was deregistered from.
	BaselineId *string
	// The name of the patch group deregistered from the patch baseline.
	PatchGroup *string

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

type DeregisterTargetFromMaintenanceWindowInput

type DeregisterTargetFromMaintenanceWindowInput struct {
	// The ID of the target definition to remove.
	WindowTargetId *string
	// The system checks if the target is being referenced by a task. If the target is
	// being referenced, the system returns an error and does not deregister the target
	// from the maintenance window.
	Safe *bool
	// The ID of the maintenance window the target should be removed from.
	WindowId *string
}

type DeregisterTargetFromMaintenanceWindowOutput

type DeregisterTargetFromMaintenanceWindowOutput struct {
	// The ID of the maintenance window the target was removed from.
	WindowId *string
	// The ID of the removed target definition.
	WindowTargetId *string

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

type DeregisterTaskFromMaintenanceWindowInput

type DeregisterTaskFromMaintenanceWindowInput struct {
	// The ID of the maintenance window the task should be removed from.
	WindowId *string
	// The ID of the task to remove from the maintenance window.
	WindowTaskId *string
}

type DeregisterTaskFromMaintenanceWindowOutput

type DeregisterTaskFromMaintenanceWindowOutput struct {
	// The ID of the maintenance window the task was removed from.
	WindowId *string
	// The ID of the task removed from the maintenance window.
	WindowTaskId *string

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

type DescribeActivationsInput

type DescribeActivationsInput struct {
	// A filter to view information about your activations.
	Filters []*types.DescribeActivationsFilter
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
}

type DescribeActivationsOutput

type DescribeActivationsOutput struct {
	// A list of activations for your AWS account.
	ActivationList []*types.Activation
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type DescribeAssociationExecutionTargetsInput

type DescribeAssociationExecutionTargetsInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// Filters for the request. You can specify the following filters and values.
	// Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL)
	Filters []*types.AssociationExecutionTargetsFilter
	// The execution ID for which you want to view details.
	ExecutionId *string
	// The association ID that includes the execution for which you want to view
	// details.
	AssociationId *string
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
}

type DescribeAssociationExecutionTargetsOutput

type DescribeAssociationExecutionTargetsOutput struct {
	// Information about the execution.
	AssociationExecutionTargets []*types.AssociationExecutionTarget
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type DescribeAssociationExecutionsInput

type DescribeAssociationExecutionsInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// Filters for the request. You can specify the following filters and values.
	// ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
	Filters []*types.AssociationExecutionFilter
	// The association ID for which you want to view execution history details.
	AssociationId *string
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
}

type DescribeAssociationExecutionsOutput

type DescribeAssociationExecutionsOutput struct {
	// A list of the executions for the specified association ID.
	AssociationExecutions []*types.AssociationExecution
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type DescribeAssociationInput

type DescribeAssociationInput struct {
	// The association ID for which you want information.
	AssociationId *string
	// Specify the association version to retrieve. To view the latest version, either
	// specify $LATEST for this parameter, or omit this parameter. To view a list of
	// all associations for an instance, use ListAssociations (). To get a list of
	// versions for a specific association, use ListAssociationVersions ().
	AssociationVersion *string
	// The name of the Systems Manager document.
	Name *string
	// The instance ID.
	InstanceId *string
}

type DescribeAssociationOutput

type DescribeAssociationOutput struct {
	// Information about the association.
	AssociationDescription *types.AssociationDescription

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

type DescribeAutomationExecutionsInput

type DescribeAutomationExecutionsInput struct {
	// Filters used to limit the scope of executions that are requested.
	Filters []*types.AutomationExecutionFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type DescribeAutomationExecutionsOutput

type DescribeAutomationExecutionsOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// The list of details about each automation execution which has occurred which
	// matches the filter specification, if any.
	AutomationExecutionMetadataList []*types.AutomationExecutionMetadata

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

type DescribeAutomationStepExecutionsInput

type DescribeAutomationStepExecutionsInput struct {
	// The Automation execution ID for which you want step execution descriptions.
	AutomationExecutionId *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// One or more filters to limit the number of step executions returned by the
	// request.
	Filters []*types.StepExecutionFilter
	// A boolean that indicates whether to list step executions in reverse order by
	// start time. The default value is false.
	ReverseOrder *bool
}

type DescribeAutomationStepExecutionsOutput

type DescribeAutomationStepExecutionsOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// A list of details about the current state of all steps that make up an
	// execution.
	StepExecutions []*types.StepExecution

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

type DescribeAvailablePatchesInput

type DescribeAvailablePatchesInput struct {
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of patches to return (per page).
	MaxResults *int32
	// Filters used to scope down the returned patches.
	Filters []*types.PatchOrchestratorFilter
}

type DescribeAvailablePatchesOutput

type DescribeAvailablePatchesOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// An array of patches. Each entry in the array is a patch structure.
	Patches []*types.Patch

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

type DescribeDocumentInput

type DescribeDocumentInput struct {
	// An optional field specifying the version of the artifact associated with the
	// document. For example, "Release 12, Update 6". This value is unique across all
	// versions of a document, and cannot be changed.
	VersionName *string
	// The name of the Systems Manager document.
	Name *string
	// The document version for which you want information. Can be a specific version
	// or the default version.
	DocumentVersion *string
}

type DescribeDocumentOutput

type DescribeDocumentOutput struct {
	// Information about the Systems Manager document.
	Document *types.DocumentDescription

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

type DescribeDocumentPermissionInput

type DescribeDocumentPermissionInput struct {
	// The name of the document for which you are the owner.
	Name *string
	// The permission type for the document. The permission type can be Share.
	PermissionType types.DocumentPermissionType
}

type DescribeDocumentPermissionOutput

type DescribeDocumentPermissionOutput struct {
	// The account IDs that have permission to use this document. The ID can be either
	// an AWS account or All.
	AccountIds []*string
	// A list of AWS accounts where the current document is shared and the version
	// shared with each account.
	AccountSharingInfoList []*types.AccountSharingInfo

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

type DescribeEffectiveInstanceAssociationsInput

type DescribeEffectiveInstanceAssociationsInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The instance ID for which you want to view all associations.
	InstanceId *string
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type DescribeEffectiveInstanceAssociationsOutput

type DescribeEffectiveInstanceAssociationsOutput struct {
	// The associations for the requested instance.
	Associations []*types.InstanceAssociation
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type DescribeEffectivePatchesForPatchBaselineInput

type DescribeEffectivePatchesForPatchBaselineInput struct {
	// The ID of the patch baseline to retrieve the effective patches for.
	BaselineId *string
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of patches to return (per page).
	MaxResults *int32
}

type DescribeEffectivePatchesForPatchBaselineOutput

type DescribeEffectivePatchesForPatchBaselineOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// An array of patches and patch status.
	EffectivePatches []*types.EffectivePatch

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

type DescribeInstanceAssociationsStatusInput

type DescribeInstanceAssociationsStatusInput struct {
	// The instance IDs for which you want association status information.
	InstanceId *string
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type DescribeInstanceAssociationsStatusOutput

type DescribeInstanceAssociationsStatusOutput struct {
	// Status information about the association.
	InstanceAssociationStatusInfos []*types.InstanceAssociationStatusInfo
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type DescribeInstanceInformationInput

type DescribeInstanceInformationInput struct {
	// This is a legacy method. We recommend that you don't use this method. Instead,
	// use the Filters data type. Filters enables you to return instance information by
	// filtering based on tags applied to managed instances. Attempting to use
	// InstanceInformationFilterList and Filters leads to an exception error.
	InstanceInformationFilterList []*types.InstanceInformationFilter
	// One or more filters. Use a filter to return a more specific list of instances.
	// You can filter based on tags applied to EC2 instances. Use this Filters data
	// type instead of InstanceInformationFilterList, which is deprecated.
	Filters []*types.InstanceInformationStringFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type DescribeInstanceInformationOutput

type DescribeInstanceInformationOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// The instance information list.
	InstanceInformationList []*types.InstanceInformation

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

type DescribeInstancePatchStatesForPatchGroupInput

type DescribeInstancePatchStatesForPatchGroupInput struct {
	// The name of the patch group for which the patch state information should be
	// retrieved.
	PatchGroup *string
	// Each entry in the array is a structure containing: Key (string between 1 and 200
	// characters) Values (array containing a single string) Type (string "Equal",
	// "NotEqual", "LessThan", "GreaterThan")
	Filters []*types.InstancePatchStateFilter
	// The maximum number of patches to return (per page).
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type DescribeInstancePatchStatesForPatchGroupOutput

type DescribeInstancePatchStatesForPatchGroupOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// The high-level patch state for the requested instances.
	InstancePatchStates []*types.InstancePatchState

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

type DescribeInstancePatchStatesInput

type DescribeInstancePatchStatesInput struct {
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The ID of the instance whose patch state information should be retrieved.
	InstanceIds []*string
	// The maximum number of instances to return (per page).
	MaxResults *int32
}

type DescribeInstancePatchStatesOutput

type DescribeInstancePatchStatesOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// The high-level patch state for the requested instances.
	InstancePatchStates []*types.InstancePatchState

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

type DescribeInstancePatchesInput

type DescribeInstancePatchesInput struct {
	// The ID of the instance whose patch state information should be retrieved.
	InstanceId *string
	// The maximum number of patches to return (per page).
	MaxResults *int32
	// An array of structures. Each entry in the array is a structure containing a Key,
	// Value combination. Valid values for Key are Classification | KBId | Severity |
	// State.
	Filters []*types.PatchOrchestratorFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type DescribeInstancePatchesOutput

type DescribeInstancePatchesOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// Each entry in the array is a structure containing: Title (string) KBId (string)
	// Classification (string) Severity (string) State (string, such as "INSTALLED" or
	// "FAILED") InstalledTime (DateTime) InstalledBy (string)
	Patches []*types.PatchComplianceData

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

type DescribeInventoryDeletionsInput

type DescribeInventoryDeletionsInput struct {
	// Specify the delete inventory ID for which you want information. This ID was
	// returned by the DeleteInventory action.
	DeletionId *string
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type DescribeInventoryDeletionsOutput

type DescribeInventoryDeletionsOutput struct {
	// A list of status items for deleted inventory.
	InventoryDeletions []*types.InventoryDeletionStatusItem
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type DescribeMaintenanceWindowExecutionTaskInvocationsInput

type DescribeMaintenanceWindowExecutionTaskInvocationsInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The ID of the specific task in the maintenance window task that should be
	// retrieved.
	TaskId *string
	// Optional filters used to scope down the returned task invocations. The supported
	// filter key is STATUS with the corresponding values PENDING, IN_PROGRESS,
	// SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
	Filters []*types.MaintenanceWindowFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The ID of the maintenance window execution the task is part of.
	WindowExecutionId *string
}

type DescribeMaintenanceWindowExecutionTaskInvocationsOutput

type DescribeMaintenanceWindowExecutionTaskInvocationsOutput struct {
	// Information about the task invocation results per invocation.
	WindowExecutionTaskInvocationIdentities []*types.MaintenanceWindowExecutionTaskInvocationIdentity
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type DescribeMaintenanceWindowExecutionTasksInput

type DescribeMaintenanceWindowExecutionTasksInput struct {
	// Optional filters used to scope down the returned tasks. The supported filter key
	// is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED,
	// TIMED_OUT, CANCELLING, and CANCELLED.
	Filters []*types.MaintenanceWindowFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The ID of the maintenance window execution whose task executions should be
	// retrieved.
	WindowExecutionId *string
}

type DescribeMaintenanceWindowExecutionTasksOutput

type DescribeMaintenanceWindowExecutionTasksOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// Information about the task executions.
	WindowExecutionTaskIdentities []*types.MaintenanceWindowExecutionTaskIdentity

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

type DescribeMaintenanceWindowExecutionsInput

type DescribeMaintenanceWindowExecutionsInput struct {
	// The ID of the maintenance window whose executions should be retrieved.
	WindowId *string
	// Each entry in the array is a structure containing: Key (string, between 1 and
	// 128 characters) Values (array of strings, each string is between 1 and 256
	// characters) The supported Keys are ExecutedBefore and ExecutedAfter with the
	// value being a date/time string such as 2016-11-04T05:00:00Z.
	Filters []*types.MaintenanceWindowFilter
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type DescribeMaintenanceWindowExecutionsOutput

type DescribeMaintenanceWindowExecutionsOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// Information about the maintenance window executions.
	WindowExecutions []*types.MaintenanceWindowExecution

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

type DescribeMaintenanceWindowScheduleInput

type DescribeMaintenanceWindowScheduleInput struct {
	// Filters used to limit the range of results. For example, you can limit
	// maintenance window executions to only those scheduled before or after a certain
	// date and time.
	Filters []*types.PatchOrchestratorFilter
	// The instance ID or key/value pair to retrieve information about.
	Targets []*types.Target
	// The type of resource you want to retrieve information about. For example,
	// "INSTANCE".
	ResourceType types.MaintenanceWindowResourceType
	// The ID of the maintenance window to retrieve information about.
	WindowId *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type DescribeMaintenanceWindowScheduleOutput

type DescribeMaintenanceWindowScheduleOutput struct {
	// Information about maintenance window executions scheduled for the specified time
	// range.
	ScheduledWindowExecutions []*types.ScheduledWindowExecution
	// The token for the next set of items to return. (You use this token in the next
	// call.)
	NextToken *string

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

type DescribeMaintenanceWindowTargetsInput

type DescribeMaintenanceWindowTargetsInput struct {
	// Optional filters that can be used to narrow down the scope of the returned
	// window targets. The supported filter keys are Type, WindowTargetId and
	// OwnerInformation.
	Filters []*types.MaintenanceWindowFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The ID of the maintenance window whose targets should be retrieved.
	WindowId *string
}

type DescribeMaintenanceWindowTargetsOutput

type DescribeMaintenanceWindowTargetsOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// Information about the targets in the maintenance window.
	Targets []*types.MaintenanceWindowTarget

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

type DescribeMaintenanceWindowTasksInput

type DescribeMaintenanceWindowTasksInput struct {
	// Optional filters used to narrow down the scope of the returned tasks. The
	// supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
	Filters []*types.MaintenanceWindowFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The ID of the maintenance window whose tasks should be retrieved.
	WindowId *string
}

type DescribeMaintenanceWindowTasksOutput

type DescribeMaintenanceWindowTasksOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// Information about the tasks in the maintenance window.
	Tasks []*types.MaintenanceWindowTask

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

type DescribeMaintenanceWindowsForTargetInput

type DescribeMaintenanceWindowsForTargetInput struct {
	// The instance ID or key/value pair to retrieve information about.
	Targets []*types.Target
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The type of resource you want to retrieve information about. For example,
	// "INSTANCE".
	ResourceType types.MaintenanceWindowResourceType
}

type DescribeMaintenanceWindowsForTargetOutput

type DescribeMaintenanceWindowsForTargetOutput struct {
	// Information about the maintenance window targets and tasks an instance is
	// associated with.
	WindowIdentities []*types.MaintenanceWindowIdentityForTarget
	// The token for the next set of items to return. (You use this token in the next
	// call.)
	NextToken *string

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

type DescribeMaintenanceWindowsInput

type DescribeMaintenanceWindowsInput struct {
	// Optional filters used to narrow down the scope of the returned maintenance
	// windows. Supported filter keys are Name and Enabled.
	Filters []*types.MaintenanceWindowFilter
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type DescribeMaintenanceWindowsOutput

type DescribeMaintenanceWindowsOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// Information about the maintenance windows.
	WindowIdentities []*types.MaintenanceWindowIdentity

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

type DescribeOpsItemsInput

type DescribeOpsItemsInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// One or more filters to limit the response.
	//
	//     * Key: CreatedTime Operations:
	// GreaterThan, LessThan
	//
	//     * Key: LastModifiedBy Operations: Contains, Equals
	//
	//
	// * Key: LastModifiedTime Operations: GreaterThan, LessThan
	//
	//     * Key: Priority
	// Operations: Equals
	//
	//     * Key: Source Operations: Contains, Equals
	//
	//     * Key:
	// Status Operations: Equals
	//
	//     * Key: Title Operations: Contains
	//
	//     * Key:
	// OperationalData* Operations: Equals
	//
	//     * Key: OperationalDataKey Operations:
	// Equals
	//
	//     * Key: OperationalDataValue Operations: Equals, Contains
	//
	//     * Key:
	// OpsItemId Operations: Equals
	//
	//     * Key: ResourceId Operations: Contains
	//
	//     *
	// Key: AutomationId Operations: Equals
	//
	// *If you filter the response by using the
	// OperationalData operator, specify a key-value pair by using the following JSON
	// format: {"key":"key_name","value":"a_value"}
	OpsItemFilters []*types.OpsItemFilter
}

type DescribeOpsItemsOutput

type DescribeOpsItemsOutput struct {
	// A list of OpsItems.
	OpsItemSummaries []*types.OpsItemSummary
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type DescribeParametersInput

type DescribeParametersInput struct {
	// This data type is deprecated. Instead, use ParameterFilters.
	Filters []*types.ParametersFilter
	// Filters to limit the request results.
	ParameterFilters []*types.ParameterStringFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type DescribeParametersOutput

type DescribeParametersOutput struct {
	// Parameters returned by the request.
	Parameters []*types.ParameterMetadata
	// The token to use when requesting the next set of items.
	NextToken *string

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

type DescribePatchBaselinesInput

type DescribePatchBaselinesInput struct {
	// The maximum number of patch baselines to return (per page).
	MaxResults *int32
	// Each element in the array is a structure containing: Key: (string, "NAME_PREFIX"
	// or "OWNER") Value: (array of strings, exactly 1 entry, between 1 and 255
	// characters)
	Filters []*types.PatchOrchestratorFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type DescribePatchBaselinesOutput

type DescribePatchBaselinesOutput struct {
	// An array of PatchBaselineIdentity elements.
	BaselineIdentities []*types.PatchBaselineIdentity
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type DescribePatchGroupStateInput

type DescribePatchGroupStateInput struct {
	// The name of the patch group whose patch snapshot should be retrieved.
	PatchGroup *string
}

type DescribePatchGroupStateOutput

type DescribePatchGroupStateOutput struct {
	// The number of instances with NotApplicable patches beyond the supported limit,
	// which are not reported by name to Systems Manager Inventory.
	InstancesWithUnreportedNotApplicablePatches *int32
	// The number of instances with patches from the patch baseline that failed to
	// install.
	InstancesWithFailedPatches *int32
	// The number of instances with installed patches.
	InstancesWithInstalledPatches *int32
	// The number of instances with patches installed by Patch Manager that have not
	// been rebooted after the patch installation. The status of these instances is
	// NON_COMPLIANT.
	InstancesWithInstalledPendingRebootPatches *int32
	// The number of instances with patches installed that are specified in a
	// RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically
	// installed before they were added to a RejectedPatches list. If
	// ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value
	// of InstancesWithInstalledRejectedPatches will always be 0 (zero).
	InstancesWithInstalledRejectedPatches *int32
	// The number of instances with patches that aren't applicable.
	InstancesWithNotApplicablePatches *int32
	// The number of instances with patches installed that aren't defined in the patch
	// baseline.
	InstancesWithInstalledOtherPatches *int32
	// The number of instances with missing patches from the patch baseline.
	InstancesWithMissingPatches *int32
	// The number of instances in the patch group.
	Instances *int32

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

type DescribePatchGroupsInput

type DescribePatchGroupsInput struct {
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of patch groups to return (per page).
	MaxResults *int32
	// One or more filters. Use a filter to return a more specific list of results. For
	// DescribePatchGroups,valid filter keys include the following:
	//
	//     * NAME_PREFIX:
	// The name of the patch group. Wildcards (*) are accepted.
	//
	//     *
	// OPERATING_SYSTEM: The supported operating system type to return results for. For
	// valid operating system values, see
	// GetDefaultPatchBaselineRequest$OperatingSystem () in CreatePatchBaseline ().
	// Examples:
	//
	//         * --filters Key=NAME_PREFIX,Values=MyPatchGroup*
	//
	//         *
	// --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2
	Filters []*types.PatchOrchestratorFilter
}

type DescribePatchGroupsOutput

type DescribePatchGroupsOutput struct {
	// Each entry in the array contains: PatchGroup: string (between 1 and 256
	// characters, Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$) PatchBaselineIdentity: A
	// PatchBaselineIdentity element.
	Mappings []*types.PatchGroupPatchBaselineMapping
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type DescribePatchPropertiesInput

type DescribePatchPropertiesInput struct {
	// The patch property for which you want to view patch details.
	Property types.PatchProperty
	// The operating system type for which to list patches.
	OperatingSystem types.OperatingSystem
	// Indicates whether to list patches for the Windows operating system or for
	// Microsoft applications. Not applicable for Linux operating systems.
	PatchSet types.PatchSet
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type DescribePatchPropertiesOutput

type DescribePatchPropertiesOutput struct {
	// The token for the next set of items to return. (You use this token in the next
	// call.)
	NextToken *string
	// A list of the properties for patches matching the filter request parameters.
	Properties []map[string]*string

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

type DescribeSessionsInput

type DescribeSessionsInput struct {
	// The session status to retrieve a list of sessions for. For example, "Active".
	State types.SessionState
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// One or more filters to limit the type of sessions returned by the request.
	Filters []*types.SessionFilter
}

type DescribeSessionsOutput

type DescribeSessionsOutput struct {
	// A list of sessions meeting the request parameters.
	Sessions []*types.Session
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string

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

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

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

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

type EndpointResolverFunc

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

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

func (EndpointResolverFunc) ResolveEndpoint

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

type GetAutomationExecutionInput

type GetAutomationExecutionInput struct {
	// The unique identifier for an existing automation execution to examine. The
	// execution ID is returned by StartAutomationExecution when the execution of an
	// Automation document is initiated.
	AutomationExecutionId *string
}

type GetAutomationExecutionOutput

type GetAutomationExecutionOutput struct {
	// Detailed information about the current state of an automation execution.
	AutomationExecution *types.AutomationExecution

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

type GetCalendarStateInput

type GetCalendarStateInput struct {
	// (Optional) The specific time for which you want to get calendar state
	// information, in ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) format. If you
	// do not add AtTime, the current time is assumed.
	AtTime *string
	// The names or Amazon Resource Names (ARNs) of the Systems Manager documents that
	// represent the calendar entries for which you want to get the state.
	CalendarNames []*string
}

type GetCalendarStateOutput

type GetCalendarStateOutput struct {
	// The state of the calendar. An OPEN calendar indicates that actions are allowed
	// to proceed, and a CLOSED calendar indicates that actions are not allowed to
	// proceed.
	State types.CalendarState
	// The time, as an ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) string, that
	// you specified in your command. If you did not specify a time, GetCalendarState
	// uses the current time.
	AtTime *string
	// The time, as an ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) string, that
	// the calendar state will change. If the current calendar state is OPEN,
	// NextTransitionTime indicates when the calendar state changes to CLOSED, and
	// vice-versa.
	NextTransitionTime *string

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

type GetCommandInvocationInput

type GetCommandInvocationInput struct {
	// (Optional) The name of the plugin for which you want detailed results. If the
	// document contains only one plugin, the name can be omitted and the details will
	// be returned. Plugin names are also referred to as step names in Systems Manager
	// documents.
	PluginName *string
	// (Required) The parent command ID of the invocation plugin.
	CommandId *string
	// (Required) The ID of the managed instance targeted by the command. A managed
	// instance can be an EC2 instance or an instance in your hybrid environment that
	// is configured for Systems Manager.
	InstanceId *string
}

type GetCommandInvocationOutput

type GetCommandInvocationOutput struct {
	// The date and time the plugin was finished running. Date and time are written in
	// ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The
	// following sample AWS CLI command uses the InvokedAfter filter. aws ssm
	// list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If the
	// plugin has not started to run, the string is empty.
	ExecutionEndDateTime *string
	// The parent command ID of the invocation plugin.
	CommandId *string
	// The URL for the complete text written by the plugin to stdout in Amazon S3. If
	// an S3 bucket was not specified, then this string is empty.
	StandardOutputUrl *string
	// The URL for the complete text written by the plugin to stderr. If the command
	// has not finished running, then this string is empty.
	StandardErrorUrl *string
	// The name of the document that was run. For example, AWS-RunShellScript.
	DocumentName *string
	// The error level response code for the plugin script. If the response code is -1,
	// then the command has not started running on the instance, or it was not received
	// by the instance.
	ResponseCode *int32
	// The name of the plugin for which you want detailed results. For example,
	// aws:RunShellScript is a plugin.
	PluginName *string
	// A detailed status of the command execution for an invocation. StatusDetails
	// includes more information than Status because it includes states resulting from
	// error and concurrency control parameters. StatusDetails can show different
	// results than Status. For more information about these statuses, see
	// Understanding command statuses
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
	// in the AWS Systems Manager User Guide. StatusDetails can be one of the following
	// values:  <ul> <li> <p>Pending: The command has not been sent to the
	// instance.</p> </li> <li> <p>In Progress: The command has been sent to the
	// instance but has not reached a terminal state.</p> </li> <li> <p>Delayed: The
	// system attempted to send the command to the target, but the target was not
	// available. The instance might not be available because of network issues,
	// because the instance was stopped, or for similar reasons. The system will try to
	// send the command again.</p> </li> <li> <p>Success: The command or plugin ran
	// successfully. This is a terminal state.</p> </li> <li> <p>Delivery Timed Out:
	// The command was not delivered to the instance before the delivery timeout
	// expired. Delivery timeouts do not count against the parent command's MaxErrors
	// limit, but they do contribute to whether the parent command status is Success or
	// Incomplete. This is a terminal state.</p> </li> <li> <p>Execution Timed Out: The
	// command started to run on the instance, but the execution was not complete
	// before the timeout expired. Execution timeouts count against the MaxErrors limit
	// of the parent command. This is a terminal state.</p> </li> <li> <p>Failed: The
	// command wasn't run successfully on the instance. For a plugin, this indicates
	// that the result code was not zero. For a command invocation, this indicates that
	// the result code for one or more plugins was not zero. Invocation failures count
	// against the MaxErrors limit of the parent command. This is a terminal state.</p>
	// </li> <li> <p>Canceled: The command was terminated before it was completed. This
	// is a terminal state.</p> </li> <li> <p>Undeliverable: The command can't be
	// delivered to the instance. The instance might not exist or might not be
	// responding. Undeliverable invocations don't count against the parent command's
	// MaxErrors limit and don't contribute to whether the parent command status is
	// Success or Incomplete. This is a terminal state.</p> </li> <li> <p>Terminated:
	// The parent command exceeded its MaxErrors limit and subsequent command
	// invocations were canceled by the system. This is a terminal state.</p> </li>
	// </ul>
	StatusDetails *string
	// The date and time the plugin started running. Date and time are written in ISO
	// 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The
	// following sample AWS CLI command uses the InvokedBefore filter. aws ssm
	// list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If the
	// plugin has not started to run, the string is empty.
	ExecutionStartDateTime *string
	// The ID of the managed instance targeted by the command. A managed instance can
	// be an EC2 instance or an instance in your hybrid environment that is configured
	// for Systems Manager.
	InstanceId *string
	// The first 24,000 characters written by the plugin to stdout. If the command has
	// not finished running, if ExecutionStatus is neither Succeeded nor Failed, then
	// this string is empty.
	StandardOutputContent *string
	// The comment text for the command.
	Comment *string
	// Duration since ExecutionStartDateTime.
	ExecutionElapsedTime *string
	// The first 8,000 characters written by the plugin to stderr. If the command has
	// not finished running, then this string is empty.
	StandardErrorContent *string
	// The SSM document version used in the request.
	DocumentVersion *string
	// The status of this invocation plugin. This status can be different than
	// StatusDetails.
	Status types.CommandInvocationStatus
	// CloudWatch Logs information where Systems Manager sent the command output.
	CloudWatchOutputConfig *types.CloudWatchOutputConfig

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

type GetConnectionStatusInput

type GetConnectionStatusInput struct {
	// The ID of the instance.
	Target *string
}

type GetConnectionStatusOutput

type GetConnectionStatusOutput struct {
	// The status of the connection to the instance. For example, 'Connected' or 'Not
	// Connected'.
	Status types.ConnectionStatus
	// The ID of the instance to check connection status.
	Target *string

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

type GetDefaultPatchBaselineInput

type GetDefaultPatchBaselineInput struct {
	// Returns the default patch baseline for the specified operating system.
	OperatingSystem types.OperatingSystem
}

type GetDefaultPatchBaselineOutput

type GetDefaultPatchBaselineOutput struct {
	// The operating system for the returned patch baseline.
	OperatingSystem types.OperatingSystem
	// The ID of the default patch baseline.
	BaselineId *string

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

type GetDeployablePatchSnapshotForInstanceInput

type GetDeployablePatchSnapshotForInstanceInput struct {
	// The ID of the instance for which the appropriate patch snapshot should be
	// retrieved.
	InstanceId *string
	// The user-defined snapshot ID.
	SnapshotId *string
}

type GetDeployablePatchSnapshotForInstanceOutput

type GetDeployablePatchSnapshotForInstanceOutput struct {
	// The user-defined snapshot ID.
	SnapshotId *string
	// The ID of the instance.
	InstanceId *string
	// Returns the specific operating system (for example Windows Server 2012 or Amazon
	// Linux 2015.09) on the instance for the specified patch snapshot.
	Product *string
	// A pre-signed Amazon S3 URL that can be used to download the patch snapshot.
	SnapshotDownloadUrl *string

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

type GetDocumentInput

type GetDocumentInput struct {
	// Returns the document in the specified format. The document format can be either
	// JSON or YAML. JSON is the default format.
	DocumentFormat types.DocumentFormat
	// The document version for which you want information.
	DocumentVersion *string
	// The name of the Systems Manager document.
	Name *string
	// An optional field specifying the version of the artifact associated with the
	// document. For example, "Release 12, Update 6". This value is unique across all
	// versions of a document and can't be changed.
	VersionName *string
}

type GetDocumentOutput

type GetDocumentOutput struct {
	// The name of the Systems Manager document.
	Name *string
	// The document version.
	DocumentVersion *string
	// The document type.
	DocumentType types.DocumentType
	// The contents of the Systems Manager document.
	Content *string
	// A list of SSM documents required by a document. For example, an
	// ApplicationConfiguration document requires an ApplicationConfigurationSchema
	// document.
	Requires []*types.DocumentRequires
	// A description of the document attachments, including names, locations, sizes,
	// and so on.
	AttachmentsContent []*types.AttachmentContent
	// The version of the artifact associated with the document. For example, "Release
	// 12, Update 6". This value is unique across all versions of a document, and
	// cannot be changed.
	VersionName *string
	// A message returned by AWS Systems Manager that explains the Status value. For
	// example, a Failed status might be explained by the StatusInformation message,
	// "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is
	// correct."
	StatusInformation *string
	// The document format, either JSON or YAML.
	DocumentFormat types.DocumentFormat
	// The status of the Systems Manager document, such as Creating, Active, Updating,
	// Failed, and Deleting.
	Status types.DocumentStatus

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

type GetInventoryInput

type GetInventoryInput struct {
	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*types.InventoryFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// Returns counts of inventory types based on one or more expressions. For example,
	// if you aggregate by using an expression that uses the
	// AWS:InstanceInformation.PlatformType type, you can see a count of how many
	// Windows and Linux instances exist in your inventoried fleet.
	Aggregators []*types.InventoryAggregator
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The list of inventory item types to return.
	ResultAttributes []*types.ResultAttribute
}

type GetInventoryOutput

type GetInventoryOutput struct {
	// Collection of inventory entities such as a collection of instance inventory.
	Entities []*types.InventoryResultEntity
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type GetInventorySchemaInput

type GetInventorySchemaInput struct {
	// The type of inventory item to return.
	TypeName *string
	// Returns the sub-type schema for a specified inventory type.
	SubType *bool
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// Returns inventory schemas that support aggregation. For example, this call
	// returns the AWS:InstanceInformation type, because it supports aggregation based
	// on the PlatformName, PlatformType, and PlatformVersion attributes.
	Aggregator *bool
}

type GetInventorySchemaOutput

type GetInventorySchemaOutput struct {
	// Inventory schemas returned by the request.
	Schemas []*types.InventoryItemSchema
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type GetMaintenanceWindowExecutionInput

type GetMaintenanceWindowExecutionInput struct {
	// The ID of the maintenance window execution that includes the task.
	WindowExecutionId *string
}

type GetMaintenanceWindowExecutionOutput

type GetMaintenanceWindowExecutionOutput struct {
	// The time the maintenance window started running.
	StartTime *time.Time
	// The details explaining the Status. Only available for certain status values.
	StatusDetails *string
	// The ID of the maintenance window execution.
	WindowExecutionId *string
	// The ID of the task executions from the maintenance window execution.
	TaskIds []*string
	// The time the maintenance window finished running.
	EndTime *time.Time
	// The status of the maintenance window execution.
	Status types.MaintenanceWindowExecutionStatus

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

type GetMaintenanceWindowExecutionTaskInput

type GetMaintenanceWindowExecutionTaskInput struct {
	// The ID of the specific task execution in the maintenance window task that should
	// be retrieved.
	TaskId *string
	// The ID of the maintenance window execution that includes the task.
	WindowExecutionId *string
}

type GetMaintenanceWindowExecutionTaskInvocationInput

type GetMaintenanceWindowExecutionTaskInvocationInput struct {
	// The invocation ID to retrieve.
	InvocationId *string
	// The ID of the specific task in the maintenance window task that should be
	// retrieved.
	TaskId *string
	// The ID of the maintenance window execution for which the task is a part.
	WindowExecutionId *string
}

type GetMaintenanceWindowExecutionTaskInvocationOutput

type GetMaintenanceWindowExecutionTaskInvocationOutput struct {
	// The task execution ID.
	TaskExecutionId *string
	// User-provided value to be included in any CloudWatch events raised while running
	// tasks for these targets in this maintenance window.
	OwnerInformation *string
	// The task status for an invocation.
	Status types.MaintenanceWindowExecutionStatus
	// The maintenance window execution ID.
	WindowExecutionId *string
	// The time that the task finished running on the target.
	EndTime *time.Time
	// The parameters used at the time that the task ran.
	Parameters *string
	// The time that the task started running on the target.
	StartTime *time.Time
	// The details explaining the status. Details are only available for certain status
	// values.
	StatusDetails *string
	// Retrieves the task type for a maintenance window. Task types include the
	// following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.
	TaskType types.MaintenanceWindowTaskType
	// The invocation ID.
	InvocationId *string
	// The maintenance window target ID.
	WindowTargetId *string
	// The execution ID.
	ExecutionId *string

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

type GetMaintenanceWindowExecutionTaskOutput

type GetMaintenanceWindowExecutionTaskOutput struct {
	// The defined maximum number of task executions that could be run in parallel.
	MaxConcurrency *string
	// The time the task execution started.
	StartTime *time.Time
	// The details explaining the Status. Only available for certain status values.
	StatusDetails *string
	// The role that was assumed when running the task.
	ServiceRole *string
	// The defined maximum number of task execution errors allowed before scheduling of
	// the task execution would have been stopped.
	MaxErrors *string
	// The type of task that was run.
	Type types.MaintenanceWindowTaskType
	// The ID of the specific task execution in the maintenance window task that was
	// retrieved.
	TaskExecutionId *string
	// The status of the task.
	Status types.MaintenanceWindowExecutionStatus
	// The ID of the maintenance window execution that includes the task.
	WindowExecutionId *string
	// The time the task execution completed.
	EndTime *time.Time
	// The priority of the task.
	Priority *int32
	// The parameters passed to the task when it was run. TaskParameters has been
	// deprecated. To specify parameters to pass to a task when it runs, instead use
	// the Parameters option in the TaskInvocationParameters structure. For information
	// about how Systems Manager handles these options for the supported maintenance
	// window task types, see MaintenanceWindowTaskInvocationParameters (). The map has
	// the following format: Key: string, between 1 and 255 characters Value: an array
	// of strings, each string is between 1 and 255 characters
	TaskParameters []map[string]*types.MaintenanceWindowTaskParameterValueExpression
	// The ARN of the task that ran.
	TaskArn *string

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

type GetMaintenanceWindowInput

type GetMaintenanceWindowInput struct {
	// The ID of the maintenance window for which you want to retrieve information.
	WindowId *string
}

type GetMaintenanceWindowOutput

type GetMaintenanceWindowOutput struct {
	// The date and time, in ISO-8601 Extended format, for when the maintenance window
	// is scheduled to become inactive. The maintenance window will not run after this
	// specified time.
	EndDate *string
	// The date the maintenance window was created.
	CreatedDate *time.Time
	// The ID of the created maintenance window.
	WindowId *string
	// The date the maintenance window was last modified.
	ModifiedDate *time.Time
	// The number of days to wait to run a maintenance window after the scheduled CRON
	// expression date and time.
	ScheduleOffset *int32
	// The next time the maintenance window will actually run, taking into account any
	// specified times for the maintenance window to become active or inactive.
	NextExecutionTime *string
	// The name of the maintenance window.
	Name *string
	// The date and time, in ISO-8601 Extended format, for when the maintenance window
	// is scheduled to become active. The maintenance window will not run before this
	// specified time.
	StartDate *string
	// The duration of the maintenance window in hours.
	Duration *int32
	// Indicates whether the maintenance window is enabled.
	Enabled *bool
	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int32
	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string
	// Whether targets must be registered with the maintenance window before tasks can
	// be defined for those targets.
	AllowUnassociatedTargets *bool
	// The description of the maintenance window.
	Description *string
	// The time zone that the scheduled maintenance window executions are based on, in
	// Internet Assigned Numbers Authority (IANA) format. For example:
	// "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the
	// Time Zone Database (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string

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

type GetMaintenanceWindowTaskInput

type GetMaintenanceWindowTaskInput struct {
	// The maintenance window task ID to retrieve.
	WindowTaskId *string
	// The maintenance window ID that includes the task to retrieve.
	WindowId *string
}

type GetMaintenanceWindowTaskOutput

type GetMaintenanceWindowTaskOutput struct {
	// The retrieved task name.
	Name *string
	// The resource that the task used during execution. For RUN_COMMAND and AUTOMATION
	// task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA
	// tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value
	// is the state machine ARN.
	TaskArn *string
	// The maximum number of errors allowed before the task stops being scheduled.
	MaxErrors *string
	// The location in Amazon S3 where the task results are logged. LoggingInfo has
	// been deprecated. To specify an S3 bucket to contain logs, instead use the
	// OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options for
	// the supported maintenance window task types, see
	// MaintenanceWindowTaskInvocationParameters ().
	LoggingInfo *types.LoggingInfo
	// The retrieved maintenance window ID.
	WindowId *string
	// The targets where the task should run.
	Targets []*types.Target
	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for maintenance window Run Command tasks.
	ServiceRoleArn *string
	// The priority of the task when it runs. The lower the number, the higher the
	// priority. Tasks that have the same priority are scheduled in parallel.
	Priority *int32
	// The type of task to run.
	TaskType types.MaintenanceWindowTaskType
	// The parameters to pass to the task when it runs. TaskParameters has been
	// deprecated. To specify parameters to pass to a task when it runs, instead use
	// the Parameters option in the TaskInvocationParameters structure. For information
	// about how Systems Manager handles these options for the supported maintenance
	// window task types, see MaintenanceWindowTaskInvocationParameters ().
	TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression
	// The parameters to pass to the task when it runs.
	TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters
	// The retrieved task description.
	Description *string
	// The retrieved maintenance window task ID.
	WindowTaskId *string
	// The maximum number of targets allowed to run this task in parallel.
	MaxConcurrency *string

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

type GetOpsItemInput

type GetOpsItemInput struct {
	// The ID of the OpsItem that you want to get.
	OpsItemId *string
}

type GetOpsItemOutput

type GetOpsItemOutput struct {
	// The OpsItem.
	OpsItem *types.OpsItem

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

type GetOpsSummaryInput

type GetOpsSummaryInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// Optional aggregators that return counts of OpsItems based on one or more
	// expressions.
	Aggregators []*types.OpsAggregator
	// Optional filters used to scope down the returned OpsItems.
	Filters []*types.OpsFilter
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// Specify the name of a resource data sync to get.
	SyncName *string
	// The OpsItem data type to return.
	ResultAttributes []*types.OpsResultAttribute
}

type GetOpsSummaryOutput

type GetOpsSummaryOutput struct {
	// The list of aggregated and filtered OpsItems.
	Entities []*types.OpsEntity
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type GetParameterHistoryInput

type GetParameterHistoryInput struct {
	// The name of a parameter you want to query.
	Name *string
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// Return decrypted values for secure string parameters. This flag is ignored for
	// String and StringList parameter types.
	WithDecryption *bool
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type GetParameterHistoryOutput

type GetParameterHistoryOutput struct {
	// A list of parameters returned by the request.
	Parameters []*types.ParameterHistory
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type GetParameterInput

type GetParameterInput struct {
	// Return decrypted values for secure string parameters. This flag is ignored for
	// String and StringList parameter types.
	WithDecryption *bool
	// The name of the parameter you want to query.
	Name *string
}

type GetParameterOutput

type GetParameterOutput struct {
	// Information about a parameter.
	Parameter *types.Parameter

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

type GetParametersByPathInput

type GetParametersByPathInput struct {
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// Retrieve all parameters within a hierarchy. If a user has access to a path, then
	// the user can access all levels of that path. For example, if a user has
	// permission to access path /a, then the user can also access /a/b. Even if a user
	// has explicitly been denied access in IAM for parameter /a/b, they can still call
	// the GetParametersByPath API action recursively for /a and view /a/b.
	Recursive *bool
	// The hierarchy for the parameter. Hierarchies start with a forward slash (/) and
	// end with the parameter name. A parameter name hierarchy can have a maximum of 15
	// levels. Here is an example of a hierarchy:
	// /Finance/Prod/IAD/WinServ2016/license33
	Path *string
	// Filters to limit the request results.
	ParameterFilters []*types.ParameterStringFilter
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// Retrieve all parameters in a hierarchy with their value decrypted.
	WithDecryption *bool
}

type GetParametersByPathOutput

type GetParametersByPathOutput struct {
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string
	// A list of parameters found in the specified hierarchy.
	Parameters []*types.Parameter

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

type GetParametersInput

type GetParametersInput struct {
	// Return decrypted secure string value. Return decrypted values for secure string
	// parameters. This flag is ignored for String and StringList parameter types.
	WithDecryption *bool
	// Names of the parameters for which you want to query information.
	Names []*string
}

type GetParametersOutput

type GetParametersOutput struct {
	// A list of parameters that are not formatted correctly or do not run during an
	// execution.
	InvalidParameters []*string
	// A list of details for a parameter.
	Parameters []*types.Parameter

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

type GetPatchBaselineForPatchGroupInput

type GetPatchBaselineForPatchGroupInput struct {
	// The name of the patch group whose patch baseline should be retrieved.
	PatchGroup *string
	// Returns he operating system rule specified for patch groups using the patch
	// baseline.
	OperatingSystem types.OperatingSystem
}

type GetPatchBaselineForPatchGroupOutput

type GetPatchBaselineForPatchGroupOutput struct {
	// The name of the patch group.
	PatchGroup *string
	// The ID of the patch baseline that should be used for the patch group.
	BaselineId *string
	// The operating system rule specified for patch groups using the patch baseline.
	OperatingSystem types.OperatingSystem

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

type GetPatchBaselineInput

type GetPatchBaselineInput struct {
	// The ID of the patch baseline to retrieve.
	BaselineId *string
}

type GetPatchBaselineOutput

type GetPatchBaselineOutput struct {
	// A set of global filters used to exclude patches from the baseline.
	GlobalFilters *types.PatchFilterGroup
	// Returns the specified compliance severity level for approved patches in the
	// patch baseline.
	ApprovedPatchesComplianceLevel types.PatchComplianceLevel
	// The date the patch baseline was last modified.
	ModifiedDate *time.Time
	// Patch groups included in the patch baseline.
	PatchGroups []*string
	// A list of explicitly approved patches for the baseline.
	ApprovedPatches []*string
	// The action specified to take on patches included in the RejectedPatches list. A
	// patch can be allowed only if it is a dependency of another package, or blocked
	// entirely along with packages that include it as a dependency.
	RejectedPatchesAction types.PatchAction
	// A set of rules used to include patches in the baseline.
	ApprovalRules *types.PatchRuleGroup
	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*types.PatchSource
	// A list of explicitly rejected patches for the baseline.
	RejectedPatches []*string
	// The name of the patch baseline.
	Name *string
	// Returns the operating system specified for the patch baseline.
	OperatingSystem types.OperatingSystem
	// The ID of the retrieved patch baseline.
	BaselineId *string
	// The date the patch baseline was created.
	CreatedDate *time.Time
	// A description of the patch baseline.
	Description *string
	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool

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

type GetServiceSettingInput

type GetServiceSettingInput struct {
	// The ID of the service setting to get. The setting ID can be
	// /ssm/parameter-store/default-parameter-tier,
	// /ssm/parameter-store/high-throughput-enabled, or
	// /ssm/managed-instance/activation-tier.
	SettingId *string
}

The request body of the GetServiceSetting API action.

type GetServiceSettingOutput

type GetServiceSettingOutput struct {
	// The query result of the current service setting.
	ServiceSetting *types.ServiceSetting

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

The query result body of the GetServiceSetting API action.

type HTTPClient

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

type HTTPSignerV4

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

type IdempotencyTokenProvider

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

IdempotencyTokenProvider interface for providing idempotency token

type LabelParameterVersionInput

type LabelParameterVersionInput struct {
	// The specific version of the parameter on which you want to attach one or more
	// labels. If no version is specified, the system attaches the label to the latest
	// version.
	ParameterVersion *int64
	// One or more labels to attach to the specified parameter version.
	Labels []*string
	// The parameter name on which you want to attach one or more labels.
	Name *string
}

type LabelParameterVersionOutput

type LabelParameterVersionOutput struct {
	// The version of the parameter that has been labeled.
	ParameterVersion *int64
	// The label does not meet the requirements. For information about parameter label
	// requirements, see Labeling parameters
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html)
	// in the AWS Systems Manager User Guide.
	InvalidLabels []*string

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

type ListAssociationVersionsInput

type ListAssociationVersionsInput struct {
	// The association ID for which you want to view all versions.
	AssociationId *string
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type ListAssociationVersionsOutput

type ListAssociationVersionsOutput struct {
	// Information about all versions of the association for the specified association
	// ID.
	AssociationVersions []*types.AssociationVersionInfo
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type ListAssociationsInput

type ListAssociationsInput struct {
	// One or more filters. Use a filter to return a more specific list of results.
	AssociationFilterList []*types.AssociationFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type ListAssociationsOutput

type ListAssociationsOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// The associations.
	Associations []*types.Association

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

type ListCommandInvocationsInput

type ListCommandInvocationsInput struct {
	// (Optional) If set this returns the response of the command executions and any
	// command output. By default this is set to False.
	Details *bool
	// (Optional) The invocations for a specific command ID.
	CommandId *string
	// (Optional) The maximum number of items to return for this call. The call also
	// returns a token that you can specify in a subsequent call to get the next set of
	// results.
	MaxResults *int32
	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string
	// (Optional) One or more filters. Use a filter to return a more specific list of
	// results.
	Filters []*types.CommandFilter
	// (Optional) The command execution details for a specific instance ID.
	InstanceId *string
}

type ListCommandInvocationsOutput

type ListCommandInvocationsOutput struct {
	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string
	// (Optional) A list of all invocations.
	CommandInvocations []*types.CommandInvocation

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

type ListCommandsInput

type ListCommandsInput struct {
	// (Optional) The maximum number of items to return for this call. The call also
	// returns a token that you can specify in a subsequent call to get the next set of
	// results.
	MaxResults *int32
	// (Optional) Lists commands issued against this instance ID. You can't specify an
	// instance ID in the same command that you specify Status = Pending. This is
	// because the command has not reached the instance yet.
	InstanceId *string
	// (Optional) If provided, lists only the specified command.
	CommandId *string
	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string
	// (Optional) One or more filters. Use a filter to return a more specific list of
	// results.
	Filters []*types.CommandFilter
}

type ListCommandsOutput

type ListCommandsOutput struct {
	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string
	// (Optional) The list of commands requested by the user.
	Commands []*types.Command

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

type ListComplianceItemsInput

type ListComplianceItemsInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The ID for the resources from which to get compliance information. Currently,
	// you can only specify one resource ID.
	ResourceIds []*string
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// The type of resource from which to get compliance information. Currently, the
	// only supported resource type is ManagedInstance.
	ResourceTypes []*string
	// One or more compliance filters. Use a filter to return a more specific list of
	// results.
	Filters []*types.ComplianceStringFilter
}

type ListComplianceItemsOutput

type ListComplianceItemsOutput struct {
	// A list of compliance information for the specified resource ID.
	ComplianceItems []*types.ComplianceItem
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type ListComplianceSummariesInput

type ListComplianceSummariesInput struct {
	// The maximum number of items to return for this call. Currently, you can specify
	// null or 50. The call also returns a token that you can specify in a subsequent
	// call to get the next set of results.
	MaxResults *int32
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// One or more compliance or inventory filters. Use a filter to return a more
	// specific list of results.
	Filters []*types.ComplianceStringFilter
}

type ListComplianceSummariesOutput

type ListComplianceSummariesOutput struct {
	// A list of compliant and non-compliant summary counts based on compliance types.
	// For example, this call returns State Manager associations, patches, or custom
	// compliance types according to the filter criteria that you specified.
	ComplianceSummaryItems []*types.ComplianceSummaryItem
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string

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

type ListDocumentVersionsInput

type ListDocumentVersionsInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The name of the document. You can specify an Amazon Resource Name (ARN).
	Name *string
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
}

type ListDocumentVersionsOutput

type ListDocumentVersionsOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// The document versions.
	DocumentVersions []*types.DocumentVersionInfo

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

type ListDocumentsInput

type ListDocumentsInput struct {
	// This data type is deprecated. Instead, use Filters.
	DocumentFilterList []*types.DocumentFilter
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// One or more DocumentKeyValuesFilter objects. Use a filter to return a more
	// specific list of results. For keys, you can specify one or more key-value pair
	// tags that have been applied to a document. Other valid keys include Owner, Name,
	// PlatformTypes, DocumentType, and TargetType. For example, to return documents
	// you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the
	// format Key=tag:tagName,Values=valueName.
	Filters []*types.DocumentKeyValuesFilter
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type ListDocumentsOutput

type ListDocumentsOutput struct {
	// The names of the Systems Manager documents.
	DocumentIdentifiers []*types.DocumentIdentifier
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string

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

type ListInventoryEntriesInput

type ListInventoryEntriesInput struct {
	// The token for the next set of items to return. (You received this token from a
	// previous call.)
	NextToken *string
	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*types.InventoryFilter
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// The type of inventory item for which you want information.
	TypeName *string
	// The instance ID for which you want inventory information.
	InstanceId *string
}

type ListInventoryEntriesOutput

type ListInventoryEntriesOutput struct {
	// The token to use when requesting the next set of items. If there are no
	// additional items to return, the string is empty.
	NextToken *string
	// A list of inventory items on the instance(s).
	Entries []map[string]*string
	// The inventory schema version used by the instance(s).
	SchemaVersion *string
	// The type of inventory item returned by the request.
	TypeName *string
	// The time that inventory information was collected for the instance(s).
	CaptureTime *string
	// The instance ID targeted by the request to query inventory information.
	InstanceId *string

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

type ListResourceComplianceSummariesInput

type ListResourceComplianceSummariesInput struct {
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*types.ComplianceStringFilter
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
}

type ListResourceComplianceSummariesOutput

type ListResourceComplianceSummariesOutput struct {
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string
	// A summary count for specified or targeted managed instances. Summary count
	// includes information about compliant and non-compliant State Manager
	// associations, patch status, or custom items according to the filter criteria
	// that you specify.
	ResourceComplianceSummaryItems []*types.ResourceComplianceSummaryItem

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

type ListResourceDataSyncInput

type ListResourceDataSyncInput struct {
	// The maximum number of items to return for this call. The call also returns a
	// token that you can specify in a subsequent call to get the next set of results.
	MaxResults *int32
	// View a list of resource data syncs according to the sync type. Specify
	// SyncToDestination to view resource data syncs that synchronize data to an Amazon
	// S3 buckets. Specify SyncFromSource to view resource data syncs from AWS
	// Organizations or from multiple AWS Regions.
	SyncType *string
	// A token to start the list. Use this token to get the next set of results.
	NextToken *string
}

type ListResourceDataSyncOutput

type ListResourceDataSyncOutput struct {
	// The token for the next set of items to return. Use this token to get the next
	// set of results.
	NextToken *string
	// A list of your current Resource Data Sync configurations and their statuses.
	ResourceDataSyncItems []*types.ResourceDataSyncItem

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

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// Returns a list of tags for a specific resource type.
	ResourceType types.ResourceTypeForTagging
	// The resource ID for which you want to see a list of tags.
	ResourceId *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// A list of tags.
	TagList []*types.Tag

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

type ModifyDocumentPermissionInput

type ModifyDocumentPermissionInput struct {
	// The permission type for the document. The permission type can be Share.
	PermissionType types.DocumentPermissionType
	// The name of the document that you want to share.
	Name *string
	// The AWS user accounts that should have access to the document. The account IDs
	// can either be a group of account IDs or All.
	AccountIdsToAdd []*string
	// The AWS user accounts that should no longer have access to the document. The AWS
	// user account can either be a group of account IDs or All. This action has a
	// higher priority than AccountIdsToAdd. If you specify an account ID to add and
	// the same ID to remove, the system removes access to the document.
	AccountIdsToRemove []*string
	// (Optional) The version of the document to share. If it's not specified, the
	// system choose the Default version to share.
	SharedDocumentVersion *string
}

type ModifyDocumentPermissionOutput

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

type Options

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

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

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

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

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

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetIdempotencyTokenProvider

func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PutComplianceItemsInput

type PutComplianceItemsInput struct {
	// Specify an ID for this resource. For a managed instance, this is the instance
	// ID.
	ResourceId *string
	// MD5 or SHA-256 content hash. The content hash is used to determine if existing
	// information should be overwritten or ignored. If the content hashes match, the
	// request to put compliance information is ignored.
	ItemContentHash *string
	// A summary of the call execution that includes an execution ID, the type of
	// execution (for example, Command), and the date/time of the execution using a
	// datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
	ExecutionSummary *types.ComplianceExecutionSummary
	// The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In
	// COMPLETE mode, the system overwrites all existing compliance information for the
	// resource. You must provide a full list of compliance items each time you send
	// the request. In PARTIAL mode, the system overwrites compliance information for a
	// specific association. The association must be configured with SyncCompliance set
	// to MANUAL. By default, all requests use COMPLETE mode. This attribute is only
	// valid for association compliance.
	UploadType types.ComplianceUploadType
	// Information about the compliance as defined by the resource type. For example,
	// for a patch compliance type, Items includes information about the PatchSeverity,
	// Classification, and so on.
	Items []*types.ComplianceItemEntry
	// Specify the compliance type. For example, specify Association (for a State
	// Manager association), Patch, or Custom:string.
	ComplianceType *string
	// Specify the type of resource. ManagedInstance is currently the only supported
	// resource type.
	ResourceType *string
}

type PutComplianceItemsOutput

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

type PutInventoryInput

type PutInventoryInput struct {
	// The inventory items that you want to add or update on instances.
	Items []*types.InventoryItem
	// An instance ID where you want to add or update inventory items.
	InstanceId *string
}

type PutInventoryOutput

type PutInventoryOutput struct {
	// Information about the request.
	Message *string

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

type PutParameterInput

type PutParameterInput struct {
	// The type of parameter that you want to add to the system. SecureString is not
	// currently supported for AWS CloudFormation templates or in the China Regions.
	// Items in a StringList must be separated by a comma (,). You can't use other
	// punctuation or special character to escape items in the list. If you have a
	// parameter value that requires a comma, then use the String data type. Specifying
	// a parameter type is not required when updating a parameter. You must specify a
	// parameter type when creating a parameter.
	Type types.ParameterType
	// Optional metadata that you assign to a resource. Tags enable you to categorize a
	// resource in different ways, such as by purpose, owner, or environment. For
	// example, you might want to tag a Systems Manager parameter to identify the type
	// of resource to which it applies, the environment, or the type of configuration
	// data referenced by the parameter. In this case, you could specify the following
	// key name/value pairs:  <ul> <li> <p> <code>Key=Resource,Value=S3bucket</code>
	// </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> <li> <p>
	// <code>Key=ParameterType,Value=LicenseKey</code> </p> </li> </ul> <note> <p>To
	// add tags to an existing Systems Manager parameter, use the
	// <a>AddTagsToResource</a> action.</p> </note>
	Tags []*types.Tag
	// One or more policies to apply to a parameter. This action takes a JSON array.
	// Parameter Store supports the following policy types:  <p>Expiration: This policy
	// deletes the parameter after it expires. When you create the policy,  you specify
	// the expiration date. You can update the expiration date and time by updating the
	// policy. Updating the parameter does not affect the expiration date and time.
	// When the expiration time is reached, Parameter Store deletes the parameter.
	// ExpirationNotification: This policy triggers an event in Amazon CloudWatch
	// Events that notifies you about the expiration. By using this policy, you can
	// receive notification before or after the expiration time is reached, in units of
	// days or hours. NoChangeNotification: This policy triggers a CloudWatch event if
	// a parameter has not been modified for a specified period of time. This policy
	// type is useful when, for example, a secret needs to be changed within a period
	// of time, but it has not been changed.  <p>All existing policies are preserved
	// until you send new policies or an empty policy. For more  information about
	// parameter policies, see Assigning parameter policies
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html).
	Policies *string
	// Overwrite an existing parameter. If not specified, will default to "false".
	Overwrite *bool
	// A regular expression used to validate the parameter value. For example, for
	// String types with values restricted to numbers, you can specify the following:
	// AllowedPattern=^\d+$
	AllowedPattern *string
	// The parameter value that you want to add to the system. Standard parameters have
	// a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
	Value *string
	// The KMS Key ID that you want to use to encrypt a parameter. Either the default
	// AWS Key Management Service (AWS KMS) key automatically assigned to your AWS
	// account or a custom key. Required for parameters that use the SecureString data
	// type. If you don't specify a key ID, the system uses the default key associated
	// with your AWS account.
	//
	//     * To use your default AWS KMS key, choose the
	// SecureString data type, and do not specify the Key ID when you create the
	// parameter. The system automatically populates Key ID with your default KMS
	// key.
	//
	//     * To use a custom KMS key, choose the SecureString data type with the
	// Key ID parameter.
	KeyId *string
	// The data type for a String parameter. Supported data types include plain text
	// and Amazon Machine Image IDs. The following data type values are supported.
	//
	//
	// * text
	//
	//     * aws:ec2:image
	//
	// When you create a String parameter and specify
	// aws:ec2:image, Systems Manager validates the parameter value is in the required
	// format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available
	// in your AWS account. For more information, see Native parameter support for
	// Amazon Machine Image IDs
	// (http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html)
	// in the AWS Systems Manager User Guide.
	DataType *string
	// The fully qualified name of the parameter that you want to add to the system.
	// The fully qualified name includes the complete hierarchy of the parameter path
	// and name. For parameters in a hierarchy, you must include a leading forward
	// slash character (/) when you create or reference a parameter. For example:
	// /Dev/DBServer/MySQL/db-string13 Naming Constraints:
	//
	//     * Parameter names are
	// case sensitive.
	//
	//     * A parameter name must be unique within an AWS Region
	//
	//
	// * A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
	//
	//
	// * Parameter names can include only the following symbols and letters:
	// a-zA-Z0-9_.-/
	//
	//     * A parameter name can't include spaces.
	//
	//     * Parameter
	// hierarchies are limited to a maximum depth of fifteen levels.
	//
	// For additional
	// information about valid values for parameter names, see About requirements and
	// constraints for parameter names
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html)
	// in the AWS Systems Manager User Guide. The maximum length constraint listed
	// below includes capacity for additional system attributes that are not part of
	// the name. The maximum length for a parameter name, including the full length of
	// the parameter ARN, is 1011 characters. For example, the length of the following
	// parameter name is 65 characters, not 20 characters:
	// arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName
	Name *string
	// The parameter tier to assign to a parameter. Parameter Store offers a standard
	// tier and an advanced tier for parameters. Standard parameters have a content
	// size limit of 4 KB and can't be configured to use parameter policies. You can
	// create a maximum of 10,000 standard parameters for each Region in an AWS
	// account. Standard parameters are offered at no additional cost. Advanced
	// parameters have a content size limit of 8 KB and can be configured to use
	// parameter policies. You can create a maximum of 100,000 advanced parameters for
	// each Region in an AWS account. Advanced parameters incur a charge. For more
	// information, see Standard and advanced parameter tiers
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html)
	// in the AWS Systems Manager User Guide. You can change a standard parameter to an
	// advanced parameter any time. But you can't revert an advanced parameter to a
	// standard parameter. Reverting an advanced parameter to a standard parameter
	// would result in data loss because the system would truncate the size of the
	// parameter from 8 KB to 4 KB. Reverting would also remove any policies attached
	// to the parameter. Lastly, advanced parameters use a different form of encryption
	// than standard parameters. If you no longer need an advanced parameter, or if you
	// no longer want to incur charges for an advanced parameter, you must delete it
	// and recreate it as a new standard parameter. Using the Default Tier
	// Configuration In PutParameter requests, you can specify the tier to create the
	// parameter in. Whenever you specify a tier in the request, Parameter Store
	// creates or updates the parameter according to that request. However, if you do
	// not specify a tier in a request, Parameter Store assigns the tier based on the
	// current Parameter Store default tier configuration. The default tier when you
	// begin using Parameter Store is the standard-parameter tier. If you use the
	// advanced-parameter tier, you can specify one of the following as the default:
	//
	//
	// * Advanced: With this option, Parameter Store evaluates all requests as advanced
	// parameters.
	//
	//     * Intelligent-Tiering: With this option, Parameter Store
	// evaluates each request to determine if the parameter is standard or advanced. If
	// the request doesn't include any options that require an advanced parameter, the
	// parameter is created in the standard-parameter tier. If one or more options
	// requiring an advanced parameter are included in the request, Parameter Store
	// create a parameter in the advanced-parameter tier. This approach helps control
	// your parameter-related costs by always creating standard parameters unless an
	// advanced parameter is necessary.
	//
	// Options that require an advanced parameter
	// include the following:
	//
	//     * The content size of the parameter is more than 4
	// KB.
	//
	//     * The parameter uses a parameter policy.
	//
	//     * More than 10,000
	// parameters already exist in your AWS account in the current Region.
	//
	// For more
	// information about configuring the default tier option, see Specifying a default
	// parameter tier
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html)
	// in the AWS Systems Manager User Guide.
	Tier types.ParameterTier
	// Information about the parameter that you want to add to the system. Optional but
	// recommended. Do not enter personally identifiable information in this field.
	Description *string
}

type PutParameterOutput

type PutParameterOutput struct {
	// The tier assigned to the parameter.
	Tier types.ParameterTier
	// The new version number of a parameter. If you edit a parameter value, Parameter
	// Store automatically creates a new version and assigns this new version a unique
	// ID. You can reference a parameter version ID in API actions or in Systems
	// Manager documents (SSM documents). By default, if you don't specify a specific
	// version, the system returns the latest parameter value when a parameter is
	// called.
	Version *int64

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

type RegisterDefaultPatchBaselineInput

type RegisterDefaultPatchBaselineInput struct {
	// The ID of the patch baseline that should be the default patch baseline.
	BaselineId *string
}

type RegisterDefaultPatchBaselineOutput

type RegisterDefaultPatchBaselineOutput struct {
	// The ID of the default patch baseline.
	BaselineId *string

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

type RegisterPatchBaselineForPatchGroupInput

type RegisterPatchBaselineForPatchGroupInput struct {
	// The name of the patch group that should be registered with the patch baseline.
	PatchGroup *string
	// The ID of the patch baseline to register the patch group with.
	BaselineId *string
}

type RegisterPatchBaselineForPatchGroupOutput

type RegisterPatchBaselineForPatchGroupOutput struct {
	// The ID of the patch baseline the patch group was registered with.
	BaselineId *string
	// The name of the patch group registered with the patch baseline.
	PatchGroup *string

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

type RegisterTargetWithMaintenanceWindowInput

type RegisterTargetWithMaintenanceWindowInput struct {
	// The targets to register with the maintenance window. In other words, the
	// instances to run commands on when the maintenance window runs.  <p>You can
	// specify targets using instance IDs, resource group names, or tags that have been
	// applied to instances. Example 1: Specify instance IDs
	// Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3  Example 2: Use
	// tag key-pairs applied to instances
	// Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2  Example 3: Use tag-keys
	// applied to instances Key=tag-key,Values=my-tag-key-1,my-tag-key-2  <p>
	// <b>Example 4</b>: Use resource group names</p> <p>
	// <code>Key=resource-groups:Name,Values=<i>resource-group-name</i> </code> </p>
	// <p> <b>Example 5</b>: Use filters for resource group types</p> <p>
	// <code>Key=resource-groups:ResourceTypeFilters,Values=<i>resource-type-1</i>,<i>resource-type-2</i>
	// </code> </p> <note> <p>For <code>Key=resource-groups:ResourceTypeFilters</code>,
	// specify resource types in the following format</p> <p>
	// <code>Key=resource-groups:ResourceTypeFilters,Values=<i>AWS::EC2::INSTANCE</i>,<i>AWS::EC2::VPC</i>
	// </code> </p> </note> <p>For more information about these examples formats,
	// including the best use case for each one,  see Examples: Register targets with a
	// maintenance window
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)
	// in the AWS Systems Manager User Guide.
	Targets []*types.Target
	// User-provided value that will be included in any CloudWatch events raised while
	// running tasks for these targets in this maintenance window.
	OwnerInformation *string
	// An optional description for the target.
	Description *string
	// The type of target being registered with the maintenance window.
	ResourceType types.MaintenanceWindowResourceType
	// The ID of the maintenance window the target should be registered with.
	WindowId *string
	// An optional name for the target.
	Name *string
	// User-provided idempotency token.
	ClientToken *string
}

type RegisterTargetWithMaintenanceWindowOutput

type RegisterTargetWithMaintenanceWindowOutput struct {
	// The ID of the target definition in this maintenance window.
	WindowTargetId *string

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

type RegisterTaskWithMaintenanceWindowInput

type RegisterTaskWithMaintenanceWindowInput struct {
	// A structure containing information about an S3 bucket to write instance-level
	// logs to. LoggingInfo has been deprecated. To specify an S3 bucket to contain
	// logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
	// TaskInvocationParameters structure. For information about how Systems Manager
	// handles these options for the supported maintenance window task types, see
	// MaintenanceWindowTaskInvocationParameters ().
	LoggingInfo *types.LoggingInfo
	// User-provided idempotency token.
	ClientToken *string
	// The ARN of the IAM service role for Systems Manager to assume when running a
	// maintenance window task. If you do not specify a service role ARN, Systems
	// Manager uses your account's service-linked role. If no service-linked role for
	// Systems Manager exists in your account, it is created when you run
	// RegisterTaskWithMaintenanceWindow. For more information, see the following
	// topics in the in the AWS Systems Manager User Guide:
	//
	//     * Using service-linked
	// roles for Systems Manager
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions)
	//
	//
	// * Should I use a service-linked role or a custom service role to run maintenance
	// window tasks?
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role)
	ServiceRoleArn *string
	// The targets (either instances or maintenance window targets). Specify instances
	// using the following format: Key=InstanceIds,Values=, Specify maintenance window
	// targets using the following format: Key=WindowTargetIds;,Values=,
	Targets []*types.Target
	// An optional description for the task.
	Description *string
	// The ARN of the task to run.
	TaskArn *string
	// The maximum number of errors allowed before this task stops being scheduled.
	MaxErrors *string
	// The maximum number of targets this task can be run for in parallel.
	MaxConcurrency *string
	// The ID of the maintenance window the task should be added to.
	WindowId *string
	// The parameters that the task should use during execution. Populate only the
	// fields that match the task type. All other fields should be empty.
	TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters
	// An optional name for the task.
	Name *string
	// The parameters that should be passed to the task when it is run. TaskParameters
	// has been deprecated. To specify parameters to pass to a task when it runs,
	// instead use the Parameters option in the TaskInvocationParameters structure. For
	// information about how Systems Manager handles these options for the supported
	// maintenance window task types, see MaintenanceWindowTaskInvocationParameters ().
	TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression
	// The priority of the task in the maintenance window, the lower the number the
	// higher the priority. Tasks in a maintenance window are scheduled in priority
	// order with tasks that have the same priority scheduled in parallel.
	Priority *int32
	// The type of task being registered.
	TaskType types.MaintenanceWindowTaskType
}

type RegisterTaskWithMaintenanceWindowOutput

type RegisterTaskWithMaintenanceWindowOutput struct {
	// The ID of the task in the maintenance window.
	WindowTaskId *string

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

type RemoveTagsFromResourceInput

type RemoveTagsFromResourceInput struct {
	// The ID of the resource from which you want to remove tags. For example:
	// ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde PatchBaseline:
	// pb-012345abcde For the Document and Parameter values, use the name of the
	// resource. The ManagedInstance type for this API action is only for on-premises
	// managed instances. Specify the name of the managed instance in the following
	// format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
	ResourceId *string
	// Tag keys that you want to remove from the specified resource.
	TagKeys []*string
	// The type of resource from which you want to remove a tag. The ManagedInstance
	// type for this API action is only for on-premises managed instances. Specify the
	// name of the managed instance in the following format: mi-ID_number. For example,
	// mi-1a2b3c4d5e6f.
	ResourceType types.ResourceTypeForTagging
}

type RemoveTagsFromResourceOutput

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

type ResetServiceSettingInput

type ResetServiceSettingInput struct {
	// The Amazon Resource Name (ARN) of the service setting to reset. The setting ID
	// can be /ssm/parameter-store/default-parameter-tier,
	// /ssm/parameter-store/high-throughput-enabled, or
	// /ssm/managed-instance/activation-tier. For example,
	// arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.
	SettingId *string
}

The request body of the ResetServiceSetting API action.

type ResetServiceSettingOutput

type ResetServiceSettingOutput struct {
	// The current, effective service setting after calling the ResetServiceSetting API
	// action.
	ServiceSetting *types.ServiceSetting

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

The result body of the ResetServiceSetting API action.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

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

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type ResumeSessionInput

type ResumeSessionInput struct {
	// The ID of the disconnected session to resume.
	SessionId *string
}

type ResumeSessionOutput

type ResumeSessionOutput struct {
	// The ID of the session.
	SessionId *string
	// A URL back to SSM Agent on the instance that the Session Manager client uses to
	// send commands and receive output from the instance. Format:
	// wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).
	// region represents the Region identifier for an AWS Region supported by AWS
	// Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of
	// supported region values, see the Region column in Systems Manager service
	// endpoints (http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) in
	// the AWS General Reference. session-id represents the ID of a Session Manager
	// session, such as 1a2b3c4dEXAMPLE.
	StreamUrl *string
	// An encrypted token value containing session and caller information. Used to
	// authenticate the connection to the instance.
	TokenValue *string

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

type SendAutomationSignalInput

type SendAutomationSignalInput struct {
	// The unique identifier for an existing Automation execution that you want to send
	// the signal to.
	AutomationExecutionId *string
	// The data sent with the signal. The data schema depends on the type of signal
	// used in the request. For Approve and Reject signal types, the payload is an
	// optional comment that you can send with the signal type. For example:
	// Comment="Looks good" For StartStep and Resume signal types, you must send the
	// name of the Automation step to start or resume as the payload. For example:
	// StepName="step1" For the StopStep signal type, you must send the step execution
	// ID as the payload. For example:
	// StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
	Payload map[string][]*string
	// The type of signal to send to an Automation execution.
	SignalType types.SignalType
}

type SendAutomationSignalOutput

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

type SendCommandInput

type SendCommandInput struct {
	// The SSM document version to use in the request. You can specify $DEFAULT,
	// $LATEST, or a specific version number. If you run commands by using the AWS CLI,
	// then you must escape the first two options by using a backslash. If you specify
	// a version number, then you don't need to use the backslash. For example:
	// --document-version "\$DEFAULT" --document-version "\$LATEST" --document-version
	// "3"
	DocumentVersion *string
	// Configurations for sending notifications.
	NotificationConfig *types.NotificationConfig
	// (Deprecated) You can no longer specify this parameter. The system ignores it.
	// Instead, Systems Manager automatically determines the Region of the S3 bucket.
	OutputS3Region *string
	// The Sha256 or Sha1 hash created by the system when the document was created.
	// Sha1 hashes have been deprecated.
	DocumentHash *string
	// The directory structure within the S3 bucket where the responses should be
	// stored.
	OutputS3KeyPrefix *string
	// User-specified information about the command, such as a brief description of
	// what the command should do.
	Comment *string
	// The maximum number of errors allowed without the command failing. When the
	// command fails one more time beyond the value of MaxErrors, the systems stops
	// sending the command to additional targets. You can specify a number like 10 or a
	// percentage like 10%. The default value is 0. For more information about how to
	// use MaxErrors, see Using error controls
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors)
	// in the AWS Systems Manager User Guide.
	MaxErrors *string
	// The required and optional parameters specified in the document being run.
	Parameters map[string][]*string
	// (Optional) The maximum number of instances that are allowed to run the command
	// at the same time. You can specify a number such as 10 or a percentage such as
	// 10%. The default value is 50. For more information about how to use
	// MaxConcurrency, see Using concurrency controls
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity)
	// in the AWS Systems Manager User Guide.
	MaxConcurrency *string
	// The IDs of the instances where the command should run. Specifying instance IDs
	// is most useful when you are targeting a limited number of instances, though you
	// can specify up to 50 IDs. To target a larger number of instances, or if you
	// prefer not to list individual instance IDs, we recommend using the Targets
	// option instead. Using Targets, which accepts tag key-value pairs to identify the
	// instances to send commands to, you can a send command to tens, hundreds, or
	// thousands of instances at once. For more information about how to use targets,
	// see Using targets and rate controls to send commands to a fleet
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html)
	// in the AWS Systems Manager User Guide.
	InstanceIds []*string
	// Required. The name of the Systems Manager document to run. This can be a public
	// document or a custom document.
	DocumentName *string
	// The name of the S3 bucket where command execution responses should be stored.
	OutputS3BucketName *string
	// If this time is reached and the command has not already started running, it will
	// not run.
	TimeoutSeconds *int32
	// Sha256 or Sha1. Sha1 hashes have been deprecated.
	DocumentHashType types.DocumentHashType
	// Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
	CloudWatchOutputConfig *types.CloudWatchOutputConfig
	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for Run Command commands.
	ServiceRoleArn *string
	// An array of search criteria that targets instances using a Key,Value combination
	// that you specify. Specifying targets is most useful when you want to send a
	// command to a large number of instances at once. Using Targets, which accepts tag
	// key-value pairs to identify instances, you can send a command to tens, hundreds,
	// or thousands of instances at once. To send a command to a smaller number of
	// instances, you can use the InstanceIds option instead. For more information
	// about how to use targets, see Sending commands to a fleet
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html)
	// in the AWS Systems Manager User Guide.
	Targets []*types.Target
}

type SendCommandOutput

type SendCommandOutput struct {
	// The request as it was received by Systems Manager. Also provides the command ID
	// which can be used future references to this request.
	Command *types.Command

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

type StartAssociationsOnceInput

type StartAssociationsOnceInput struct {
	// The association IDs that you want to run immediately and only one time.
	AssociationIds []*string
}

type StartAssociationsOnceOutput

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

type StartAutomationExecutionInput

type StartAutomationExecutionInput struct {
	// Optional metadata that you assign to a resource. You can specify a maximum of
	// five tags for an automation. Tags enable you to categorize a resource in
	// different ways, such as by purpose, owner, or environment. For example, you
	// might want to tag an automation to identify an environment or operating system.
	// In this case, you could specify the following key name/value pairs:
	//
	//     *
	// Key=environment,Value=test
	//
	//     * Key=OS,Value=Windows
	//
	// To add tags to an
	// existing patch baseline, use the AddTagsToResource () action.
	Tags []*types.Tag
	// The name of the Automation document to use for this execution.
	DocumentName *string
	// The number of errors that are allowed before the system stops running the
	// automation on additional targets. You can specify either an absolute number of
	// errors, for example 10, or a percentage of the target set, for example 10%. If
	// you specify 3, for example, the system stops running the automation when the
	// fourth error is received. If you specify 0, then the system stops running the
	// automation on additional targets after the first error result is returned. If
	// you run an automation on 50 resources and set max-errors to 10%, then the system
	// stops running the automation on additional targets when the sixth error is
	// received. Executions that are already running an automation when max-errors is
	// reached are allowed to complete, but some of these executions may fail as well.
	// If you need to ensure that there won't be more than max-errors failed
	// executions, set max-concurrency to 1 so the executions proceed one at a time.
	MaxErrors *string
	// A location is a combination of AWS Regions and/or AWS accounts where you want to
	// run the Automation. Use this action to start an Automation in multiple Regions
	// and multiple accounts. For more information, see Running Automation workflows in
	// multiple AWS Regions and accounts
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html)
	// in the AWS Systems Manager User Guide.
	TargetLocations []*types.TargetLocation
	// A key-value mapping to target resources. Required if you specify
	// TargetParameterName.
	Targets []*types.Target
	// User-provided idempotency token. The token must be unique, is case insensitive,
	// enforces the UUID format, and can't be reused.
	ClientToken *string
	// A key-value mapping of document parameters to target resources. Both Targets and
	// TargetMaps cannot be specified together.
	TargetMaps []map[string][]*string
	// The version of the Automation document to use for this execution.
	DocumentVersion *string
	// The execution mode of the automation. Valid modes include the following: Auto
	// and Interactive. The default mode is Auto.
	Mode types.ExecutionMode
	// The maximum number of targets allowed to run this task in parallel. You can
	// specify a number, such as 10, or a percentage, such as 10%. The default value is
	// 10.
	MaxConcurrency *string
	// A key-value map of execution parameters, which match the declared parameters in
	// the Automation document.
	Parameters map[string][]*string
	// The name of the parameter used as the target resource for the rate-controlled
	// execution. Required if you specify targets.
	TargetParameterName *string
}

type StartAutomationExecutionOutput

type StartAutomationExecutionOutput struct {
	// The unique ID of a newly scheduled automation execution.
	AutomationExecutionId *string

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

type StartSessionInput

type StartSessionInput struct {
	// Reserved for future use.
	Parameters map[string][]*string
	// The instance to connect to for the session.
	Target *string
	// The name of the SSM document to define the parameters and plugin settings for
	// the session. For example, SSM-SessionManagerRunShell. You can call the
	// GetDocument () API to verify the document exists before attempting to start a
	// session. If no document name is provided, a shell to the instance is launched by
	// default.
	DocumentName *string
}

type StartSessionOutput

type StartSessionOutput struct {
	// An encrypted token value containing session and caller information. Used to
	// authenticate the connection to the instance.
	TokenValue *string
	// A URL back to SSM Agent on the instance that the Session Manager client uses to
	// send commands and receive output from the instance. Format:
	// wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
	// region represents the Region identifier for an AWS Region supported by AWS
	// Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of
	// supported region values, see the Region column in Systems Manager service
	// endpoints (http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) in
	// the AWS General Reference. session-id represents the ID of a Session Manager
	// session, such as 1a2b3c4dEXAMPLE.
	StreamUrl *string
	// The ID of the session.
	SessionId *string

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

type StopAutomationExecutionInput

type StopAutomationExecutionInput struct {
	// The execution ID of the Automation to stop.
	AutomationExecutionId *string
	// The stop request type. Valid types include the following: Cancel and Complete.
	// The default type is Cancel.
	Type types.StopType
}

type StopAutomationExecutionOutput

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

type TerminateSessionInput

type TerminateSessionInput struct {
	// The ID of the session to terminate.
	SessionId *string
}

type TerminateSessionOutput

type TerminateSessionOutput struct {
	// The ID of the session that has been terminated.
	SessionId *string

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

type UpdateAssociationInput

type UpdateAssociationInput struct {
	// The ID of the association you want to update.
	AssociationId *string
	// Specify the target for the association. This target is required for associations
	// that use an Automation document and target resources by using rate controls.
	AutomationTargetParameterName *string
	// The targets of the association.
	Targets []*types.Target
	// The document version you want update for the association.
	DocumentVersion *string
	// This parameter is provided for concurrency control purposes. You must specify
	// the latest association version in the service. If you want to ensure that this
	// request succeeds, either specify $LATEST, or omit this parameter.
	AssociationVersion *string
	// The severity level to assign to the association.
	ComplianceSeverity types.AssociationComplianceSeverity
	// The name of the SSM document that contains the configuration information for the
	// instance. You can specify Command or Automation documents. You can specify
	// AWS-predefined documents, documents you created, or a document that is shared
	// with you from another account. For SSM documents that are shared with you from
	// other AWS accounts, you must specify the complete SSM document ARN, in the
	// following format: arn:aws:ssm:region:account-id:document/document-name  For
	// example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For
	// AWS-predefined documents and SSM documents you created in your account, you only
	// need to specify the document name. For example, AWS-ApplyPatchBaseline or
	// My-Document.
	Name *string
	// The cron expression used to schedule the association that you want to update.
	ScheduleExpression *string
	// The number of errors that are allowed before the system stops sending requests
	// to run the association on additional targets. You can specify either an absolute
	// number of errors, for example 10, or a percentage of the target set, for example
	// 10%. If you specify 3, for example, the system stops sending requests when the
	// fourth error is received. If you specify 0, then the system stops sending
	// requests after the first error is returned. If you run an association on 50
	// instances and set MaxError to 10%, then the system stops sending the request
	// when the sixth error is received. Executions that are already running an
	// association when MaxErrors is reached are allowed to complete, but some of these
	// executions may fail as well. If you need to ensure that there won't be more than
	// max-errors failed executions, set MaxConcurrency to 1 so that executions proceed
	// one at a time.
	MaxErrors *string
	// By default, when you update an association, the system runs it immediately after
	// it is updated and then according to the schedule you specified. Specify this
	// option if you don't want an association to run immediately after you update it.
	// Also, if you specified this option when you created the association, you can
	// reset it. To do so, specify the no-apply-only-at-cron-interval parameter when
	// you update the association from the command line. This parameter forces the
	// association to run immediately after updating it and according to the interval
	// specified.
	ApplyOnlyAtCronInterval *bool
	// The name of the association that you want to update.
	AssociationName *string
	// The parameters you want to update for the association. If you create a parameter
	// using Parameter Store, you can reference the parameter using
	// {{ssm:parameter-name}}
	Parameters map[string][]*string
	// An S3 bucket where you want to store the results of this request.
	OutputLocation *types.InstanceAssociationOutputLocation
	// The maximum number of targets allowed to run the association at the same time.
	// You can specify a number, for example 10, or a percentage of the target set, for
	// example 10%. The default value is 100%, which means all targets run the
	// association at the same time. If a new instance starts and attempts to run an
	// association while Systems Manager is running MaxConcurrency associations, the
	// association is allowed to run. During the next association interval, the new
	// instance will process its association within the limit specified for
	// MaxConcurrency.
	MaxConcurrency *string
	// The mode for generating association compliance. You can specify AUTO or MANUAL.
	// In AUTO mode, the system uses the status of the association execution to
	// determine the compliance status. If the association execution runs successfully,
	// then the association is COMPLIANT. If the association execution doesn't run
	// successfully, the association is NON-COMPLIANT. In MANUAL mode, you must specify
	// the AssociationId as a parameter for the PutComplianceItems () API action. In
	// this case, compliance data is not managed by State Manager. It is managed by
	// your direct call to the PutComplianceItems () API action. By default, all
	// associations use AUTO mode.
	SyncCompliance types.AssociationSyncCompliance
}

type UpdateAssociationOutput

type UpdateAssociationOutput struct {
	// The description of the association that was updated.
	AssociationDescription *types.AssociationDescription

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

type UpdateAssociationStatusInput

type UpdateAssociationStatusInput struct {
	// The name of the Systems Manager document.
	Name *string
	// The association status.
	AssociationStatus *types.AssociationStatus
	// The ID of the instance.
	InstanceId *string
}

type UpdateAssociationStatusOutput

type UpdateAssociationStatusOutput struct {
	// Information about the association.
	AssociationDescription *types.AssociationDescription

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

type UpdateDocumentDefaultVersionInput

type UpdateDocumentDefaultVersionInput struct {
	// The version of a custom document that you want to set as the default version.
	DocumentVersion *string
	// The name of a custom document that you want to set as the default version.
	Name *string
}

type UpdateDocumentDefaultVersionOutput

type UpdateDocumentDefaultVersionOutput struct {
	// The description of a custom document that you want to set as the default
	// version.
	Description *types.DocumentDefaultVersionDescription

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

type UpdateDocumentInput

type UpdateDocumentInput struct {
	// A valid JSON or YAML string.
	Content *string
	// Specify a new target type for the document.
	TargetType *string
	// An optional field specifying the version of the artifact you are updating with
	// the document. For example, "Release 12, Update 6". This value is unique across
	// all versions of a document, and cannot be changed.
	VersionName *string
	// A list of key and value pairs that describe attachments to a version of a
	// document.
	Attachments []*types.AttachmentsSource
	// The name of the document that you want to update.
	Name *string
	// Specify the document format for the new document version. Systems Manager
	// supports JSON and YAML documents. JSON is the default format.
	DocumentFormat types.DocumentFormat
	// (Required) The latest version of the document that you want to update. The
	// latest document version can be specified using the $LATEST variable or by the
	// version number. Updating a previous version of a document is not supported.
	DocumentVersion *string
}

type UpdateDocumentOutput

type UpdateDocumentOutput struct {
	// A description of the document that was updated.
	DocumentDescription *types.DocumentDescription

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

type UpdateMaintenanceWindowInput

type UpdateMaintenanceWindowInput struct {
	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string
	// The duration of the maintenance window in hours.
	Duration *int32
	// Whether the maintenance window is enabled.
	Enabled *bool
	// Whether targets must be registered with the maintenance window before tasks can
	// be defined for those targets.
	AllowUnassociatedTargets *bool
	// An optional description for the update request.
	Description *string
	// The time zone that the scheduled maintenance window executions are based on, in
	// Internet Assigned Numbers Authority (IANA) format. For example:
	// "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the
	// Time Zone Database (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string
	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int32
	// If True, then all fields that are required by the CreateMaintenanceWindow action
	// are also required for this API request. Optional fields that are not specified
	// are set to null.
	Replace *bool
	// The number of days to wait after the date and time specified by a CRON
	// expression before running the maintenance window. For example, the following
	// cron expression schedules a maintenance window to run the third Tuesday of every
	// month at 11:30 PM. cron(0 30 23 ? * TUE#3 *) If the schedule offset is 2, the
	// maintenance window won't run until two days later.
	ScheduleOffset *int32
	// The name of the maintenance window.
	Name *string
	// The ID of the maintenance window to update.
	WindowId *string
	// The date and time, in ISO-8601 Extended format, for when you want the
	// maintenance window to become inactive. EndDate allows you to set a date and time
	// in the future when the maintenance window will no longer run.
	EndDate *string
	// The time zone that the scheduled maintenance window executions are based on, in
	// Internet Assigned Numbers Authority (IANA) format. For example:
	// "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the
	// Time Zone Database (https://www.iana.org/time-zones) on the IANA website.
	StartDate *string
}

type UpdateMaintenanceWindowOutput

type UpdateMaintenanceWindowOutput struct {
	// The time zone that the scheduled maintenance window executions are based on, in
	// Internet Assigned Numbers Authority (IANA) format. For example:
	// "America/Los_Angeles", "etc/UTC", or "Asia/Seoul". For more information, see the
	// Time Zone Database (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string
	// The date and time, in ISO-8601 Extended format, for when the maintenance window
	// is scheduled to become active. The maintenance window will not run before this
	// specified time.
	StartDate *string
	// The duration of the maintenance window in hours.
	Duration *int32
	// The name of the maintenance window.
	Name *string
	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string
	// The date and time, in ISO-8601 Extended format, for when the maintenance window
	// is scheduled to become inactive. The maintenance window will not run after this
	// specified time.
	EndDate *string
	// Whether the maintenance window is enabled.
	Enabled *bool
	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int32
	// Whether targets must be registered with the maintenance window before tasks can
	// be defined for those targets.
	AllowUnassociatedTargets *bool
	// The ID of the created maintenance window.
	WindowId *string
	// An optional description of the update.
	Description *string
	// The number of days to wait to run a maintenance window after the scheduled CRON
	// expression date and time.
	ScheduleOffset *int32

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

type UpdateMaintenanceWindowTargetInput

type UpdateMaintenanceWindowTargetInput struct {
	// User-provided value that will be included in any CloudWatch events raised while
	// running tasks for these targets in this maintenance window.
	OwnerInformation *string
	// An optional description for the update.
	Description *string
	// The targets to add or replace.
	Targets []*types.Target
	// If True, then all fields that are required by the
	// RegisterTargetWithMaintenanceWindow action are also required for this API
	// request. Optional fields that are not specified are set to null.
	Replace *bool
	// The maintenance window ID with which to modify the target.
	WindowId *string
	// A name for the update.
	Name *string
	// The target ID to modify.
	WindowTargetId *string
}

type UpdateMaintenanceWindowTargetOutput

type UpdateMaintenanceWindowTargetOutput struct {
	// The updated owner.
	OwnerInformation *string
	// The updated description.
	Description *string
	// The target ID specified in the update request.
	WindowTargetId *string
	// The updated name.
	Name *string
	// The updated targets.
	Targets []*types.Target
	// The maintenance window ID specified in the update request.
	WindowId *string

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

type UpdateMaintenanceWindowTaskInput

type UpdateMaintenanceWindowTaskInput struct {
	// If True, then all fields that are required by the
	// RegisterTaskWithMaintenanceWndow action are also required for this API request.
	// Optional fields that are not specified are set to null.
	Replace *bool
	// The new logging location in Amazon S3 to specify. LoggingInfo has been
	// deprecated. To specify an S3 bucket to contain logs, instead use the
	// OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options for
	// the supported maintenance window task types, see
	// MaintenanceWindowTaskInvocationParameters ().
	LoggingInfo *types.LoggingInfo
	// The new task description to specify.
	Description *string
	// The new MaxErrors value to specify. MaxErrors is the maximum number of errors
	// that are allowed before the task stops being scheduled.
	MaxErrors *string
	// The task ARN to modify.
	TaskArn *string
	// The new task name to specify.
	Name *string
	// The targets (either instances or tags) to modify. Instances are specified using
	// Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using
	// Key=tag_name,Values=tag_value.
	Targets []*types.Target
	// The maintenance window ID that contains the task to modify.
	WindowId *string
	// The new task priority to specify. The lower the number, the higher the priority.
	// Tasks that have the same priority are scheduled in parallel.
	Priority *int32
	// The parameters to modify. TaskParameters has been deprecated. To specify
	// parameters to pass to a task when it runs, instead use the Parameters option in
	// the TaskInvocationParameters structure. For information about how Systems
	// Manager handles these options for the supported maintenance window task types,
	// see MaintenanceWindowTaskInvocationParameters (). The map has the following
	// format: Key: string, between 1 and 255 characters Value: an array of strings,
	// each string is between 1 and 255 characters
	TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression
	// The ARN of the IAM service role for Systems Manager to assume when running a
	// maintenance window task. If you do not specify a service role ARN, Systems
	// Manager uses your account's service-linked role. If no service-linked role for
	// Systems Manager exists in your account, it is created when you run
	// RegisterTaskWithMaintenanceWindow. For more information, see the following
	// topics in the in the AWS Systems Manager User Guide:
	//
	//     * Using service-linked
	// roles for Systems Manager
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions)
	//
	//
	// * Should I use a service-linked role or a custom service role to run maintenance
	// window tasks?
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role)
	ServiceRoleArn *string
	// The task ID to modify.
	WindowTaskId *string
	// The parameters that the task should use during execution. Populate only the
	// fields that match the task type. All other fields should be empty.
	TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters
	// The new MaxConcurrency value you want to specify. MaxConcurrency is the number
	// of targets that are allowed to run this task in parallel.
	MaxConcurrency *string
}

type UpdateMaintenanceWindowTaskOutput

type UpdateMaintenanceWindowTaskOutput struct {
	// The ID of the maintenance window that was updated.
	WindowId *string
	// The updated task name.
	Name *string
	// The updated parameter values.
	TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters
	// The updated priority value.
	Priority *int32
	// The updated parameter values. TaskParameters has been deprecated. To specify
	// parameters to pass to a task when it runs, instead use the Parameters option in
	// the TaskInvocationParameters structure. For information about how Systems
	// Manager handles these options for the supported maintenance window task types,
	// see MaintenanceWindowTaskInvocationParameters ().
	TaskParameters map[string]*types.MaintenanceWindowTaskParameterValueExpression
	// The updated target values.
	Targets []*types.Target
	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for maintenance window Run Command tasks.
	ServiceRoleArn *string
	// The updated task description.
	Description *string
	// The updated logging information in Amazon S3. LoggingInfo has been deprecated.
	// To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and
	// OutputS3KeyPrefix options in the TaskInvocationParameters structure. For
	// information about how Systems Manager handles these options for the supported
	// maintenance window task types, see MaintenanceWindowTaskInvocationParameters ().
	LoggingInfo *types.LoggingInfo
	// The updated MaxErrors value.
	MaxErrors *string
	// The updated task ARN value.
	TaskArn *string
	// The updated MaxConcurrency value.
	MaxConcurrency *string
	// The task ID of the maintenance window that was updated.
	WindowTaskId *string

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

type UpdateManagedInstanceRoleInput

type UpdateManagedInstanceRoleInput struct {
	// The ID of the managed instance where you want to update the role.
	InstanceId *string
	// The IAM role you want to assign or change.
	IamRole *string
}

type UpdateManagedInstanceRoleOutput

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

type UpdateOpsItemInput

type UpdateOpsItemInput struct {
	// Keys that you want to remove from the OperationalData map.
	OperationalDataToDelete []*string
	// Update the information about the OpsItem. Provide enough information so that
	// users reading this OpsItem for the first time understand the issue.
	Description *string
	// The ID of the OpsItem.
	OpsItemId *string
	// Add new keys or edit existing key-value pairs of the OperationalData map in the
	// OpsItem object. Operational data is custom data that provides useful reference
	// details about the OpsItem. For example, you can specify log files, error
	// strings, license keys, troubleshooting tips, or other relevant data. You enter
	// operational data as key-value pairs. The key has a maximum length of 128
	// characters. The value has a maximum size of 20 KB.  <important> <p>Operational
	// data keys <i>can't</i> begin with the following: amazon, aws, amzn, ssm,
	// /amazon, /aws, /amzn, /ssm.</p> </important> <p>You can choose to make the data
	// searchable by other users in the account or you can restrict  search access.
	// Searchable data means that all users with access to the OpsItem Overview page
	// (as provided by the DescribeOpsItems () API action) can view and search on the
	// specified data. Operational data that is not searchable is only viewable by
	// users who have access to the OpsItem (as provided by the GetOpsItem () API
	// action).  <p>Use the <code>/aws/resources</code> key in OperationalData to
	// specify a related resource in  the request. Use the /aws/automations key in
	// OperationalData to associate an Automation runbook with the OpsItem. To view AWS
	// CLI example commands that use these keys, see Creating OpsItems manually
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems)
	// in the AWS Systems Manager User Guide.
	OperationalData map[string]*types.OpsItemDataValue
	// Specify a new category for an OpsItem.
	Category *string
	// One or more OpsItems that share something in common with the current OpsItems.
	// For example, related OpsItems can include OpsItems with similar error messages,
	// impacted resources, or statuses for the impacted resource.
	RelatedOpsItems []*types.RelatedOpsItem
	// The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when
	// this OpsItem is edited or changed.
	Notifications []*types.OpsItemNotification
	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	Title *string
	// The OpsItem status. Status can be Open, In Progress, or Resolved. For more
	// information, see Editing OpsItem details
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details)
	// in the AWS Systems Manager User Guide.
	Status types.OpsItemStatus
	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int32
	// Specify a new severity for an OpsItem.
	Severity *string
}

type UpdateOpsItemOutput

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

type UpdatePatchBaselineInput

type UpdatePatchBaselineInput struct {
	// A list of explicitly rejected patches for the baseline. For information about
	// accepted formats for lists of approved patches and rejected patches, see About
	// package name formats for approved and rejected patch lists
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	RejectedPatches []*string
	// A set of global filters used to include patches in the baseline.
	GlobalFilters *types.PatchFilterGroup
	// A list of explicitly approved patches for the baseline. For information about
	// accepted formats for lists of approved patches and rejected patches, see About
	// package name formats for approved and rejected patch lists
	// (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	ApprovedPatches []*string
	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*types.PatchSource
	// The action for Patch Manager to take on patches included in the RejectedPackages
	// list.
	//
	//     * ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is
	// installed only if it is a dependency of another package. It is considered
	// compliant with the patch baseline, and its status is reported as InstalledOther.
	// This is the default action if no option is specified.
	//
	//     * BLOCK: Packages in
	// the RejectedPatches list, and packages that include them as dependencies, are
	// not installed under any circumstances. If a package was installed before it was
	// added to the Rejected patches list, it is considered non-compliant with the
	// patch baseline, and its status is reported as InstalledRejected.
	RejectedPatchesAction types.PatchAction
	// A description of the patch baseline.
	Description *string
	// If True, then all fields that are required by the CreatePatchBaseline action are
	// also required for this API request. Optional fields that are not specified are
	// set to null.
	Replace *bool
	// Assigns a new compliance severity level to an existing patch baseline.
	ApprovedPatchesComplianceLevel types.PatchComplianceLevel
	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool
	// A set of rules used to include patches in the baseline.
	ApprovalRules *types.PatchRuleGroup
	// The ID of the patch baseline to update.
	BaselineId *string
	// The name of the patch baseline.
	Name *string
}

type UpdatePatchBaselineOutput

type UpdatePatchBaselineOutput struct {
	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool
	// The date when the patch baseline was last modified.
	ModifiedDate *time.Time
	// A list of explicitly rejected patches for the baseline.
	RejectedPatches []*string
	// A list of explicitly approved patches for the baseline.
	ApprovedPatches []*string
	// A set of rules used to include patches in the baseline.
	ApprovalRules *types.PatchRuleGroup
	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*types.PatchSource
	// The action specified to take on patches included in the RejectedPatches list. A
	// patch can be allowed only if it is a dependency of another package, or blocked
	// entirely along with packages that include it as a dependency.
	RejectedPatchesAction types.PatchAction
	// The compliance severity level assigned to the patch baseline after the update
	// completed.
	ApprovedPatchesComplianceLevel types.PatchComplianceLevel
	// The name of the patch baseline.
	Name *string
	// The date when the patch baseline was created.
	CreatedDate *time.Time
	// A set of global filters used to exclude patches from the baseline.
	GlobalFilters *types.PatchFilterGroup
	// The ID of the deleted patch baseline.
	BaselineId *string
	// The operating system rule used by the updated patch baseline.
	OperatingSystem types.OperatingSystem
	// A description of the Patch Baseline.
	Description *string

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

type UpdateResourceDataSyncInput

type UpdateResourceDataSyncInput struct {
	// Specify information about the data sources to synchronize.
	SyncSource *types.ResourceDataSyncSource
	// The type of resource data sync. The supported SyncType is SyncFromSource.
	SyncType *string
	// The name of the resource data sync you want to update.
	SyncName *string
}

type UpdateResourceDataSyncOutput

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

type UpdateServiceSettingInput

type UpdateServiceSettingInput struct {
	// The Amazon Resource Name (ARN) of the service setting to reset. For example,
	// arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled.
	// The setting ID can be one of the following.
	//
	//     *
	// /ssm/parameter-store/default-parameter-tier
	//
	//     *
	// /ssm/parameter-store/high-throughput-enabled
	//
	//     *
	// /ssm/managed-instance/activation-tier
	SettingId *string
	// The new value to specify for the service setting. For the
	// /ssm/parameter-store/default-parameter-tier setting ID, the setting value can be
	// one of the following.
	//
	//     * Standard
	//
	//     * Advanced
	//
	//     *
	// Intelligent-Tiering
	//
	// For the /ssm/parameter-store/high-throughput-enabled, and
	// /ssm/managed-instance/activation-tier setting IDs, the setting value can be true
	// or false.
	SettingValue *string
}

The request body of the UpdateServiceSetting API action.

type UpdateServiceSettingOutput

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

The result body of the UpdateServiceSetting API action.

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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