Documentation
Overview ¶
Package ssm provides the API client, operations, and parameter types for Amazon Simple Systems Manager (SSM).
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).
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AddTagsToResourceInput
- type AddTagsToResourceOutput
- type CancelCommandInput
- type CancelCommandOutput
- type CancelMaintenanceWindowExecutionInput
- type CancelMaintenanceWindowExecutionOutput
- type Client
- func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)
- func (c *Client) CancelCommand(ctx context.Context, params *CancelCommandInput, optFns ...func(*Options)) (*CancelCommandOutput, error)
- func (c *Client) CancelMaintenanceWindowExecution(ctx context.Context, params *CancelMaintenanceWindowExecutionInput, ...) (*CancelMaintenanceWindowExecutionOutput, error)
- func (c *Client) CreateActivation(ctx context.Context, params *CreateActivationInput, optFns ...func(*Options)) (*CreateActivationOutput, error)
- func (c *Client) CreateAssociation(ctx context.Context, params *CreateAssociationInput, optFns ...func(*Options)) (*CreateAssociationOutput, error)
- func (c *Client) CreateAssociationBatch(ctx context.Context, params *CreateAssociationBatchInput, ...) (*CreateAssociationBatchOutput, error)
- func (c *Client) CreateDocument(ctx context.Context, params *CreateDocumentInput, optFns ...func(*Options)) (*CreateDocumentOutput, error)
- func (c *Client) CreateMaintenanceWindow(ctx context.Context, params *CreateMaintenanceWindowInput, ...) (*CreateMaintenanceWindowOutput, error)
- func (c *Client) CreateOpsItem(ctx context.Context, params *CreateOpsItemInput, optFns ...func(*Options)) (*CreateOpsItemOutput, error)
- func (c *Client) CreateOpsMetadata(ctx context.Context, params *CreateOpsMetadataInput, optFns ...func(*Options)) (*CreateOpsMetadataOutput, error)
- func (c *Client) CreatePatchBaseline(ctx context.Context, params *CreatePatchBaselineInput, ...) (*CreatePatchBaselineOutput, error)
- func (c *Client) CreateResourceDataSync(ctx context.Context, params *CreateResourceDataSyncInput, ...) (*CreateResourceDataSyncOutput, error)
- func (c *Client) DeleteActivation(ctx context.Context, params *DeleteActivationInput, optFns ...func(*Options)) (*DeleteActivationOutput, error)
- func (c *Client) DeleteAssociation(ctx context.Context, params *DeleteAssociationInput, optFns ...func(*Options)) (*DeleteAssociationOutput, error)
- func (c *Client) DeleteDocument(ctx context.Context, params *DeleteDocumentInput, optFns ...func(*Options)) (*DeleteDocumentOutput, error)
- func (c *Client) DeleteInventory(ctx context.Context, params *DeleteInventoryInput, optFns ...func(*Options)) (*DeleteInventoryOutput, error)
- func (c *Client) DeleteMaintenanceWindow(ctx context.Context, params *DeleteMaintenanceWindowInput, ...) (*DeleteMaintenanceWindowOutput, error)
- func (c *Client) DeleteOpsMetadata(ctx context.Context, params *DeleteOpsMetadataInput, optFns ...func(*Options)) (*DeleteOpsMetadataOutput, error)
- func (c *Client) DeleteParameter(ctx context.Context, params *DeleteParameterInput, optFns ...func(*Options)) (*DeleteParameterOutput, error)
- func (c *Client) DeleteParameters(ctx context.Context, params *DeleteParametersInput, optFns ...func(*Options)) (*DeleteParametersOutput, error)
- func (c *Client) DeletePatchBaseline(ctx context.Context, params *DeletePatchBaselineInput, ...) (*DeletePatchBaselineOutput, error)
- func (c *Client) DeleteResourceDataSync(ctx context.Context, params *DeleteResourceDataSyncInput, ...) (*DeleteResourceDataSyncOutput, error)
- func (c *Client) DeregisterManagedInstance(ctx context.Context, params *DeregisterManagedInstanceInput, ...) (*DeregisterManagedInstanceOutput, error)
- func (c *Client) DeregisterPatchBaselineForPatchGroup(ctx context.Context, params *DeregisterPatchBaselineForPatchGroupInput, ...) (*DeregisterPatchBaselineForPatchGroupOutput, error)
- func (c *Client) DeregisterTargetFromMaintenanceWindow(ctx context.Context, params *DeregisterTargetFromMaintenanceWindowInput, ...) (*DeregisterTargetFromMaintenanceWindowOutput, error)
- func (c *Client) DeregisterTaskFromMaintenanceWindow(ctx context.Context, params *DeregisterTaskFromMaintenanceWindowInput, ...) (*DeregisterTaskFromMaintenanceWindowOutput, error)
- func (c *Client) DescribeActivations(ctx context.Context, params *DescribeActivationsInput, ...) (*DescribeActivationsOutput, error)
- func (c *Client) DescribeAssociation(ctx context.Context, params *DescribeAssociationInput, ...) (*DescribeAssociationOutput, error)
- func (c *Client) DescribeAssociationExecutionTargets(ctx context.Context, params *DescribeAssociationExecutionTargetsInput, ...) (*DescribeAssociationExecutionTargetsOutput, error)
- func (c *Client) DescribeAssociationExecutions(ctx context.Context, params *DescribeAssociationExecutionsInput, ...) (*DescribeAssociationExecutionsOutput, error)
- func (c *Client) DescribeAutomationExecutions(ctx context.Context, params *DescribeAutomationExecutionsInput, ...) (*DescribeAutomationExecutionsOutput, error)
- func (c *Client) DescribeAutomationStepExecutions(ctx context.Context, params *DescribeAutomationStepExecutionsInput, ...) (*DescribeAutomationStepExecutionsOutput, error)
- func (c *Client) DescribeAvailablePatches(ctx context.Context, params *DescribeAvailablePatchesInput, ...) (*DescribeAvailablePatchesOutput, error)
- func (c *Client) DescribeDocument(ctx context.Context, params *DescribeDocumentInput, optFns ...func(*Options)) (*DescribeDocumentOutput, error)
- func (c *Client) DescribeDocumentPermission(ctx context.Context, params *DescribeDocumentPermissionInput, ...) (*DescribeDocumentPermissionOutput, error)
- func (c *Client) DescribeEffectiveInstanceAssociations(ctx context.Context, params *DescribeEffectiveInstanceAssociationsInput, ...) (*DescribeEffectiveInstanceAssociationsOutput, error)
- func (c *Client) DescribeEffectivePatchesForPatchBaseline(ctx context.Context, params *DescribeEffectivePatchesForPatchBaselineInput, ...) (*DescribeEffectivePatchesForPatchBaselineOutput, error)
- func (c *Client) DescribeInstanceAssociationsStatus(ctx context.Context, params *DescribeInstanceAssociationsStatusInput, ...) (*DescribeInstanceAssociationsStatusOutput, error)
- func (c *Client) DescribeInstanceInformation(ctx context.Context, params *DescribeInstanceInformationInput, ...) (*DescribeInstanceInformationOutput, error)
- func (c *Client) DescribeInstancePatchStates(ctx context.Context, params *DescribeInstancePatchStatesInput, ...) (*DescribeInstancePatchStatesOutput, error)
- func (c *Client) DescribeInstancePatchStatesForPatchGroup(ctx context.Context, params *DescribeInstancePatchStatesForPatchGroupInput, ...) (*DescribeInstancePatchStatesForPatchGroupOutput, error)
- func (c *Client) DescribeInstancePatches(ctx context.Context, params *DescribeInstancePatchesInput, ...) (*DescribeInstancePatchesOutput, error)
- func (c *Client) DescribeInventoryDeletions(ctx context.Context, params *DescribeInventoryDeletionsInput, ...) (*DescribeInventoryDeletionsOutput, error)
- func (c *Client) DescribeMaintenanceWindowExecutionTaskInvocations(ctx context.Context, ...) (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput, error)
- func (c *Client) DescribeMaintenanceWindowExecutionTasks(ctx context.Context, params *DescribeMaintenanceWindowExecutionTasksInput, ...) (*DescribeMaintenanceWindowExecutionTasksOutput, error)
- func (c *Client) DescribeMaintenanceWindowExecutions(ctx context.Context, params *DescribeMaintenanceWindowExecutionsInput, ...) (*DescribeMaintenanceWindowExecutionsOutput, error)
- func (c *Client) DescribeMaintenanceWindowSchedule(ctx context.Context, params *DescribeMaintenanceWindowScheduleInput, ...) (*DescribeMaintenanceWindowScheduleOutput, error)
- func (c *Client) DescribeMaintenanceWindowTargets(ctx context.Context, params *DescribeMaintenanceWindowTargetsInput, ...) (*DescribeMaintenanceWindowTargetsOutput, error)
- func (c *Client) DescribeMaintenanceWindowTasks(ctx context.Context, params *DescribeMaintenanceWindowTasksInput, ...) (*DescribeMaintenanceWindowTasksOutput, error)
- func (c *Client) DescribeMaintenanceWindows(ctx context.Context, params *DescribeMaintenanceWindowsInput, ...) (*DescribeMaintenanceWindowsOutput, error)
- func (c *Client) DescribeMaintenanceWindowsForTarget(ctx context.Context, params *DescribeMaintenanceWindowsForTargetInput, ...) (*DescribeMaintenanceWindowsForTargetOutput, error)
- func (c *Client) DescribeOpsItems(ctx context.Context, params *DescribeOpsItemsInput, optFns ...func(*Options)) (*DescribeOpsItemsOutput, error)
- func (c *Client) DescribeParameters(ctx context.Context, params *DescribeParametersInput, optFns ...func(*Options)) (*DescribeParametersOutput, error)
- func (c *Client) DescribePatchBaselines(ctx context.Context, params *DescribePatchBaselinesInput, ...) (*DescribePatchBaselinesOutput, error)
- func (c *Client) DescribePatchGroupState(ctx context.Context, params *DescribePatchGroupStateInput, ...) (*DescribePatchGroupStateOutput, error)
- func (c *Client) DescribePatchGroups(ctx context.Context, params *DescribePatchGroupsInput, ...) (*DescribePatchGroupsOutput, error)
- func (c *Client) DescribePatchProperties(ctx context.Context, params *DescribePatchPropertiesInput, ...) (*DescribePatchPropertiesOutput, error)
- func (c *Client) DescribeSessions(ctx context.Context, params *DescribeSessionsInput, optFns ...func(*Options)) (*DescribeSessionsOutput, error)
- func (c *Client) GetAutomationExecution(ctx context.Context, params *GetAutomationExecutionInput, ...) (*GetAutomationExecutionOutput, error)
- func (c *Client) GetCalendarState(ctx context.Context, params *GetCalendarStateInput, optFns ...func(*Options)) (*GetCalendarStateOutput, error)
- func (c *Client) GetCommandInvocation(ctx context.Context, params *GetCommandInvocationInput, ...) (*GetCommandInvocationOutput, error)
- func (c *Client) GetConnectionStatus(ctx context.Context, params *GetConnectionStatusInput, ...) (*GetConnectionStatusOutput, error)
- func (c *Client) GetDefaultPatchBaseline(ctx context.Context, params *GetDefaultPatchBaselineInput, ...) (*GetDefaultPatchBaselineOutput, error)
- func (c *Client) GetDeployablePatchSnapshotForInstance(ctx context.Context, params *GetDeployablePatchSnapshotForInstanceInput, ...) (*GetDeployablePatchSnapshotForInstanceOutput, error)
- func (c *Client) GetDocument(ctx context.Context, params *GetDocumentInput, optFns ...func(*Options)) (*GetDocumentOutput, error)
- func (c *Client) GetInventory(ctx context.Context, params *GetInventoryInput, optFns ...func(*Options)) (*GetInventoryOutput, error)
- func (c *Client) GetInventorySchema(ctx context.Context, params *GetInventorySchemaInput, optFns ...func(*Options)) (*GetInventorySchemaOutput, error)
- func (c *Client) GetMaintenanceWindow(ctx context.Context, params *GetMaintenanceWindowInput, ...) (*GetMaintenanceWindowOutput, error)
- func (c *Client) GetMaintenanceWindowExecution(ctx context.Context, params *GetMaintenanceWindowExecutionInput, ...) (*GetMaintenanceWindowExecutionOutput, error)
- func (c *Client) GetMaintenanceWindowExecutionTask(ctx context.Context, params *GetMaintenanceWindowExecutionTaskInput, ...) (*GetMaintenanceWindowExecutionTaskOutput, error)
- func (c *Client) GetMaintenanceWindowExecutionTaskInvocation(ctx context.Context, params *GetMaintenanceWindowExecutionTaskInvocationInput, ...) (*GetMaintenanceWindowExecutionTaskInvocationOutput, error)
- func (c *Client) GetMaintenanceWindowTask(ctx context.Context, params *GetMaintenanceWindowTaskInput, ...) (*GetMaintenanceWindowTaskOutput, error)
- func (c *Client) GetOpsItem(ctx context.Context, params *GetOpsItemInput, optFns ...func(*Options)) (*GetOpsItemOutput, error)
- func (c *Client) GetOpsMetadata(ctx context.Context, params *GetOpsMetadataInput, optFns ...func(*Options)) (*GetOpsMetadataOutput, error)
- func (c *Client) GetOpsSummary(ctx context.Context, params *GetOpsSummaryInput, optFns ...func(*Options)) (*GetOpsSummaryOutput, error)
- func (c *Client) GetParameter(ctx context.Context, params *GetParameterInput, optFns ...func(*Options)) (*GetParameterOutput, error)
- func (c *Client) GetParameterHistory(ctx context.Context, params *GetParameterHistoryInput, ...) (*GetParameterHistoryOutput, error)
- func (c *Client) GetParameters(ctx context.Context, params *GetParametersInput, optFns ...func(*Options)) (*GetParametersOutput, error)
- func (c *Client) GetParametersByPath(ctx context.Context, params *GetParametersByPathInput, ...) (*GetParametersByPathOutput, error)
- func (c *Client) GetPatchBaseline(ctx context.Context, params *GetPatchBaselineInput, optFns ...func(*Options)) (*GetPatchBaselineOutput, error)
- func (c *Client) GetPatchBaselineForPatchGroup(ctx context.Context, params *GetPatchBaselineForPatchGroupInput, ...) (*GetPatchBaselineForPatchGroupOutput, error)
- func (c *Client) GetServiceSetting(ctx context.Context, params *GetServiceSettingInput, optFns ...func(*Options)) (*GetServiceSettingOutput, error)
- func (c *Client) LabelParameterVersion(ctx context.Context, params *LabelParameterVersionInput, ...) (*LabelParameterVersionOutput, error)
- func (c *Client) ListAssociationVersions(ctx context.Context, params *ListAssociationVersionsInput, ...) (*ListAssociationVersionsOutput, error)
- func (c *Client) ListAssociations(ctx context.Context, params *ListAssociationsInput, optFns ...func(*Options)) (*ListAssociationsOutput, error)
- func (c *Client) ListCommandInvocations(ctx context.Context, params *ListCommandInvocationsInput, ...) (*ListCommandInvocationsOutput, error)
- func (c *Client) ListCommands(ctx context.Context, params *ListCommandsInput, optFns ...func(*Options)) (*ListCommandsOutput, error)
- func (c *Client) ListComplianceItems(ctx context.Context, params *ListComplianceItemsInput, ...) (*ListComplianceItemsOutput, error)
- func (c *Client) ListComplianceSummaries(ctx context.Context, params *ListComplianceSummariesInput, ...) (*ListComplianceSummariesOutput, error)
- func (c *Client) ListDocumentMetadataHistory(ctx context.Context, params *ListDocumentMetadataHistoryInput, ...) (*ListDocumentMetadataHistoryOutput, error)
- func (c *Client) ListDocumentVersions(ctx context.Context, params *ListDocumentVersionsInput, ...) (*ListDocumentVersionsOutput, error)
- func (c *Client) ListDocuments(ctx context.Context, params *ListDocumentsInput, optFns ...func(*Options)) (*ListDocumentsOutput, error)
- func (c *Client) ListInventoryEntries(ctx context.Context, params *ListInventoryEntriesInput, ...) (*ListInventoryEntriesOutput, error)
- func (c *Client) ListOpsItemEvents(ctx context.Context, params *ListOpsItemEventsInput, optFns ...func(*Options)) (*ListOpsItemEventsOutput, error)
- func (c *Client) ListOpsMetadata(ctx context.Context, params *ListOpsMetadataInput, optFns ...func(*Options)) (*ListOpsMetadataOutput, error)
- func (c *Client) ListResourceComplianceSummaries(ctx context.Context, params *ListResourceComplianceSummariesInput, ...) (*ListResourceComplianceSummariesOutput, error)
- func (c *Client) ListResourceDataSync(ctx context.Context, params *ListResourceDataSyncInput, ...) (*ListResourceDataSyncOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ModifyDocumentPermission(ctx context.Context, params *ModifyDocumentPermissionInput, ...) (*ModifyDocumentPermissionOutput, error)
- func (c *Client) PutComplianceItems(ctx context.Context, params *PutComplianceItemsInput, optFns ...func(*Options)) (*PutComplianceItemsOutput, error)
- func (c *Client) PutInventory(ctx context.Context, params *PutInventoryInput, optFns ...func(*Options)) (*PutInventoryOutput, error)
- func (c *Client) PutParameter(ctx context.Context, params *PutParameterInput, optFns ...func(*Options)) (*PutParameterOutput, error)
- func (c *Client) RegisterDefaultPatchBaseline(ctx context.Context, params *RegisterDefaultPatchBaselineInput, ...) (*RegisterDefaultPatchBaselineOutput, error)
- func (c *Client) RegisterPatchBaselineForPatchGroup(ctx context.Context, params *RegisterPatchBaselineForPatchGroupInput, ...) (*RegisterPatchBaselineForPatchGroupOutput, error)
- func (c *Client) RegisterTargetWithMaintenanceWindow(ctx context.Context, params *RegisterTargetWithMaintenanceWindowInput, ...) (*RegisterTargetWithMaintenanceWindowOutput, error)
- func (c *Client) RegisterTaskWithMaintenanceWindow(ctx context.Context, params *RegisterTaskWithMaintenanceWindowInput, ...) (*RegisterTaskWithMaintenanceWindowOutput, error)
- func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, ...) (*RemoveTagsFromResourceOutput, error)
- func (c *Client) ResetServiceSetting(ctx context.Context, params *ResetServiceSettingInput, ...) (*ResetServiceSettingOutput, error)
- func (c *Client) ResumeSession(ctx context.Context, params *ResumeSessionInput, optFns ...func(*Options)) (*ResumeSessionOutput, error)
- func (c *Client) SendAutomationSignal(ctx context.Context, params *SendAutomationSignalInput, ...) (*SendAutomationSignalOutput, error)
- func (c *Client) SendCommand(ctx context.Context, params *SendCommandInput, optFns ...func(*Options)) (*SendCommandOutput, error)
- func (c *Client) StartAssociationsOnce(ctx context.Context, params *StartAssociationsOnceInput, ...) (*StartAssociationsOnceOutput, error)
- func (c *Client) StartAutomationExecution(ctx context.Context, params *StartAutomationExecutionInput, ...) (*StartAutomationExecutionOutput, error)
- func (c *Client) StartChangeRequestExecution(ctx context.Context, params *StartChangeRequestExecutionInput, ...) (*StartChangeRequestExecutionOutput, error)
- func (c *Client) StartSession(ctx context.Context, params *StartSessionInput, optFns ...func(*Options)) (*StartSessionOutput, error)
- func (c *Client) StopAutomationExecution(ctx context.Context, params *StopAutomationExecutionInput, ...) (*StopAutomationExecutionOutput, error)
- func (c *Client) TerminateSession(ctx context.Context, params *TerminateSessionInput, optFns ...func(*Options)) (*TerminateSessionOutput, error)
- func (c *Client) UpdateAssociation(ctx context.Context, params *UpdateAssociationInput, optFns ...func(*Options)) (*UpdateAssociationOutput, error)
- func (c *Client) UpdateAssociationStatus(ctx context.Context, params *UpdateAssociationStatusInput, ...) (*UpdateAssociationStatusOutput, error)
- func (c *Client) UpdateDocument(ctx context.Context, params *UpdateDocumentInput, optFns ...func(*Options)) (*UpdateDocumentOutput, error)
- func (c *Client) UpdateDocumentDefaultVersion(ctx context.Context, params *UpdateDocumentDefaultVersionInput, ...) (*UpdateDocumentDefaultVersionOutput, error)
- func (c *Client) UpdateDocumentMetadata(ctx context.Context, params *UpdateDocumentMetadataInput, ...) (*UpdateDocumentMetadataOutput, error)
- func (c *Client) UpdateMaintenanceWindow(ctx context.Context, params *UpdateMaintenanceWindowInput, ...) (*UpdateMaintenanceWindowOutput, error)
- func (c *Client) UpdateMaintenanceWindowTarget(ctx context.Context, params *UpdateMaintenanceWindowTargetInput, ...) (*UpdateMaintenanceWindowTargetOutput, error)
- func (c *Client) UpdateMaintenanceWindowTask(ctx context.Context, params *UpdateMaintenanceWindowTaskInput, ...) (*UpdateMaintenanceWindowTaskOutput, error)
- func (c *Client) UpdateManagedInstanceRole(ctx context.Context, params *UpdateManagedInstanceRoleInput, ...) (*UpdateManagedInstanceRoleOutput, error)
- func (c *Client) UpdateOpsItem(ctx context.Context, params *UpdateOpsItemInput, optFns ...func(*Options)) (*UpdateOpsItemOutput, error)
- func (c *Client) UpdateOpsMetadata(ctx context.Context, params *UpdateOpsMetadataInput, optFns ...func(*Options)) (*UpdateOpsMetadataOutput, error)
- func (c *Client) UpdatePatchBaseline(ctx context.Context, params *UpdatePatchBaselineInput, ...) (*UpdatePatchBaselineOutput, error)
- func (c *Client) UpdateResourceDataSync(ctx context.Context, params *UpdateResourceDataSyncInput, ...) (*UpdateResourceDataSyncOutput, error)
- func (c *Client) UpdateServiceSetting(ctx context.Context, params *UpdateServiceSettingInput, ...) (*UpdateServiceSettingOutput, error)
- type CommandExecutedWaiter
- type CommandExecutedWaiterOptions
- type CreateActivationInput
- type CreateActivationOutput
- type CreateAssociationBatchInput
- type CreateAssociationBatchOutput
- type CreateAssociationInput
- type CreateAssociationOutput
- type CreateDocumentInput
- type CreateDocumentOutput
- type CreateMaintenanceWindowInput
- type CreateMaintenanceWindowOutput
- type CreateOpsItemInput
- type CreateOpsItemOutput
- type CreateOpsMetadataInput
- type CreateOpsMetadataOutput
- type CreatePatchBaselineInput
- type CreatePatchBaselineOutput
- type CreateResourceDataSyncInput
- type CreateResourceDataSyncOutput
- type DeleteActivationInput
- type DeleteActivationOutput
- type DeleteAssociationInput
- type DeleteAssociationOutput
- type DeleteDocumentInput
- type DeleteDocumentOutput
- type DeleteInventoryInput
- type DeleteInventoryOutput
- type DeleteMaintenanceWindowInput
- type DeleteMaintenanceWindowOutput
- type DeleteOpsMetadataInput
- type DeleteOpsMetadataOutput
- type DeleteParameterInput
- type DeleteParameterOutput
- type DeleteParametersInput
- type DeleteParametersOutput
- type DeletePatchBaselineInput
- type DeletePatchBaselineOutput
- type DeleteResourceDataSyncInput
- type DeleteResourceDataSyncOutput
- type DeregisterManagedInstanceInput
- type DeregisterManagedInstanceOutput
- type DeregisterPatchBaselineForPatchGroupInput
- type DeregisterPatchBaselineForPatchGroupOutput
- type DeregisterTargetFromMaintenanceWindowInput
- type DeregisterTargetFromMaintenanceWindowOutput
- type DeregisterTaskFromMaintenanceWindowInput
- type DeregisterTaskFromMaintenanceWindowOutput
- type DescribeActivationsAPIClient
- type DescribeActivationsInput
- type DescribeActivationsOutput
- type DescribeActivationsPaginator
- type DescribeActivationsPaginatorOptions
- type DescribeAssociationExecutionTargetsAPIClient
- type DescribeAssociationExecutionTargetsInput
- type DescribeAssociationExecutionTargetsOutput
- type DescribeAssociationExecutionTargetsPaginator
- type DescribeAssociationExecutionTargetsPaginatorOptions
- type DescribeAssociationExecutionsAPIClient
- type DescribeAssociationExecutionsInput
- type DescribeAssociationExecutionsOutput
- type DescribeAssociationExecutionsPaginator
- type DescribeAssociationExecutionsPaginatorOptions
- type DescribeAssociationInput
- type DescribeAssociationOutput
- type DescribeAutomationExecutionsAPIClient
- type DescribeAutomationExecutionsInput
- type DescribeAutomationExecutionsOutput
- type DescribeAutomationExecutionsPaginator
- type DescribeAutomationExecutionsPaginatorOptions
- type DescribeAutomationStepExecutionsAPIClient
- type DescribeAutomationStepExecutionsInput
- type DescribeAutomationStepExecutionsOutput
- type DescribeAutomationStepExecutionsPaginator
- type DescribeAutomationStepExecutionsPaginatorOptions
- type DescribeAvailablePatchesAPIClient
- type DescribeAvailablePatchesInput
- type DescribeAvailablePatchesOutput
- type DescribeAvailablePatchesPaginator
- type DescribeAvailablePatchesPaginatorOptions
- type DescribeDocumentInput
- type DescribeDocumentOutput
- type DescribeDocumentPermissionInput
- type DescribeDocumentPermissionOutput
- type DescribeEffectiveInstanceAssociationsAPIClient
- type DescribeEffectiveInstanceAssociationsInput
- type DescribeEffectiveInstanceAssociationsOutput
- type DescribeEffectiveInstanceAssociationsPaginator
- type DescribeEffectiveInstanceAssociationsPaginatorOptions
- type DescribeEffectivePatchesForPatchBaselineAPIClient
- type DescribeEffectivePatchesForPatchBaselineInput
- type DescribeEffectivePatchesForPatchBaselineOutput
- type DescribeEffectivePatchesForPatchBaselinePaginator
- type DescribeEffectivePatchesForPatchBaselinePaginatorOptions
- type DescribeInstanceAssociationsStatusAPIClient
- type DescribeInstanceAssociationsStatusInput
- type DescribeInstanceAssociationsStatusOutput
- type DescribeInstanceAssociationsStatusPaginator
- type DescribeInstanceAssociationsStatusPaginatorOptions
- type DescribeInstanceInformationAPIClient
- type DescribeInstanceInformationInput
- type DescribeInstanceInformationOutput
- type DescribeInstanceInformationPaginator
- type DescribeInstanceInformationPaginatorOptions
- type DescribeInstancePatchStatesAPIClient
- type DescribeInstancePatchStatesForPatchGroupAPIClient
- type DescribeInstancePatchStatesForPatchGroupInput
- type DescribeInstancePatchStatesForPatchGroupOutput
- type DescribeInstancePatchStatesForPatchGroupPaginator
- type DescribeInstancePatchStatesForPatchGroupPaginatorOptions
- type DescribeInstancePatchStatesInput
- type DescribeInstancePatchStatesOutput
- type DescribeInstancePatchStatesPaginator
- type DescribeInstancePatchStatesPaginatorOptions
- type DescribeInstancePatchesAPIClient
- type DescribeInstancePatchesInput
- type DescribeInstancePatchesOutput
- type DescribeInstancePatchesPaginator
- type DescribeInstancePatchesPaginatorOptions
- type DescribeInventoryDeletionsAPIClient
- type DescribeInventoryDeletionsInput
- type DescribeInventoryDeletionsOutput
- type DescribeInventoryDeletionsPaginator
- type DescribeInventoryDeletionsPaginatorOptions
- type DescribeMaintenanceWindowExecutionTaskInvocationsAPIClient
- type DescribeMaintenanceWindowExecutionTaskInvocationsInput
- type DescribeMaintenanceWindowExecutionTaskInvocationsOutput
- type DescribeMaintenanceWindowExecutionTaskInvocationsPaginator
- type DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorOptions
- type DescribeMaintenanceWindowExecutionTasksAPIClient
- type DescribeMaintenanceWindowExecutionTasksInput
- type DescribeMaintenanceWindowExecutionTasksOutput
- type DescribeMaintenanceWindowExecutionTasksPaginator
- type DescribeMaintenanceWindowExecutionTasksPaginatorOptions
- type DescribeMaintenanceWindowExecutionsAPIClient
- type DescribeMaintenanceWindowExecutionsInput
- type DescribeMaintenanceWindowExecutionsOutput
- type DescribeMaintenanceWindowExecutionsPaginator
- type DescribeMaintenanceWindowExecutionsPaginatorOptions
- type DescribeMaintenanceWindowScheduleAPIClient
- type DescribeMaintenanceWindowScheduleInput
- type DescribeMaintenanceWindowScheduleOutput
- type DescribeMaintenanceWindowSchedulePaginator
- type DescribeMaintenanceWindowSchedulePaginatorOptions
- type DescribeMaintenanceWindowTargetsAPIClient
- type DescribeMaintenanceWindowTargetsInput
- type DescribeMaintenanceWindowTargetsOutput
- type DescribeMaintenanceWindowTargetsPaginator
- type DescribeMaintenanceWindowTargetsPaginatorOptions
- type DescribeMaintenanceWindowTasksAPIClient
- type DescribeMaintenanceWindowTasksInput
- type DescribeMaintenanceWindowTasksOutput
- type DescribeMaintenanceWindowTasksPaginator
- type DescribeMaintenanceWindowTasksPaginatorOptions
- type DescribeMaintenanceWindowsAPIClient
- type DescribeMaintenanceWindowsForTargetAPIClient
- type DescribeMaintenanceWindowsForTargetInput
- type DescribeMaintenanceWindowsForTargetOutput
- type DescribeMaintenanceWindowsForTargetPaginator
- type DescribeMaintenanceWindowsForTargetPaginatorOptions
- type DescribeMaintenanceWindowsInput
- type DescribeMaintenanceWindowsOutput
- type DescribeMaintenanceWindowsPaginator
- type DescribeMaintenanceWindowsPaginatorOptions
- type DescribeOpsItemsAPIClient
- type DescribeOpsItemsInput
- type DescribeOpsItemsOutput
- type DescribeOpsItemsPaginator
- type DescribeOpsItemsPaginatorOptions
- type DescribeParametersAPIClient
- type DescribeParametersInput
- type DescribeParametersOutput
- type DescribeParametersPaginator
- type DescribeParametersPaginatorOptions
- type DescribePatchBaselinesAPIClient
- type DescribePatchBaselinesInput
- type DescribePatchBaselinesOutput
- type DescribePatchBaselinesPaginator
- type DescribePatchBaselinesPaginatorOptions
- type DescribePatchGroupStateInput
- type DescribePatchGroupStateOutput
- type DescribePatchGroupsAPIClient
- type DescribePatchGroupsInput
- type DescribePatchGroupsOutput
- type DescribePatchGroupsPaginator
- type DescribePatchGroupsPaginatorOptions
- type DescribePatchPropertiesAPIClient
- type DescribePatchPropertiesInput
- type DescribePatchPropertiesOutput
- type DescribePatchPropertiesPaginator
- type DescribePatchPropertiesPaginatorOptions
- type DescribeSessionsAPIClient
- type DescribeSessionsInput
- type DescribeSessionsOutput
- type DescribeSessionsPaginator
- type DescribeSessionsPaginatorOptions
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetAutomationExecutionInput
- type GetAutomationExecutionOutput
- type GetCalendarStateInput
- type GetCalendarStateOutput
- type GetCommandInvocationAPIClient
- type GetCommandInvocationInput
- type GetCommandInvocationOutput
- type GetConnectionStatusInput
- type GetConnectionStatusOutput
- type GetDefaultPatchBaselineInput
- type GetDefaultPatchBaselineOutput
- type GetDeployablePatchSnapshotForInstanceInput
- type GetDeployablePatchSnapshotForInstanceOutput
- type GetDocumentInput
- type GetDocumentOutput
- type GetInventoryAPIClient
- type GetInventoryInput
- type GetInventoryOutput
- type GetInventoryPaginator
- type GetInventoryPaginatorOptions
- type GetInventorySchemaAPIClient
- type GetInventorySchemaInput
- type GetInventorySchemaOutput
- type GetInventorySchemaPaginator
- type GetInventorySchemaPaginatorOptions
- type GetMaintenanceWindowExecutionInput
- type GetMaintenanceWindowExecutionOutput
- type GetMaintenanceWindowExecutionTaskInput
- type GetMaintenanceWindowExecutionTaskInvocationInput
- type GetMaintenanceWindowExecutionTaskInvocationOutput
- type GetMaintenanceWindowExecutionTaskOutput
- type GetMaintenanceWindowInput
- type GetMaintenanceWindowOutput
- type GetMaintenanceWindowTaskInput
- type GetMaintenanceWindowTaskOutput
- type GetOpsItemInput
- type GetOpsItemOutput
- type GetOpsMetadataInput
- type GetOpsMetadataOutput
- type GetOpsSummaryAPIClient
- type GetOpsSummaryInput
- type GetOpsSummaryOutput
- type GetOpsSummaryPaginator
- type GetOpsSummaryPaginatorOptions
- type GetParameterHistoryAPIClient
- type GetParameterHistoryInput
- type GetParameterHistoryOutput
- type GetParameterHistoryPaginator
- type GetParameterHistoryPaginatorOptions
- type GetParameterInput
- type GetParameterOutput
- type GetParametersByPathAPIClient
- type GetParametersByPathInput
- type GetParametersByPathOutput
- type GetParametersByPathPaginator
- type GetParametersByPathPaginatorOptions
- type GetParametersInput
- type GetParametersOutput
- type GetPatchBaselineForPatchGroupInput
- type GetPatchBaselineForPatchGroupOutput
- type GetPatchBaselineInput
- type GetPatchBaselineOutput
- type GetServiceSettingInput
- type GetServiceSettingOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type LabelParameterVersionInput
- type LabelParameterVersionOutput
- type ListAssociationVersionsAPIClient
- type ListAssociationVersionsInput
- type ListAssociationVersionsOutput
- type ListAssociationVersionsPaginator
- type ListAssociationVersionsPaginatorOptions
- type ListAssociationsAPIClient
- type ListAssociationsInput
- type ListAssociationsOutput
- type ListAssociationsPaginator
- type ListAssociationsPaginatorOptions
- type ListCommandInvocationsAPIClient
- type ListCommandInvocationsInput
- type ListCommandInvocationsOutput
- type ListCommandInvocationsPaginator
- type ListCommandInvocationsPaginatorOptions
- type ListCommandsAPIClient
- type ListCommandsInput
- type ListCommandsOutput
- type ListCommandsPaginator
- type ListCommandsPaginatorOptions
- type ListComplianceItemsAPIClient
- type ListComplianceItemsInput
- type ListComplianceItemsOutput
- type ListComplianceItemsPaginator
- type ListComplianceItemsPaginatorOptions
- type ListComplianceSummariesAPIClient
- type ListComplianceSummariesInput
- type ListComplianceSummariesOutput
- type ListComplianceSummariesPaginator
- type ListComplianceSummariesPaginatorOptions
- type ListDocumentMetadataHistoryInput
- type ListDocumentMetadataHistoryOutput
- type ListDocumentVersionsAPIClient
- type ListDocumentVersionsInput
- type ListDocumentVersionsOutput
- type ListDocumentVersionsPaginator
- type ListDocumentVersionsPaginatorOptions
- type ListDocumentsAPIClient
- type ListDocumentsInput
- type ListDocumentsOutput
- type ListDocumentsPaginator
- type ListDocumentsPaginatorOptions
- type ListInventoryEntriesInput
- type ListInventoryEntriesOutput
- type ListOpsItemEventsAPIClient
- type ListOpsItemEventsInput
- type ListOpsItemEventsOutput
- type ListOpsItemEventsPaginator
- type ListOpsItemEventsPaginatorOptions
- type ListOpsMetadataAPIClient
- type ListOpsMetadataInput
- type ListOpsMetadataOutput
- type ListOpsMetadataPaginator
- type ListOpsMetadataPaginatorOptions
- type ListResourceComplianceSummariesAPIClient
- type ListResourceComplianceSummariesInput
- type ListResourceComplianceSummariesOutput
- type ListResourceComplianceSummariesPaginator
- type ListResourceComplianceSummariesPaginatorOptions
- type ListResourceDataSyncAPIClient
- type ListResourceDataSyncInput
- type ListResourceDataSyncOutput
- type ListResourceDataSyncPaginator
- type ListResourceDataSyncPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ModifyDocumentPermissionInput
- type ModifyDocumentPermissionOutput
- type Options
- type PutComplianceItemsInput
- type PutComplianceItemsOutput
- type PutInventoryInput
- type PutInventoryOutput
- type PutParameterInput
- type PutParameterOutput
- type RegisterDefaultPatchBaselineInput
- type RegisterDefaultPatchBaselineOutput
- type RegisterPatchBaselineForPatchGroupInput
- type RegisterPatchBaselineForPatchGroupOutput
- type RegisterTargetWithMaintenanceWindowInput
- type RegisterTargetWithMaintenanceWindowOutput
- type RegisterTaskWithMaintenanceWindowInput
- type RegisterTaskWithMaintenanceWindowOutput
- type RemoveTagsFromResourceInput
- type RemoveTagsFromResourceOutput
- type ResetServiceSettingInput
- type ResetServiceSettingOutput
- type ResolveEndpoint
- type ResumeSessionInput
- type ResumeSessionOutput
- type SendAutomationSignalInput
- type SendAutomationSignalOutput
- type SendCommandInput
- type SendCommandOutput
- type StartAssociationsOnceInput
- type StartAssociationsOnceOutput
- type StartAutomationExecutionInput
- type StartAutomationExecutionOutput
- type StartChangeRequestExecutionInput
- type StartChangeRequestExecutionOutput
- type StartSessionInput
- type StartSessionOutput
- type StopAutomationExecutionInput
- type StopAutomationExecutionOutput
- type TerminateSessionInput
- type TerminateSessionOutput
- type UpdateAssociationInput
- type UpdateAssociationOutput
- type UpdateAssociationStatusInput
- type UpdateAssociationStatusOutput
- type UpdateDocumentDefaultVersionInput
- type UpdateDocumentDefaultVersionOutput
- type UpdateDocumentInput
- type UpdateDocumentMetadataInput
- type UpdateDocumentMetadataOutput
- type UpdateDocumentOutput
- type UpdateMaintenanceWindowInput
- type UpdateMaintenanceWindowOutput
- type UpdateMaintenanceWindowTargetInput
- type UpdateMaintenanceWindowTargetOutput
- type UpdateMaintenanceWindowTaskInput
- type UpdateMaintenanceWindowTaskOutput
- type UpdateManagedInstanceRoleInput
- type UpdateManagedInstanceRoleOutput
- type UpdateOpsItemInput
- type UpdateOpsItemOutput
- type UpdateOpsMetadataInput
- type UpdateOpsMetadataOutput
- type UpdatePatchBaselineInput
- type UpdatePatchBaselineOutput
- type UpdateResourceDataSyncInput
- type UpdateResourceDataSyncOutput
- type UpdateServiceSettingInput
- type UpdateServiceSettingOutput
Constants ¶
const ServiceAPIVersion = "2014-11-06"
const ServiceID = "SSM"
Variables ¶
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AddTagsToResourceInput ¶
type AddTagsToResourceInput struct { // 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. // // This member is required. ResourceId *string // 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. // // This member is required. 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. // // This member is required. Tags []types.Tag }
type AddTagsToResourceOutput ¶
type AddTagsToResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CancelCommandInput ¶
type CancelCommandInput struct { // The ID of the command you want to cancel. // // This member is required. CommandId *string // (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 }
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. // // This member is required. 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
}
Client provides the API client to make operations call for Amazon Simple Systems Manager (SSM).
func New ¶
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 ¶
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. Each resource can have a maximum of 50 tags. 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) CreateOpsMetadata ¶
func (c *Client) CreateOpsMetadata(ctx context.Context, params *CreateOpsMetadataInput, optFns ...func(*Options)) (*CreateOpsMetadataOutput, error)
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
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. You can configure Systems Manager Explorer to use the SyncFromSource 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. 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. 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.
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) DeleteOpsMetadata ¶
func (c *Client) DeleteOpsMetadata(ctx context.Context, params *DeleteOpsMetadataInput, optFns ...func(*Options)) (*DeleteOpsMetadataOutput, error)
Delete OpsMetadata related to an application.
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. For maintenance window tasks without a specified target, you cannot supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values do not affect the running of your task and can be ignored.
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: AMAZON_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY AMAZON_LINUX_2 Valid properties: PRODUCT, CLASSIFICATION, SEVERITY CENTOS Valid properties: PRODUCT, CLASSIFICATION, SEVERITY DEBIAN Valid properties: PRODUCT, PRIORITY MACOS Valid properties: PRODUCT, CLASSIFICATION ORACLE_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY REDHAT_ENTERPRISE_LINUX Valid properties: PRODUCT, CLASSIFICATION, SEVERITY SUSE Valid properties: PRODUCT, CLASSIFICATION, SEVERITY UBUNTU Valid properties: PRODUCT, PRIORITY WINDOWS Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_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. If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is 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. For maintenance window tasks without a specified target, you cannot supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values do not affect the running of your task and can be ignored.
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) GetOpsMetadata ¶
func (c *Client) GetOpsMetadata(ctx context.Context, params *GetOpsMetadataInput, optFns ...func(*Options)) (*GetOpsMetadataOutput, error)
View operational metadata related to an application in Application Manager.
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)
Retrieves the history of all changes to a parameter.
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. Query the current service setting for the account.
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) ListDocumentMetadataHistory ¶
func (c *Client) ListDocumentMetadataHistory(ctx context.Context, params *ListDocumentMetadataHistoryInput, optFns ...func(*Options)) (*ListDocumentMetadataHistoryOutput, error)
Information about approval reviews for a version of an SSM document.
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) ListOpsItemEvents ¶
func (c *Client) ListOpsItemEvents(ctx context.Context, params *ListOpsItemEventsInput, optFns ...func(*Options)) (*ListOpsItemEventsOutput, error)
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
func (*Client) ListOpsMetadata ¶
func (c *Client) ListOpsMetadata(ctx context.Context, params *ListOpsMetadataInput, optFns ...func(*Options)) (*ListOpsMetadataOutput, error)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
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. 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) StartChangeRequestExecution ¶
func (c *Client) StartChangeRequestExecution(ctx context.Context, params *StartChangeRequestExecutionInput, optFns ...func(*Options)) (*StartChangeRequestExecutionOutput, error)
Creates a change request for Change Manager. The runbooks (Automation documents) specified in the change request run only after all required approvals for the change request have been received.
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) UpdateDocumentMetadata ¶
func (c *Client) UpdateDocumentMetadata(ctx context.Context, params *UpdateDocumentMetadataInput, optFns ...func(*Options)) (*UpdateDocumentMetadataOutput, error)
Updates information related to approval reviews for a specific 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:
* Name
* Description
* Owner
* IDs for an ID target
* Tags for a Tag target
* From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field is not modified.
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
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, AWS Lambda, and AWS Step Functions). For more information about running tasks that do not specify targets, see see Registering maintenance window tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) in the AWS Systems Manager User Guide. If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field is not modified. 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. When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.
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) UpdateOpsMetadata ¶
func (c *Client) UpdateOpsMetadata(ctx context.Context, params *UpdateOpsMetadataInput, optFns ...func(*Options)) (*UpdateOpsMetadataOutput, error)
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
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. Update the service setting for the account.
type CommandExecutedWaiter ¶
type CommandExecutedWaiter struct {
// contains filtered or unexported fields
}
CommandExecutedWaiter defines the waiters for CommandExecuted
func NewCommandExecutedWaiter ¶
func NewCommandExecutedWaiter(client GetCommandInvocationAPIClient, optFns ...func(*CommandExecutedWaiterOptions)) *CommandExecutedWaiter
NewCommandExecutedWaiter constructs a CommandExecutedWaiter.
func (*CommandExecutedWaiter) Wait ¶
func (w *CommandExecutedWaiter) Wait(ctx context.Context, params *GetCommandInvocationInput, maxWaitDur time.Duration, optFns ...func(*CommandExecutedWaiterOptions)) error
Wait calls the waiter function for CommandExecuted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type CommandExecutedWaiterOptions ¶
type CommandExecutedWaiterOptions 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 // MinDelay is the minimum amount of time to delay between retries. If unset, // CommandExecutedWaiter will use default minimum delay of 5 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or set // to zero, CommandExecutedWaiter will use default max delay of 120 seconds. Note // that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. By // default service-modeled logic will populate this option. This option can thus be // used to define a custom waiter state with fall-back to service-modeled waiter // state mutators.The function returns an error in case of a failure state. In case // of retry state, this function returns a bool value of true and nil error, while // in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetCommandInvocationInput, *GetCommandInvocationOutput, error) (bool, error) }
CommandExecutedWaiterOptions are waiter options for CommandExecutedWaiter
type CreateActivationInput ¶
type CreateActivationInput struct { // 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. // // This member is required. IamRole *string // 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 // 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 // Specify the maximum number of managed instances you want to register. The // default value is 1 instance. RegistrationLimit int32 // 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. 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 }
type CreateActivationOutput ¶
type CreateActivationOutput struct { // The code the system generates when it processes the activation. The activation // code functions like a password to validate the activation ID. ActivationCode *string // The ID number generated by the system when it processed the activation. The // activation ID functions like a user name. ActivationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateAssociationBatchInput ¶
type CreateAssociationBatchInput struct { // One or more associations. // // This member is required. Entries []types.CreateAssociationBatchRequestEntry }
type CreateAssociationBatchOutput ¶
type CreateAssociationBatchOutput struct { // Information about the associations that failed. Failed []types.FailedCreateAssociation // Information about the associations that succeeded. Successful []types.AssociationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateAssociationInput ¶
type CreateAssociationInput struct { // 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. // // This member is required. Name *string // 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. This parameter is not supported for rate expressions. ApplyOnlyAtCronInterval bool // Specify a descriptive name for the association. AssociationName *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 severity level to assign to the association. ComplianceSeverity types.AssociationComplianceSeverity // The document version you want to associate with the target(s). Can be a specific // version or the default version. DocumentVersion *string // 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 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 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 // An S3 bucket where you want to store the output details of the request. OutputLocation *types.InstanceAssociationOutputLocation // The parameters for the runtime configuration of the document. Parameters map[string][]string // A cron expression when the association will be applied to the target(s). ScheduleExpression *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 // A location is a combination of AWS Regions and AWS accounts where you want to // run the association. Use this action to create an association in multiple // Regions and multiple accounts. TargetLocations []types.TargetLocation // 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 }
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 { // 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) // // This member is required. Content *string // 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 // // This member is required. Name *string // A list of key and value pairs that describe attachments to a version of a // document. Attachments []types.AttachmentsSource // Specify the document format for the request. The document format can be JSON, // YAML, or TEXT. JSON is the default format. DocumentFormat types.DocumentFormat // The type of document to create. DocumentType types.DocumentType // 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 // 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: // // * Key=OS,Value=Windows // // * // Key=Environment,Value=Production // // To add tags to an existing SSM document, use // the AddTagsToResource action. Tags []types.Tag // 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 }
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 { // 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. // // This member is required. AllowUnassociatedTargets bool // The number of hours before the end of the maintenance window that Systems // Manager stops scheduling new tasks for execution. // // This member is required. Cutoff int32 // The duration of the maintenance window in hours. // // This member is required. Duration int32 // The name of the maintenance window. // // This member is required. Name *string // The schedule of the maintenance window in the form of a cron or rate expression. // // This member is required. Schedule *string // User-provided idempotency token. ClientToken *string // An optional description for the maintenance window. We recommend specifying a // description to help you organize your maintenance windows. Description *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 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(30 23 ? * TUE#3 *) If the schedule offset is 2, // the maintenance window won't run until two days later. ScheduleOffset int32 // The time zone that the scheduled maintenance window executions are based on, in // Internet Assigned Numbers Authority (IANA) format. For example: // "America/Los_Angeles", "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 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 // 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 }
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 { // Information about the OpsItem. // // This member is required. Description *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. // // This member is required. Source *string // A short heading that describes the nature of the OpsItem and the impacted // resource. // // This member is required. Title *string // The time a runbook workflow ended. Currently reported only for the OpsItem type // /aws/changerequest. ActualEndTime *time.Time // The time a runbook workflow started. Currently reported only for the OpsItem // type /aws/changerequest. ActualStartTime *time.Time // Specify a category to assign to an OpsItem. Category *string // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when // this OpsItem is edited or changed. Notifications []types.OpsItemNotification // 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). // Use the /aws/resources 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 type of OpsItem to create. Currently, the only valid values are // /aws/changerequest and /aws/issue. OpsItemType *string // The time specified in a change request for a runbook workflow to end. Currently // supported only for the OpsItem type /aws/changerequest. PlannedEndTime *time.Time // The time specified in a change request for a runbook workflow to start. // Currently supported only for the OpsItem type /aws/changerequest. PlannedStartTime *time.Time // The importance of this OpsItem in relation to other OpsItems in the system. Priority *int32 // 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 severity to assign to an OpsItem. Severity *string // 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: // Key=Department,Value=Finance To add tags to an existing OpsItem, use the // AddTagsToResource action. Tags []types.Tag }
type CreateOpsItemOutput ¶
type CreateOpsItemOutput struct { // The ID of the OpsItem. OpsItemId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateOpsMetadataInput ¶
type CreateOpsMetadataInput struct { // A resource ID for a new Application Manager application. // // This member is required. ResourceId *string // Metadata for a new Application Manager application. Metadata map[string]types.MetadataValue }
type CreateOpsMetadataOutput ¶
type CreateOpsMetadataOutput struct { // The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the // call. OpsMetadataArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreatePatchBaselineInput ¶
type CreatePatchBaselineInput struct { // The name of the patch baseline. // // This member is required. Name *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 // 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 // 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 // User-provided idempotency token. ClientToken *string // A description of the patch baseline. Description *string // A set of global filters used to include patches in the baseline. GlobalFilters *types.PatchFilterGroup // Defines the operating system the patch baseline applies to. The Default value is // WINDOWS. OperatingSystem types.OperatingSystem // 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 // 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 // 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 }
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 { // A name for the configuration. // // This member is required. SyncName *string // Amazon S3 configuration details for the sync. This parameter is required if the // SyncType value is SyncToDestination. S3Destination *types.ResourceDataSyncS3Destination // Specify information about the data sources to synchronize. This parameter is // required if the SyncType value is SyncFromSource. SyncSource *types.ResourceDataSyncSource // 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 }
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. // // This member is required. ActivationId *string }
type DeleteActivationOutput ¶
type DeleteActivationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAssociationInput ¶
type DeleteAssociationOutput ¶
type DeleteAssociationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDocumentInput ¶
type DeleteDocumentInput struct { // The name of the document. // // This member is required. Name *string // The version of the document that you want to delete. If not provided, all // versions of the document are deleted. DocumentVersion *string // 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 }
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. // // This member is required. TypeName *string // User-provided idempotency token. ClientToken *string // 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 // 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 }
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. // // This member is required. 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 DeleteOpsMetadataInput ¶
type DeleteOpsMetadataInput struct { // The Amazon Resource Name (ARN) of an OpsMetadata Object to delete. // // This member is required. OpsMetadataArn *string }
type DeleteOpsMetadataOutput ¶
type DeleteOpsMetadataOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteParameterInput ¶
type DeleteParameterInput struct { // The name of the parameter to delete. // // This member is required. 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. // // This member is required. 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. // // This member is required. 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 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. // // This member is required. InstanceId *string }
type DeregisterManagedInstanceOutput ¶
type DeregisterManagedInstanceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeregisterPatchBaselineForPatchGroupInput ¶
type DeregisterPatchBaselineForPatchGroupInput struct { // The ID of the patch baseline to deregister the patch group from. // // This member is required. BaselineId *string // The name of the patch group that should be deregistered from the patch baseline. // // This member is required. PatchGroup *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 maintenance window the target should be removed from. // // This member is required. WindowId *string // The ID of the target definition to remove. // // This member is required. 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 }
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 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 DescribeActivationsAPIClient ¶
type DescribeActivationsAPIClient interface {
DescribeActivations(context.Context, *DescribeActivationsInput, ...func(*Options)) (*DescribeActivationsOutput, error)
}
DescribeActivationsAPIClient is a client that implements the DescribeActivations operation.
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 DescribeActivationsPaginator ¶
type DescribeActivationsPaginator struct {
// contains filtered or unexported fields
}
DescribeActivationsPaginator is a paginator for DescribeActivations
func NewDescribeActivationsPaginator ¶
func NewDescribeActivationsPaginator(client DescribeActivationsAPIClient, params *DescribeActivationsInput, optFns ...func(*DescribeActivationsPaginatorOptions)) *DescribeActivationsPaginator
NewDescribeActivationsPaginator returns a new DescribeActivationsPaginator
func (*DescribeActivationsPaginator) HasMorePages ¶
func (p *DescribeActivationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeActivationsPaginator) NextPage ¶
func (p *DescribeActivationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeActivationsOutput, error)
NextPage retrieves the next DescribeActivations page.
type DescribeActivationsPaginatorOptions ¶
type DescribeActivationsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeActivationsPaginatorOptions is the paginator options for DescribeActivations
type DescribeAssociationExecutionTargetsAPIClient ¶
type DescribeAssociationExecutionTargetsAPIClient interface {
DescribeAssociationExecutionTargets(context.Context, *DescribeAssociationExecutionTargetsInput, ...func(*Options)) (*DescribeAssociationExecutionTargetsOutput, error)
}
DescribeAssociationExecutionTargetsAPIClient is a client that implements the DescribeAssociationExecutionTargets operation.
type DescribeAssociationExecutionTargetsInput ¶
type DescribeAssociationExecutionTargetsInput struct { // The association ID that includes the execution for which you want to view // details. // // This member is required. AssociationId *string // The execution ID for which you want to view details. // // This member is required. ExecutionId *string // Filters for the request. You can specify the following filters and values. // Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL) Filters []types.AssociationExecutionTargetsFilter // 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 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 DescribeAssociationExecutionTargetsPaginator ¶
type DescribeAssociationExecutionTargetsPaginator struct {
// contains filtered or unexported fields
}
DescribeAssociationExecutionTargetsPaginator is a paginator for DescribeAssociationExecutionTargets
func NewDescribeAssociationExecutionTargetsPaginator ¶
func NewDescribeAssociationExecutionTargetsPaginator(client DescribeAssociationExecutionTargetsAPIClient, params *DescribeAssociationExecutionTargetsInput, optFns ...func(*DescribeAssociationExecutionTargetsPaginatorOptions)) *DescribeAssociationExecutionTargetsPaginator
NewDescribeAssociationExecutionTargetsPaginator returns a new DescribeAssociationExecutionTargetsPaginator
func (*DescribeAssociationExecutionTargetsPaginator) HasMorePages ¶
func (p *DescribeAssociationExecutionTargetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAssociationExecutionTargetsPaginator) NextPage ¶
func (p *DescribeAssociationExecutionTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAssociationExecutionTargetsOutput, error)
NextPage retrieves the next DescribeAssociationExecutionTargets page.
type DescribeAssociationExecutionTargetsPaginatorOptions ¶
type DescribeAssociationExecutionTargetsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAssociationExecutionTargetsPaginatorOptions is the paginator options for DescribeAssociationExecutionTargets
type DescribeAssociationExecutionsAPIClient ¶
type DescribeAssociationExecutionsAPIClient interface {
DescribeAssociationExecutions(context.Context, *DescribeAssociationExecutionsInput, ...func(*Options)) (*DescribeAssociationExecutionsOutput, error)
}
DescribeAssociationExecutionsAPIClient is a client that implements the DescribeAssociationExecutions operation.
type DescribeAssociationExecutionsInput ¶
type DescribeAssociationExecutionsInput struct { // The association ID for which you want to view execution history details. // // This member is required. AssociationId *string // 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 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 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 DescribeAssociationExecutionsPaginator ¶
type DescribeAssociationExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeAssociationExecutionsPaginator is a paginator for DescribeAssociationExecutions
func NewDescribeAssociationExecutionsPaginator ¶
func NewDescribeAssociationExecutionsPaginator(client DescribeAssociationExecutionsAPIClient, params *DescribeAssociationExecutionsInput, optFns ...func(*DescribeAssociationExecutionsPaginatorOptions)) *DescribeAssociationExecutionsPaginator
NewDescribeAssociationExecutionsPaginator returns a new DescribeAssociationExecutionsPaginator
func (*DescribeAssociationExecutionsPaginator) HasMorePages ¶
func (p *DescribeAssociationExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAssociationExecutionsPaginator) NextPage ¶
func (p *DescribeAssociationExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAssociationExecutionsOutput, error)
NextPage retrieves the next DescribeAssociationExecutions page.
type DescribeAssociationExecutionsPaginatorOptions ¶
type DescribeAssociationExecutionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAssociationExecutionsPaginatorOptions is the paginator options for DescribeAssociationExecutions
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 instance ID. InstanceId *string // The name of the Systems Manager document. Name *string }
type DescribeAssociationOutput ¶
type DescribeAssociationOutput struct { // Information about the association. AssociationDescription *types.AssociationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAutomationExecutionsAPIClient ¶
type DescribeAutomationExecutionsAPIClient interface {
DescribeAutomationExecutions(context.Context, *DescribeAutomationExecutionsInput, ...func(*Options)) (*DescribeAutomationExecutionsOutput, error)
}
DescribeAutomationExecutionsAPIClient is a client that implements the DescribeAutomationExecutions operation.
type DescribeAutomationExecutionsInput ¶
type DescribeAutomationExecutionsInput struct { // Filters used to limit the scope of executions that are requested. Filters []types.AutomationExecutionFilter // 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 DescribeAutomationExecutionsOutput ¶
type DescribeAutomationExecutionsOutput struct { // The list of details about each automation execution which has occurred which // matches the filter specification, if any. AutomationExecutionMetadataList []types.AutomationExecutionMetadata // 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 DescribeAutomationExecutionsPaginator ¶
type DescribeAutomationExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeAutomationExecutionsPaginator is a paginator for DescribeAutomationExecutions
func NewDescribeAutomationExecutionsPaginator ¶
func NewDescribeAutomationExecutionsPaginator(client DescribeAutomationExecutionsAPIClient, params *DescribeAutomationExecutionsInput, optFns ...func(*DescribeAutomationExecutionsPaginatorOptions)) *DescribeAutomationExecutionsPaginator
NewDescribeAutomationExecutionsPaginator returns a new DescribeAutomationExecutionsPaginator
func (*DescribeAutomationExecutionsPaginator) HasMorePages ¶
func (p *DescribeAutomationExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAutomationExecutionsPaginator) NextPage ¶
func (p *DescribeAutomationExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAutomationExecutionsOutput, error)
NextPage retrieves the next DescribeAutomationExecutions page.
type DescribeAutomationExecutionsPaginatorOptions ¶
type DescribeAutomationExecutionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAutomationExecutionsPaginatorOptions is the paginator options for DescribeAutomationExecutions
type DescribeAutomationStepExecutionsAPIClient ¶
type DescribeAutomationStepExecutionsAPIClient interface {
DescribeAutomationStepExecutions(context.Context, *DescribeAutomationStepExecutionsInput, ...func(*Options)) (*DescribeAutomationStepExecutionsOutput, error)
}
DescribeAutomationStepExecutionsAPIClient is a client that implements the DescribeAutomationStepExecutions operation.
type DescribeAutomationStepExecutionsInput ¶
type DescribeAutomationStepExecutionsInput struct { // The Automation execution ID for which you want step execution descriptions. // // This member is required. AutomationExecutionId *string // One or more filters to limit the number of step executions returned by the // request. Filters []types.StepExecutionFilter // 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 // 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 DescribeAutomationStepExecutionsPaginator ¶
type DescribeAutomationStepExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeAutomationStepExecutionsPaginator is a paginator for DescribeAutomationStepExecutions
func NewDescribeAutomationStepExecutionsPaginator ¶
func NewDescribeAutomationStepExecutionsPaginator(client DescribeAutomationStepExecutionsAPIClient, params *DescribeAutomationStepExecutionsInput, optFns ...func(*DescribeAutomationStepExecutionsPaginatorOptions)) *DescribeAutomationStepExecutionsPaginator
NewDescribeAutomationStepExecutionsPaginator returns a new DescribeAutomationStepExecutionsPaginator
func (*DescribeAutomationStepExecutionsPaginator) HasMorePages ¶
func (p *DescribeAutomationStepExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAutomationStepExecutionsPaginator) NextPage ¶
func (p *DescribeAutomationStepExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAutomationStepExecutionsOutput, error)
NextPage retrieves the next DescribeAutomationStepExecutions page.
type DescribeAutomationStepExecutionsPaginatorOptions ¶
type DescribeAutomationStepExecutionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAutomationStepExecutionsPaginatorOptions is the paginator options for DescribeAutomationStepExecutions
type DescribeAvailablePatchesAPIClient ¶
type DescribeAvailablePatchesAPIClient interface {
DescribeAvailablePatches(context.Context, *DescribeAvailablePatchesInput, ...func(*Options)) (*DescribeAvailablePatchesOutput, error)
}
DescribeAvailablePatchesAPIClient is a client that implements the DescribeAvailablePatches operation.
type DescribeAvailablePatchesInput ¶
type DescribeAvailablePatchesInput struct { // Filters used to scope down the returned patches. Filters []types.PatchOrchestratorFilter // 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 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 DescribeAvailablePatchesPaginator ¶
type DescribeAvailablePatchesPaginator struct {
// contains filtered or unexported fields
}
DescribeAvailablePatchesPaginator is a paginator for DescribeAvailablePatches
func NewDescribeAvailablePatchesPaginator ¶
func NewDescribeAvailablePatchesPaginator(client DescribeAvailablePatchesAPIClient, params *DescribeAvailablePatchesInput, optFns ...func(*DescribeAvailablePatchesPaginatorOptions)) *DescribeAvailablePatchesPaginator
NewDescribeAvailablePatchesPaginator returns a new DescribeAvailablePatchesPaginator
func (*DescribeAvailablePatchesPaginator) HasMorePages ¶
func (p *DescribeAvailablePatchesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAvailablePatchesPaginator) NextPage ¶
func (p *DescribeAvailablePatchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAvailablePatchesOutput, error)
NextPage retrieves the next DescribeAvailablePatches page.
type DescribeAvailablePatchesPaginatorOptions ¶
type DescribeAvailablePatchesPaginatorOptions struct { // The maximum number of patches to return (per page). Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAvailablePatchesPaginatorOptions is the paginator options for DescribeAvailablePatches
type DescribeDocumentInput ¶
type DescribeDocumentInput struct { // The name of the Systems Manager document. // // This member is required. Name *string // The document version for which you want information. Can be a specific version // or the default version. DocumentVersion *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 cannot be changed. VersionName *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. // // This member is required. Name *string // The permission type for the document. The permission type can be Share. // // This member is required. 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 DescribeEffectiveInstanceAssociationsAPIClient ¶
type DescribeEffectiveInstanceAssociationsAPIClient interface {
DescribeEffectiveInstanceAssociations(context.Context, *DescribeEffectiveInstanceAssociationsInput, ...func(*Options)) (*DescribeEffectiveInstanceAssociationsOutput, error)
}
DescribeEffectiveInstanceAssociationsAPIClient is a client that implements the DescribeEffectiveInstanceAssociations operation.
type DescribeEffectiveInstanceAssociationsInput ¶
type DescribeEffectiveInstanceAssociationsInput struct { // The instance ID for which you want to view all associations. // // This member is required. InstanceId *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 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 DescribeEffectiveInstanceAssociationsPaginator ¶
type DescribeEffectiveInstanceAssociationsPaginator struct {
// contains filtered or unexported fields
}
DescribeEffectiveInstanceAssociationsPaginator is a paginator for DescribeEffectiveInstanceAssociations
func NewDescribeEffectiveInstanceAssociationsPaginator ¶
func NewDescribeEffectiveInstanceAssociationsPaginator(client DescribeEffectiveInstanceAssociationsAPIClient, params *DescribeEffectiveInstanceAssociationsInput, optFns ...func(*DescribeEffectiveInstanceAssociationsPaginatorOptions)) *DescribeEffectiveInstanceAssociationsPaginator
NewDescribeEffectiveInstanceAssociationsPaginator returns a new DescribeEffectiveInstanceAssociationsPaginator
func (*DescribeEffectiveInstanceAssociationsPaginator) HasMorePages ¶
func (p *DescribeEffectiveInstanceAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeEffectiveInstanceAssociationsPaginator) NextPage ¶
func (p *DescribeEffectiveInstanceAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEffectiveInstanceAssociationsOutput, error)
NextPage retrieves the next DescribeEffectiveInstanceAssociations page.
type DescribeEffectiveInstanceAssociationsPaginatorOptions ¶
type DescribeEffectiveInstanceAssociationsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeEffectiveInstanceAssociationsPaginatorOptions is the paginator options for DescribeEffectiveInstanceAssociations
type DescribeEffectivePatchesForPatchBaselineAPIClient ¶
type DescribeEffectivePatchesForPatchBaselineAPIClient interface {
DescribeEffectivePatchesForPatchBaseline(context.Context, *DescribeEffectivePatchesForPatchBaselineInput, ...func(*Options)) (*DescribeEffectivePatchesForPatchBaselineOutput, error)
}
DescribeEffectivePatchesForPatchBaselineAPIClient is a client that implements the DescribeEffectivePatchesForPatchBaseline operation.
type DescribeEffectivePatchesForPatchBaselineInput ¶
type DescribeEffectivePatchesForPatchBaselineInput struct { // The ID of the patch baseline to retrieve the effective patches for. // // This member is required. BaselineId *string // 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 DescribeEffectivePatchesForPatchBaselineOutput ¶
type DescribeEffectivePatchesForPatchBaselineOutput struct { // An array of patches and patch status. EffectivePatches []types.EffectivePatch // 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 DescribeEffectivePatchesForPatchBaselinePaginator ¶
type DescribeEffectivePatchesForPatchBaselinePaginator struct {
// contains filtered or unexported fields
}
DescribeEffectivePatchesForPatchBaselinePaginator is a paginator for DescribeEffectivePatchesForPatchBaseline
func NewDescribeEffectivePatchesForPatchBaselinePaginator ¶
func NewDescribeEffectivePatchesForPatchBaselinePaginator(client DescribeEffectivePatchesForPatchBaselineAPIClient, params *DescribeEffectivePatchesForPatchBaselineInput, optFns ...func(*DescribeEffectivePatchesForPatchBaselinePaginatorOptions)) *DescribeEffectivePatchesForPatchBaselinePaginator
NewDescribeEffectivePatchesForPatchBaselinePaginator returns a new DescribeEffectivePatchesForPatchBaselinePaginator
func (*DescribeEffectivePatchesForPatchBaselinePaginator) HasMorePages ¶
func (p *DescribeEffectivePatchesForPatchBaselinePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeEffectivePatchesForPatchBaselinePaginator) NextPage ¶
func (p *DescribeEffectivePatchesForPatchBaselinePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEffectivePatchesForPatchBaselineOutput, error)
NextPage retrieves the next DescribeEffectivePatchesForPatchBaseline page.
type DescribeEffectivePatchesForPatchBaselinePaginatorOptions ¶
type DescribeEffectivePatchesForPatchBaselinePaginatorOptions struct { // The maximum number of patches to return (per page). Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeEffectivePatchesForPatchBaselinePaginatorOptions is the paginator options for DescribeEffectivePatchesForPatchBaseline
type DescribeInstanceAssociationsStatusAPIClient ¶
type DescribeInstanceAssociationsStatusAPIClient interface {
DescribeInstanceAssociationsStatus(context.Context, *DescribeInstanceAssociationsStatusInput, ...func(*Options)) (*DescribeInstanceAssociationsStatusOutput, error)
}
DescribeInstanceAssociationsStatusAPIClient is a client that implements the DescribeInstanceAssociationsStatus operation.
type DescribeInstanceAssociationsStatusInput ¶
type DescribeInstanceAssociationsStatusInput struct { // The instance IDs for which you want association status information. // // This member is required. InstanceId *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 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 DescribeInstanceAssociationsStatusPaginator ¶
type DescribeInstanceAssociationsStatusPaginator struct {
// contains filtered or unexported fields
}
DescribeInstanceAssociationsStatusPaginator is a paginator for DescribeInstanceAssociationsStatus
func NewDescribeInstanceAssociationsStatusPaginator ¶
func NewDescribeInstanceAssociationsStatusPaginator(client DescribeInstanceAssociationsStatusAPIClient, params *DescribeInstanceAssociationsStatusInput, optFns ...func(*DescribeInstanceAssociationsStatusPaginatorOptions)) *DescribeInstanceAssociationsStatusPaginator
NewDescribeInstanceAssociationsStatusPaginator returns a new DescribeInstanceAssociationsStatusPaginator
func (*DescribeInstanceAssociationsStatusPaginator) HasMorePages ¶
func (p *DescribeInstanceAssociationsStatusPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstanceAssociationsStatusPaginator) NextPage ¶
func (p *DescribeInstanceAssociationsStatusPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstanceAssociationsStatusOutput, error)
NextPage retrieves the next DescribeInstanceAssociationsStatus page.
type DescribeInstanceAssociationsStatusPaginatorOptions ¶
type DescribeInstanceAssociationsStatusPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeInstanceAssociationsStatusPaginatorOptions is the paginator options for DescribeInstanceAssociationsStatus
type DescribeInstanceInformationAPIClient ¶
type DescribeInstanceInformationAPIClient interface {
DescribeInstanceInformation(context.Context, *DescribeInstanceInformationInput, ...func(*Options)) (*DescribeInstanceInformationOutput, error)
}
DescribeInstanceInformationAPIClient is a client that implements the DescribeInstanceInformation operation.
type DescribeInstanceInformationInput ¶
type DescribeInstanceInformationInput struct { // 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 // 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 // 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 DescribeInstanceInformationOutput ¶
type DescribeInstanceInformationOutput struct { // The instance information list. InstanceInformationList []types.InstanceInformation // 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 DescribeInstanceInformationPaginator ¶
type DescribeInstanceInformationPaginator struct {
// contains filtered or unexported fields
}
DescribeInstanceInformationPaginator is a paginator for DescribeInstanceInformation
func NewDescribeInstanceInformationPaginator ¶
func NewDescribeInstanceInformationPaginator(client DescribeInstanceInformationAPIClient, params *DescribeInstanceInformationInput, optFns ...func(*DescribeInstanceInformationPaginatorOptions)) *DescribeInstanceInformationPaginator
NewDescribeInstanceInformationPaginator returns a new DescribeInstanceInformationPaginator
func (*DescribeInstanceInformationPaginator) HasMorePages ¶
func (p *DescribeInstanceInformationPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstanceInformationPaginator) NextPage ¶
func (p *DescribeInstanceInformationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstanceInformationOutput, error)
NextPage retrieves the next DescribeInstanceInformation page.
type DescribeInstanceInformationPaginatorOptions ¶
type DescribeInstanceInformationPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeInstanceInformationPaginatorOptions is the paginator options for DescribeInstanceInformation
type DescribeInstancePatchStatesAPIClient ¶
type DescribeInstancePatchStatesAPIClient interface {
DescribeInstancePatchStates(context.Context, *DescribeInstancePatchStatesInput, ...func(*Options)) (*DescribeInstancePatchStatesOutput, error)
}
DescribeInstancePatchStatesAPIClient is a client that implements the DescribeInstancePatchStates operation.
type DescribeInstancePatchStatesForPatchGroupAPIClient ¶
type DescribeInstancePatchStatesForPatchGroupAPIClient interface {
DescribeInstancePatchStatesForPatchGroup(context.Context, *DescribeInstancePatchStatesForPatchGroupInput, ...func(*Options)) (*DescribeInstancePatchStatesForPatchGroupOutput, error)
}
DescribeInstancePatchStatesForPatchGroupAPIClient is a client that implements the DescribeInstancePatchStatesForPatchGroup operation.
type DescribeInstancePatchStatesForPatchGroupInput ¶
type DescribeInstancePatchStatesForPatchGroupInput struct { // The name of the patch group for which the patch state information should be // retrieved. // // This member is required. 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 high-level patch state for the requested instances. InstancePatchStates []types.InstancePatchState // 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 DescribeInstancePatchStatesForPatchGroupPaginator ¶
type DescribeInstancePatchStatesForPatchGroupPaginator struct {
// contains filtered or unexported fields
}
DescribeInstancePatchStatesForPatchGroupPaginator is a paginator for DescribeInstancePatchStatesForPatchGroup
func NewDescribeInstancePatchStatesForPatchGroupPaginator ¶
func NewDescribeInstancePatchStatesForPatchGroupPaginator(client DescribeInstancePatchStatesForPatchGroupAPIClient, params *DescribeInstancePatchStatesForPatchGroupInput, optFns ...func(*DescribeInstancePatchStatesForPatchGroupPaginatorOptions)) *DescribeInstancePatchStatesForPatchGroupPaginator
NewDescribeInstancePatchStatesForPatchGroupPaginator returns a new DescribeInstancePatchStatesForPatchGroupPaginator
func (*DescribeInstancePatchStatesForPatchGroupPaginator) HasMorePages ¶
func (p *DescribeInstancePatchStatesForPatchGroupPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstancePatchStatesForPatchGroupPaginator) NextPage ¶
func (p *DescribeInstancePatchStatesForPatchGroupPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstancePatchStatesForPatchGroupOutput, error)
NextPage retrieves the next DescribeInstancePatchStatesForPatchGroup page.
type DescribeInstancePatchStatesForPatchGroupPaginatorOptions ¶
type DescribeInstancePatchStatesForPatchGroupPaginatorOptions struct { // The maximum number of patches to return (per page). Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeInstancePatchStatesForPatchGroupPaginatorOptions is the paginator options for DescribeInstancePatchStatesForPatchGroup
type DescribeInstancePatchStatesInput ¶
type DescribeInstancePatchStatesInput struct { // The ID of the instance whose patch state information should be retrieved. // // This member is required. InstanceIds []string // The maximum number of instances 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 DescribeInstancePatchStatesOutput ¶
type DescribeInstancePatchStatesOutput struct { // The high-level patch state for the requested instances. InstancePatchStates []types.InstancePatchState // 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 DescribeInstancePatchStatesPaginator ¶
type DescribeInstancePatchStatesPaginator struct {
// contains filtered or unexported fields
}
DescribeInstancePatchStatesPaginator is a paginator for DescribeInstancePatchStates
func NewDescribeInstancePatchStatesPaginator ¶
func NewDescribeInstancePatchStatesPaginator(client DescribeInstancePatchStatesAPIClient, params *DescribeInstancePatchStatesInput, optFns ...func(*DescribeInstancePatchStatesPaginatorOptions)) *DescribeInstancePatchStatesPaginator
NewDescribeInstancePatchStatesPaginator returns a new DescribeInstancePatchStatesPaginator
func (*DescribeInstancePatchStatesPaginator) HasMorePages ¶
func (p *DescribeInstancePatchStatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstancePatchStatesPaginator) NextPage ¶
func (p *DescribeInstancePatchStatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstancePatchStatesOutput, error)
NextPage retrieves the next DescribeInstancePatchStates page.
type DescribeInstancePatchStatesPaginatorOptions ¶
type DescribeInstancePatchStatesPaginatorOptions struct { // The maximum number of instances to return (per page). Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeInstancePatchStatesPaginatorOptions is the paginator options for DescribeInstancePatchStates
type DescribeInstancePatchesAPIClient ¶
type DescribeInstancePatchesAPIClient interface {
DescribeInstancePatches(context.Context, *DescribeInstancePatchesInput, ...func(*Options)) (*DescribeInstancePatchesOutput, error)
}
DescribeInstancePatchesAPIClient is a client that implements the DescribeInstancePatches operation.
type DescribeInstancePatchesInput ¶
type DescribeInstancePatchesInput struct { // The ID of the instance whose patch state information should be retrieved. // // This member is required. InstanceId *string // 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 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 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 DescribeInstancePatchesPaginator ¶
type DescribeInstancePatchesPaginator struct {
// contains filtered or unexported fields
}
DescribeInstancePatchesPaginator is a paginator for DescribeInstancePatches
func NewDescribeInstancePatchesPaginator ¶
func NewDescribeInstancePatchesPaginator(client DescribeInstancePatchesAPIClient, params *DescribeInstancePatchesInput, optFns ...func(*DescribeInstancePatchesPaginatorOptions)) *DescribeInstancePatchesPaginator
NewDescribeInstancePatchesPaginator returns a new DescribeInstancePatchesPaginator
func (*DescribeInstancePatchesPaginator) HasMorePages ¶
func (p *DescribeInstancePatchesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstancePatchesPaginator) NextPage ¶
func (p *DescribeInstancePatchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstancePatchesOutput, error)
NextPage retrieves the next DescribeInstancePatches page.
type DescribeInstancePatchesPaginatorOptions ¶
type DescribeInstancePatchesPaginatorOptions struct { // The maximum number of patches to return (per page). Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeInstancePatchesPaginatorOptions is the paginator options for DescribeInstancePatches
type DescribeInventoryDeletionsAPIClient ¶
type DescribeInventoryDeletionsAPIClient interface {
DescribeInventoryDeletions(context.Context, *DescribeInventoryDeletionsInput, ...func(*Options)) (*DescribeInventoryDeletionsOutput, error)
}
DescribeInventoryDeletionsAPIClient is a client that implements the DescribeInventoryDeletions operation.
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 // 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 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 DescribeInventoryDeletionsPaginator ¶
type DescribeInventoryDeletionsPaginator struct {
// contains filtered or unexported fields
}
DescribeInventoryDeletionsPaginator is a paginator for DescribeInventoryDeletions
func NewDescribeInventoryDeletionsPaginator ¶
func NewDescribeInventoryDeletionsPaginator(client DescribeInventoryDeletionsAPIClient, params *DescribeInventoryDeletionsInput, optFns ...func(*DescribeInventoryDeletionsPaginatorOptions)) *DescribeInventoryDeletionsPaginator
NewDescribeInventoryDeletionsPaginator returns a new DescribeInventoryDeletionsPaginator
func (*DescribeInventoryDeletionsPaginator) HasMorePages ¶
func (p *DescribeInventoryDeletionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInventoryDeletionsPaginator) NextPage ¶
func (p *DescribeInventoryDeletionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInventoryDeletionsOutput, error)
NextPage retrieves the next DescribeInventoryDeletions page.
type DescribeInventoryDeletionsPaginatorOptions ¶
type DescribeInventoryDeletionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeInventoryDeletionsPaginatorOptions is the paginator options for DescribeInventoryDeletions
type DescribeMaintenanceWindowExecutionTaskInvocationsAPIClient ¶
type DescribeMaintenanceWindowExecutionTaskInvocationsAPIClient interface {
DescribeMaintenanceWindowExecutionTaskInvocations(context.Context, *DescribeMaintenanceWindowExecutionTaskInvocationsInput, ...func(*Options)) (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput, error)
}
DescribeMaintenanceWindowExecutionTaskInvocationsAPIClient is a client that implements the DescribeMaintenanceWindowExecutionTaskInvocations operation.
type DescribeMaintenanceWindowExecutionTaskInvocationsInput ¶
type DescribeMaintenanceWindowExecutionTaskInvocationsInput struct { // The ID of the specific task in the maintenance window task that should be // retrieved. // // This member is required. TaskId *string // The ID of the maintenance window execution the task is part of. // // This member is required. WindowExecutionId *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 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 DescribeMaintenanceWindowExecutionTaskInvocationsOutput ¶
type DescribeMaintenanceWindowExecutionTaskInvocationsOutput 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 invocation results per invocation. WindowExecutionTaskInvocationIdentities []types.MaintenanceWindowExecutionTaskInvocationIdentity // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeMaintenanceWindowExecutionTaskInvocationsPaginator ¶
type DescribeMaintenanceWindowExecutionTaskInvocationsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowExecutionTaskInvocationsPaginator is a paginator for DescribeMaintenanceWindowExecutionTaskInvocations
func NewDescribeMaintenanceWindowExecutionTaskInvocationsPaginator ¶
func NewDescribeMaintenanceWindowExecutionTaskInvocationsPaginator(client DescribeMaintenanceWindowExecutionTaskInvocationsAPIClient, params *DescribeMaintenanceWindowExecutionTaskInvocationsInput, optFns ...func(*DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorOptions)) *DescribeMaintenanceWindowExecutionTaskInvocationsPaginator
NewDescribeMaintenanceWindowExecutionTaskInvocationsPaginator returns a new DescribeMaintenanceWindowExecutionTaskInvocationsPaginator
func (*DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) NextPage ¶
func (p *DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowExecutionTaskInvocations page.
type DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorOptions ¶
type DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorOptions is the paginator options for DescribeMaintenanceWindowExecutionTaskInvocations
type DescribeMaintenanceWindowExecutionTasksAPIClient ¶
type DescribeMaintenanceWindowExecutionTasksAPIClient interface {
DescribeMaintenanceWindowExecutionTasks(context.Context, *DescribeMaintenanceWindowExecutionTasksInput, ...func(*Options)) (*DescribeMaintenanceWindowExecutionTasksOutput, error)
}
DescribeMaintenanceWindowExecutionTasksAPIClient is a client that implements the DescribeMaintenanceWindowExecutionTasks operation.
type DescribeMaintenanceWindowExecutionTasksInput ¶
type DescribeMaintenanceWindowExecutionTasksInput struct { // The ID of the maintenance window execution whose task executions should be // retrieved. // // This member is required. WindowExecutionId *string // 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 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 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 DescribeMaintenanceWindowExecutionTasksPaginator ¶
type DescribeMaintenanceWindowExecutionTasksPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowExecutionTasksPaginator is a paginator for DescribeMaintenanceWindowExecutionTasks
func NewDescribeMaintenanceWindowExecutionTasksPaginator ¶
func NewDescribeMaintenanceWindowExecutionTasksPaginator(client DescribeMaintenanceWindowExecutionTasksAPIClient, params *DescribeMaintenanceWindowExecutionTasksInput, optFns ...func(*DescribeMaintenanceWindowExecutionTasksPaginatorOptions)) *DescribeMaintenanceWindowExecutionTasksPaginator
NewDescribeMaintenanceWindowExecutionTasksPaginator returns a new DescribeMaintenanceWindowExecutionTasksPaginator
func (*DescribeMaintenanceWindowExecutionTasksPaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowExecutionTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowExecutionTasksPaginator) NextPage ¶
func (p *DescribeMaintenanceWindowExecutionTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionTasksOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowExecutionTasks page.
type DescribeMaintenanceWindowExecutionTasksPaginatorOptions ¶
type DescribeMaintenanceWindowExecutionTasksPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowExecutionTasksPaginatorOptions is the paginator options for DescribeMaintenanceWindowExecutionTasks
type DescribeMaintenanceWindowExecutionsAPIClient ¶
type DescribeMaintenanceWindowExecutionsAPIClient interface {
DescribeMaintenanceWindowExecutions(context.Context, *DescribeMaintenanceWindowExecutionsInput, ...func(*Options)) (*DescribeMaintenanceWindowExecutionsOutput, error)
}
DescribeMaintenanceWindowExecutionsAPIClient is a client that implements the DescribeMaintenanceWindowExecutions operation.
type DescribeMaintenanceWindowExecutionsInput ¶
type DescribeMaintenanceWindowExecutionsInput struct { // The ID of the maintenance window whose executions should be retrieved. // // This member is required. 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 DescribeMaintenanceWindowExecutionsPaginator ¶
type DescribeMaintenanceWindowExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowExecutionsPaginator is a paginator for DescribeMaintenanceWindowExecutions
func NewDescribeMaintenanceWindowExecutionsPaginator ¶
func NewDescribeMaintenanceWindowExecutionsPaginator(client DescribeMaintenanceWindowExecutionsAPIClient, params *DescribeMaintenanceWindowExecutionsInput, optFns ...func(*DescribeMaintenanceWindowExecutionsPaginatorOptions)) *DescribeMaintenanceWindowExecutionsPaginator
NewDescribeMaintenanceWindowExecutionsPaginator returns a new DescribeMaintenanceWindowExecutionsPaginator
func (*DescribeMaintenanceWindowExecutionsPaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowExecutionsPaginator) NextPage ¶
func (p *DescribeMaintenanceWindowExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowExecutions page.
type DescribeMaintenanceWindowExecutionsPaginatorOptions ¶
type DescribeMaintenanceWindowExecutionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowExecutionsPaginatorOptions is the paginator options for DescribeMaintenanceWindowExecutions
type DescribeMaintenanceWindowScheduleAPIClient ¶
type DescribeMaintenanceWindowScheduleAPIClient interface {
DescribeMaintenanceWindowSchedule(context.Context, *DescribeMaintenanceWindowScheduleInput, ...func(*Options)) (*DescribeMaintenanceWindowScheduleOutput, error)
}
DescribeMaintenanceWindowScheduleAPIClient is a client that implements the DescribeMaintenanceWindowSchedule operation.
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 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 // The instance ID or key/value pair to retrieve information about. Targets []types.Target // The ID of the maintenance window to retrieve information about. WindowId *string }
type DescribeMaintenanceWindowScheduleOutput ¶
type DescribeMaintenanceWindowScheduleOutput struct { // The token for the next set of items to return. (You use this token in the next // call.) NextToken *string // Information about maintenance window executions scheduled for the specified time // range. ScheduledWindowExecutions []types.ScheduledWindowExecution // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeMaintenanceWindowSchedulePaginator ¶
type DescribeMaintenanceWindowSchedulePaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowSchedulePaginator is a paginator for DescribeMaintenanceWindowSchedule
func NewDescribeMaintenanceWindowSchedulePaginator ¶
func NewDescribeMaintenanceWindowSchedulePaginator(client DescribeMaintenanceWindowScheduleAPIClient, params *DescribeMaintenanceWindowScheduleInput, optFns ...func(*DescribeMaintenanceWindowSchedulePaginatorOptions)) *DescribeMaintenanceWindowSchedulePaginator
NewDescribeMaintenanceWindowSchedulePaginator returns a new DescribeMaintenanceWindowSchedulePaginator
func (*DescribeMaintenanceWindowSchedulePaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowSchedulePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowSchedulePaginator) NextPage ¶
func (p *DescribeMaintenanceWindowSchedulePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowScheduleOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowSchedule page.
type DescribeMaintenanceWindowSchedulePaginatorOptions ¶
type DescribeMaintenanceWindowSchedulePaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowSchedulePaginatorOptions is the paginator options for DescribeMaintenanceWindowSchedule
type DescribeMaintenanceWindowTargetsAPIClient ¶
type DescribeMaintenanceWindowTargetsAPIClient interface {
DescribeMaintenanceWindowTargets(context.Context, *DescribeMaintenanceWindowTargetsInput, ...func(*Options)) (*DescribeMaintenanceWindowTargetsOutput, error)
}
DescribeMaintenanceWindowTargetsAPIClient is a client that implements the DescribeMaintenanceWindowTargets operation.
type DescribeMaintenanceWindowTargetsInput ¶
type DescribeMaintenanceWindowTargetsInput struct { // The ID of the maintenance window whose targets should be retrieved. // // This member is required. WindowId *string // 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 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 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 DescribeMaintenanceWindowTargetsPaginator ¶
type DescribeMaintenanceWindowTargetsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowTargetsPaginator is a paginator for DescribeMaintenanceWindowTargets
func NewDescribeMaintenanceWindowTargetsPaginator ¶
func NewDescribeMaintenanceWindowTargetsPaginator(client DescribeMaintenanceWindowTargetsAPIClient, params *DescribeMaintenanceWindowTargetsInput, optFns ...func(*DescribeMaintenanceWindowTargetsPaginatorOptions)) *DescribeMaintenanceWindowTargetsPaginator
NewDescribeMaintenanceWindowTargetsPaginator returns a new DescribeMaintenanceWindowTargetsPaginator
func (*DescribeMaintenanceWindowTargetsPaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowTargetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowTargetsPaginator) NextPage ¶
func (p *DescribeMaintenanceWindowTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowTargetsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowTargets page.
type DescribeMaintenanceWindowTargetsPaginatorOptions ¶
type DescribeMaintenanceWindowTargetsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowTargetsPaginatorOptions is the paginator options for DescribeMaintenanceWindowTargets
type DescribeMaintenanceWindowTasksAPIClient ¶
type DescribeMaintenanceWindowTasksAPIClient interface {
DescribeMaintenanceWindowTasks(context.Context, *DescribeMaintenanceWindowTasksInput, ...func(*Options)) (*DescribeMaintenanceWindowTasksOutput, error)
}
DescribeMaintenanceWindowTasksAPIClient is a client that implements the DescribeMaintenanceWindowTasks operation.
type DescribeMaintenanceWindowTasksInput ¶
type DescribeMaintenanceWindowTasksInput struct { // The ID of the maintenance window whose tasks should be retrieved. // // This member is required. WindowId *string // 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 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 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 DescribeMaintenanceWindowTasksPaginator ¶
type DescribeMaintenanceWindowTasksPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowTasksPaginator is a paginator for DescribeMaintenanceWindowTasks
func NewDescribeMaintenanceWindowTasksPaginator ¶
func NewDescribeMaintenanceWindowTasksPaginator(client DescribeMaintenanceWindowTasksAPIClient, params *DescribeMaintenanceWindowTasksInput, optFns ...func(*DescribeMaintenanceWindowTasksPaginatorOptions)) *DescribeMaintenanceWindowTasksPaginator
NewDescribeMaintenanceWindowTasksPaginator returns a new DescribeMaintenanceWindowTasksPaginator
func (*DescribeMaintenanceWindowTasksPaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowTasksPaginator) NextPage ¶
func (p *DescribeMaintenanceWindowTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowTasksOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowTasks page.
type DescribeMaintenanceWindowTasksPaginatorOptions ¶
type DescribeMaintenanceWindowTasksPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowTasksPaginatorOptions is the paginator options for DescribeMaintenanceWindowTasks
type DescribeMaintenanceWindowsAPIClient ¶
type DescribeMaintenanceWindowsAPIClient interface {
DescribeMaintenanceWindows(context.Context, *DescribeMaintenanceWindowsInput, ...func(*Options)) (*DescribeMaintenanceWindowsOutput, error)
}
DescribeMaintenanceWindowsAPIClient is a client that implements the DescribeMaintenanceWindows operation.
type DescribeMaintenanceWindowsForTargetAPIClient ¶
type DescribeMaintenanceWindowsForTargetAPIClient interface {
DescribeMaintenanceWindowsForTarget(context.Context, *DescribeMaintenanceWindowsForTargetInput, ...func(*Options)) (*DescribeMaintenanceWindowsForTargetOutput, error)
}
DescribeMaintenanceWindowsForTargetAPIClient is a client that implements the DescribeMaintenanceWindowsForTarget operation.
type DescribeMaintenanceWindowsForTargetInput ¶
type DescribeMaintenanceWindowsForTargetInput struct { // The type of resource you want to retrieve information about. For example, // "INSTANCE". // // This member is required. ResourceType types.MaintenanceWindowResourceType // The instance ID or key/value pair to retrieve information about. // // This member is required. 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 }
type DescribeMaintenanceWindowsForTargetOutput ¶
type DescribeMaintenanceWindowsForTargetOutput struct { // The token for the next set of items to return. (You use this token in the next // call.) NextToken *string // Information about the maintenance window targets and tasks an instance is // associated with. WindowIdentities []types.MaintenanceWindowIdentityForTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeMaintenanceWindowsForTargetPaginator ¶
type DescribeMaintenanceWindowsForTargetPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowsForTargetPaginator is a paginator for DescribeMaintenanceWindowsForTarget
func NewDescribeMaintenanceWindowsForTargetPaginator ¶
func NewDescribeMaintenanceWindowsForTargetPaginator(client DescribeMaintenanceWindowsForTargetAPIClient, params *DescribeMaintenanceWindowsForTargetInput, optFns ...func(*DescribeMaintenanceWindowsForTargetPaginatorOptions)) *DescribeMaintenanceWindowsForTargetPaginator
NewDescribeMaintenanceWindowsForTargetPaginator returns a new DescribeMaintenanceWindowsForTargetPaginator
func (*DescribeMaintenanceWindowsForTargetPaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowsForTargetPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowsForTargetPaginator) NextPage ¶
func (p *DescribeMaintenanceWindowsForTargetPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowsForTargetOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowsForTarget page.
type DescribeMaintenanceWindowsForTargetPaginatorOptions ¶
type DescribeMaintenanceWindowsForTargetPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowsForTargetPaginatorOptions is the paginator options for DescribeMaintenanceWindowsForTarget
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 DescribeMaintenanceWindowsPaginator ¶
type DescribeMaintenanceWindowsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowsPaginator is a paginator for DescribeMaintenanceWindows
func NewDescribeMaintenanceWindowsPaginator ¶
func NewDescribeMaintenanceWindowsPaginator(client DescribeMaintenanceWindowsAPIClient, params *DescribeMaintenanceWindowsInput, optFns ...func(*DescribeMaintenanceWindowsPaginatorOptions)) *DescribeMaintenanceWindowsPaginator
NewDescribeMaintenanceWindowsPaginator returns a new DescribeMaintenanceWindowsPaginator
func (*DescribeMaintenanceWindowsPaginator) HasMorePages ¶
func (p *DescribeMaintenanceWindowsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowsPaginator) NextPage ¶
func (p *DescribeMaintenanceWindowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindows page.
type DescribeMaintenanceWindowsPaginatorOptions ¶
type DescribeMaintenanceWindowsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeMaintenanceWindowsPaginatorOptions is the paginator options for DescribeMaintenanceWindows
type DescribeOpsItemsAPIClient ¶
type DescribeOpsItemsAPIClient interface {
DescribeOpsItems(context.Context, *DescribeOpsItemsInput, ...func(*Options)) (*DescribeOpsItemsOutput, error)
}
DescribeOpsItemsAPIClient is a client that implements the DescribeOpsItems operation.
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 { // 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 OpsItems. OpsItemSummaries []types.OpsItemSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeOpsItemsPaginator ¶
type DescribeOpsItemsPaginator struct {
// contains filtered or unexported fields
}
DescribeOpsItemsPaginator is a paginator for DescribeOpsItems
func NewDescribeOpsItemsPaginator ¶
func NewDescribeOpsItemsPaginator(client DescribeOpsItemsAPIClient, params *DescribeOpsItemsInput, optFns ...func(*DescribeOpsItemsPaginatorOptions)) *DescribeOpsItemsPaginator
NewDescribeOpsItemsPaginator returns a new DescribeOpsItemsPaginator
func (*DescribeOpsItemsPaginator) HasMorePages ¶
func (p *DescribeOpsItemsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeOpsItemsPaginator) NextPage ¶
func (p *DescribeOpsItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOpsItemsOutput, error)
NextPage retrieves the next DescribeOpsItems page.
type DescribeOpsItemsPaginatorOptions ¶
type DescribeOpsItemsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeOpsItemsPaginatorOptions is the paginator options for DescribeOpsItems
type DescribeParametersAPIClient ¶
type DescribeParametersAPIClient interface {
DescribeParameters(context.Context, *DescribeParametersInput, ...func(*Options)) (*DescribeParametersOutput, error)
}
DescribeParametersAPIClient is a client that implements the DescribeParameters operation.
type DescribeParametersInput ¶
type DescribeParametersInput struct { // This data type is deprecated. Instead, use ParameterFilters. Filters []types.ParametersFilter // 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 // Filters to limit the request results. ParameterFilters []types.ParameterStringFilter }
type DescribeParametersOutput ¶
type DescribeParametersOutput struct { // The token to use when requesting the next set of items. NextToken *string // Parameters returned by the request. Parameters []types.ParameterMetadata // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeParametersPaginator ¶
type DescribeParametersPaginator struct {
// contains filtered or unexported fields
}
DescribeParametersPaginator is a paginator for DescribeParameters
func NewDescribeParametersPaginator ¶
func NewDescribeParametersPaginator(client DescribeParametersAPIClient, params *DescribeParametersInput, optFns ...func(*DescribeParametersPaginatorOptions)) *DescribeParametersPaginator
NewDescribeParametersPaginator returns a new DescribeParametersPaginator
func (*DescribeParametersPaginator) HasMorePages ¶
func (p *DescribeParametersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeParametersPaginator) NextPage ¶
func (p *DescribeParametersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeParametersOutput, error)
NextPage retrieves the next DescribeParameters page.
type DescribeParametersPaginatorOptions ¶
type DescribeParametersPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeParametersPaginatorOptions is the paginator options for DescribeParameters
type DescribePatchBaselinesAPIClient ¶
type DescribePatchBaselinesAPIClient interface {
DescribePatchBaselines(context.Context, *DescribePatchBaselinesInput, ...func(*Options)) (*DescribePatchBaselinesOutput, error)
}
DescribePatchBaselinesAPIClient is a client that implements the DescribePatchBaselines operation.
type DescribePatchBaselinesInput ¶
type DescribePatchBaselinesInput struct { // 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 maximum number of patch baselines 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 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 DescribePatchBaselinesPaginator ¶
type DescribePatchBaselinesPaginator struct {
// contains filtered or unexported fields
}
DescribePatchBaselinesPaginator is a paginator for DescribePatchBaselines
func NewDescribePatchBaselinesPaginator ¶
func NewDescribePatchBaselinesPaginator(client DescribePatchBaselinesAPIClient, params *DescribePatchBaselinesInput, optFns ...func(*DescribePatchBaselinesPaginatorOptions)) *DescribePatchBaselinesPaginator
NewDescribePatchBaselinesPaginator returns a new DescribePatchBaselinesPaginator
func (*DescribePatchBaselinesPaginator) HasMorePages ¶
func (p *DescribePatchBaselinesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePatchBaselinesPaginator) NextPage ¶
func (p *DescribePatchBaselinesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePatchBaselinesOutput, error)
NextPage retrieves the next DescribePatchBaselines page.
type DescribePatchBaselinesPaginatorOptions ¶
type DescribePatchBaselinesPaginatorOptions struct { // The maximum number of patch baselines to return (per page). Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribePatchBaselinesPaginatorOptions is the paginator options for DescribePatchBaselines
type DescribePatchGroupStateInput ¶
type DescribePatchGroupStateInput struct { // The name of the patch group whose patch snapshot should be retrieved. // // This member is required. PatchGroup *string }
type DescribePatchGroupStateOutput ¶
type DescribePatchGroupStateOutput struct { // The number of instances in the patch group. Instances int32 // The number of instances with patches from the patch baseline that failed to // install. InstancesWithFailedPatches int32 // The number of instances with patches installed that aren't defined in the patch // baseline. InstancesWithInstalledOtherPatches 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 missing patches from the patch baseline. InstancesWithMissingPatches int32 // The number of instances with patches that aren't applicable. InstancesWithNotApplicablePatches int32 // The number of instances with NotApplicable patches beyond the supported limit, // which are not reported by name to Systems Manager Inventory. InstancesWithUnreportedNotApplicablePatches int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribePatchGroupsAPIClient ¶
type DescribePatchGroupsAPIClient interface {
DescribePatchGroups(context.Context, *DescribePatchGroupsInput, ...func(*Options)) (*DescribePatchGroupsOutput, error)
}
DescribePatchGroupsAPIClient is a client that implements the DescribePatchGroups operation.
type DescribePatchGroupsInput ¶
type DescribePatchGroupsInput struct { // 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 // The maximum number of patch groups 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 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 DescribePatchGroupsPaginator ¶
type DescribePatchGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribePatchGroupsPaginator is a paginator for DescribePatchGroups
func NewDescribePatchGroupsPaginator ¶
func NewDescribePatchGroupsPaginator(client DescribePatchGroupsAPIClient, params *DescribePatchGroupsInput, optFns ...func(*DescribePatchGroupsPaginatorOptions)) *DescribePatchGroupsPaginator
NewDescribePatchGroupsPaginator returns a new DescribePatchGroupsPaginator
func (*DescribePatchGroupsPaginator) HasMorePages ¶
func (p *DescribePatchGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePatchGroupsPaginator) NextPage ¶
func (p *DescribePatchGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePatchGroupsOutput, error)
NextPage retrieves the next DescribePatchGroups page.
type DescribePatchGroupsPaginatorOptions ¶
type DescribePatchGroupsPaginatorOptions struct { // The maximum number of patch groups to return (per page). Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribePatchGroupsPaginatorOptions is the paginator options for DescribePatchGroups
type DescribePatchPropertiesAPIClient ¶
type DescribePatchPropertiesAPIClient interface {
DescribePatchProperties(context.Context, *DescribePatchPropertiesInput, ...func(*Options)) (*DescribePatchPropertiesOutput, error)
}
DescribePatchPropertiesAPIClient is a client that implements the DescribePatchProperties operation.
type DescribePatchPropertiesInput ¶
type DescribePatchPropertiesInput struct { // The operating system type for which to list patches. // // This member is required. OperatingSystem types.OperatingSystem // The patch property for which you want to view patch details. // // This member is required. Property types.PatchProperty // 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 // Indicates whether to list patches for the Windows operating system or for // Microsoft applications. Not applicable for the Linux or macOS operating systems. PatchSet types.PatchSet }
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 DescribePatchPropertiesPaginator ¶
type DescribePatchPropertiesPaginator struct {
// contains filtered or unexported fields
}
DescribePatchPropertiesPaginator is a paginator for DescribePatchProperties
func NewDescribePatchPropertiesPaginator ¶
func NewDescribePatchPropertiesPaginator(client DescribePatchPropertiesAPIClient, params *DescribePatchPropertiesInput, optFns ...func(*DescribePatchPropertiesPaginatorOptions)) *DescribePatchPropertiesPaginator
NewDescribePatchPropertiesPaginator returns a new DescribePatchPropertiesPaginator
func (*DescribePatchPropertiesPaginator) HasMorePages ¶
func (p *DescribePatchPropertiesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePatchPropertiesPaginator) NextPage ¶
func (p *DescribePatchPropertiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePatchPropertiesOutput, error)
NextPage retrieves the next DescribePatchProperties page.
type DescribePatchPropertiesPaginatorOptions ¶
type DescribePatchPropertiesPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribePatchPropertiesPaginatorOptions is the paginator options for DescribePatchProperties
type DescribeSessionsAPIClient ¶
type DescribeSessionsAPIClient interface {
DescribeSessions(context.Context, *DescribeSessionsInput, ...func(*Options)) (*DescribeSessionsOutput, error)
}
DescribeSessionsAPIClient is a client that implements the DescribeSessions operation.
type DescribeSessionsInput ¶
type DescribeSessionsInput struct { // The session status to retrieve a list of sessions for. For example, "Active". // // This member is required. State types.SessionState // One or more filters to limit the type of sessions returned by the request. Filters []types.SessionFilter // 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 DescribeSessionsOutput ¶
type DescribeSessionsOutput struct { // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string // A list of sessions meeting the request parameters. Sessions []types.Session // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeSessionsPaginator ¶
type DescribeSessionsPaginator struct {
// contains filtered or unexported fields
}
DescribeSessionsPaginator is a paginator for DescribeSessions
func NewDescribeSessionsPaginator ¶
func NewDescribeSessionsPaginator(client DescribeSessionsAPIClient, params *DescribeSessionsInput, optFns ...func(*DescribeSessionsPaginatorOptions)) *DescribeSessionsPaginator
NewDescribeSessionsPaginator returns a new DescribeSessionsPaginator
func (*DescribeSessionsPaginator) HasMorePages ¶
func (p *DescribeSessionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeSessionsPaginator) NextPage ¶
func (p *DescribeSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSessionsOutput, error)
NextPage retrieves the next DescribeSessions page.
type DescribeSessionsPaginatorOptions ¶
type DescribeSessionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeSessionsPaginatorOptions is the paginator options for DescribeSessions
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type 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. // // This member is required. 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 { // 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. // // This member is required. CalendarNames []string // (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 }
type GetCalendarStateOutput ¶
type GetCalendarStateOutput struct { // 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 // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetCommandInvocationAPIClient ¶
type GetCommandInvocationAPIClient interface {
GetCommandInvocation(context.Context, *GetCommandInvocationInput, ...func(*Options)) (*GetCommandInvocationOutput, error)
}
GetCommandInvocationAPIClient is a client that implements the GetCommandInvocation operation.
type GetCommandInvocationInput ¶
type GetCommandInvocationInput struct { // (Required) The parent command ID of the invocation plugin. // // This member is required. 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. // // This member is required. InstanceId *string // (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 }
type GetCommandInvocationOutput ¶
type GetCommandInvocationOutput struct { // CloudWatch Logs information where Systems Manager sent the command output. CloudWatchOutputConfig *types.CloudWatchOutputConfig // The parent command ID of the invocation plugin. CommandId *string // The comment text for the command. Comment *string // The name of the document that was run. For example, AWS-RunShellScript. DocumentName *string // The SSM document version used in the request. DocumentVersion *string // Duration since ExecutionStartDateTime. ExecutionElapsedTime *string // 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 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