Documentation ¶
Overview ¶
Package ssm provides the API client, operations, and parameter types for Amazon Simple Systems Manager (SSM).
Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale. This reference is intended to be used with the Amazon Web Services Systems Manager User Guide (https://docs.aws.amazon.com/systems-manager/latest/userguide/) . To get started, see Setting up Amazon Web Services Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html) . Related resources
- For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities (https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html) in the Amazon Web Services Systems Manager User Guide.
- For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference (https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html) .
- For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide (https://docs.aws.amazon.com/appconfig/latest/userguide/) and the AppConfig API Reference (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/) .
- For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide (https://docs.aws.amazon.com/incident-manager/latest/userguide/) and the Systems Manager Incident Manager API Reference (https://docs.aws.amazon.com/incident-manager/latest/APIReference/) .
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- type AddTagsToResourceInput
- type AddTagsToResourceOutput
- type AssociateOpsItemRelatedItemInput
- type AssociateOpsItemRelatedItemOutput
- 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) AssociateOpsItemRelatedItem(ctx context.Context, params *AssociateOpsItemRelatedItemInput, ...) (*AssociateOpsItemRelatedItemOutput, 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) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, ...) (*DeleteResourcePolicyOutput, 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) DisassociateOpsItemRelatedItem(ctx context.Context, params *DisassociateOpsItemRelatedItemInput, ...) (*DisassociateOpsItemRelatedItemOutput, 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) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, ...) (*GetResourcePoliciesOutput, 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) ListOpsItemRelatedItems(ctx context.Context, params *ListOpsItemRelatedItemsInput, ...) (*ListOpsItemRelatedItemsOutput, 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) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, 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) UnlabelParameterVersion(ctx context.Context, params *UnlabelParameterVersionInput, ...) (*UnlabelParameterVersionOutput, 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 DeleteResourcePolicyInput
- type DeleteResourcePolicyOutput
- 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 DisassociateOpsItemRelatedItemInput
- type DisassociateOpsItemRelatedItemOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- 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 GetResourcePoliciesAPIClient
- type GetResourcePoliciesInput
- type GetResourcePoliciesOutput
- type GetResourcePoliciesPaginator
- type GetResourcePoliciesPaginatorOptions
- 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 ListOpsItemRelatedItemsAPIClient
- type ListOpsItemRelatedItemsInput
- type ListOpsItemRelatedItemsOutput
- type ListOpsItemRelatedItemsPaginator
- type ListOpsItemRelatedItemsPaginatorOptions
- 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 PutResourcePolicyInput
- type PutResourcePolicyOutput
- 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 UnlabelParameterVersionInput
- type UnlabelParameterVersionOutput
- 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 ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.37.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
Types ¶
type AddTagsToResourceInput ¶
type AddTagsToResourceInput struct { // The resource ID you want to tag. Use the ID of the resource. Here are some // examples: MaintenanceWindow : mw-012345abcde PatchBaseline : pb-012345abcde // Automation : example-c160-4567-8519-012345abcde OpsMetadata object: ResourceID // for tagging is created from the Amazon Resource Name (ARN) for the object. // Specifically, ResourceID is created from the strings that come after the word // opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of // arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a // ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager . // For the Document and Parameter values, use the name of the resource. If you're // tagging a shared document, you must use the full ARN of the document. // ManagedInstance : mi-012345abcde The ManagedInstance type for this API // operation is only for on-premises managed nodes. You must specify the name of // the managed node 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 operation is for on-premises managed nodes. You must specify the name // of the managed node 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. Don't enter personally // identifiable information in this field. // // This member is required. Tags []types.Tag // contains filtered or unexported fields }
type AddTagsToResourceOutput ¶
type AddTagsToResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateOpsItemRelatedItemInput ¶ added in v1.6.0
type AssociateOpsItemRelatedItemInput struct { // The type of association that you want to create between an OpsItem and a // resource. OpsCenter supports IsParentOf and RelatesTo association types. // // This member is required. AssociationType *string // The ID of the OpsItem to which you want to associate a resource as a related // item. // // This member is required. OpsItemId *string // The type of resource that you want to associate with an OpsItem. OpsCenter // supports the following types: AWS::SSMIncidents::IncidentRecord : an Incident // Manager incident. AWS::SSM::Document : a Systems Manager (SSM) document. // // This member is required. ResourceType *string // The Amazon Resource Name (ARN) of the Amazon Web Services resource that you // want to associate with the OpsItem. // // This member is required. ResourceUri *string // contains filtered or unexported fields }
type AssociateOpsItemRelatedItemOutput ¶ added in v1.6.0
type AssociateOpsItemRelatedItemOutput struct { // The association ID. AssociationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CancelCommandInput ¶
type CancelCommandInput struct { // The ID of the command you want to cancel. // // This member is required. CommandId *string // (Optional) A list of managed node IDs on which you want to cancel the command. // If not provided, the command is canceled on every node on which it was // requested. InstanceIds []string // contains filtered or unexported fields }
type CancelCommandOutput ¶
type CancelCommandOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for 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 automations, documents, managed nodes, 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 nodes that helps you track each node's owner and stack level. For example:
- Key=Owner,Value=DbAdmin
- Key=Owner,Value=SysAdmin
- Key=Owner,Value=Dev
- Key=Stack,Value=Production
- Key=Stack,Value=Pre-Production
- Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 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 Amazon Elastic Compute Cloud (Amazon 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) AssociateOpsItemRelatedItem ¶ added in v1.6.0
func (c *Client) AssociateOpsItemRelatedItem(ctx context.Context, params *AssociateOpsItemRelatedItemInput, optFns ...func(*Options)) (*AssociateOpsItemRelatedItemOutput, error)
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
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 haven't 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 servers, edge devices, or virtual machine (VM) with Amazon Web Services 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 machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html) in the Amazon Web Services Systems Manager User Guide. Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
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 managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, 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 Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes 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 isn't installed, then State Manager installs it. If the software is installed, but the service isn't 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 Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets. When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified. If you associate a document with a managed node 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 Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html) in the Amazon Web Services 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 Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the Amazon Web Services Systems Manager User Guide.
func (*Client) CreateOpsMetadata ¶ added in v0.31.0
func (c *Client) CreateOpsMetadata(ctx context.Context, params *CreateOpsMetadataInput, optFns ...func(*Options)) (*CreateOpsMetadataOutput, error)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation 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-value pairs in PatchFilters for each supported operating system type, see PatchFilter .
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. Amazon Web Services 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 Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon 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 Amazon Web Services 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 Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using 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 Amazon Web Services 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 isn't 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 aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
func (*Client) DeleteAssociation ¶
func (c *Client) DeleteAssociation(ctx context.Context, params *DeleteAssociationInput, optFns ...func(*Options)) (*DeleteAssociationOutput, error)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID. When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
func (*Client) DeleteDocument ¶
func (c *Client) DeleteDocument(ctx context.Context, params *DeleteDocumentInput, optFns ...func(*Options)) (*DeleteDocumentOutput, error)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document. Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes 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 ¶ added in v0.31.0
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. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
func (*Client) DeleteParameters ¶
func (c *Client) DeleteParameters(ctx context.Context, params *DeleteParametersInput, optFns ...func(*Options)) (*DeleteParametersOutput, error)
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
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 nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
func (*Client) DeleteResourcePolicy ¶ added in v1.33.0
func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
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 node 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.
func (*Client) DescribeAssociationExecutionTargets ¶
func (c *Client) DescribeAssociationExecutionTargets(ctx context.Context, params *DescribeAssociationExecutionTargetsInput, optFns ...func(*Options)) (*DescribeAssociationExecutionTargetsOutput, error)
Views 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)
Views 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 Amazon Web Services Systems Manager document (SSM document).
func (*Client) DescribeDocumentPermission ¶
func (c *Client) DescribeDocumentPermission(ctx context.Context, params *DescribeDocumentPermissionInput, optFns ...func(*Options)) (*DescribeDocumentPermissionOutput, error)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM 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 Amazon Web Services 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 managed node(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. Applies to patch baselines for Windows only.
func (*Client) DescribeInstanceAssociationsStatus ¶
func (c *Client) DescribeInstanceAssociationsStatus(ctx context.Context, params *DescribeInstanceAssociationsStatusInput, optFns ...func(*Options)) (*DescribeInstanceAssociationsStatusOutput, error)
The status of the associations for the managed node(s).
func (*Client) DescribeInstanceInformation ¶
func (c *Client) DescribeInstanceInformation(ctx context.Context, params *DescribeInstanceInformationInput, optFns ...func(*Options)) (*DescribeInstanceInformationOutput, error)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated. If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error. The IamRole field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation 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 managed nodes.
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 managed nodes 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 managed node and their state relative to the patch baseline being used for the node.
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 can't 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 don't 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 Amazon Web Services 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 a managed node 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 Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the Amazon Web Services 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. If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.
func (*Client) DescribePatchBaselines ¶
func (c *Client) DescribePatchBaselines(ctx context.Context, params *DescribePatchBaselinesInput, optFns ...func(*Options)) (*DescribePatchBaselinesOutput, error)
Lists the patch baselines in your Amazon Web Services 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 information 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 operations 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) DisassociateOpsItemRelatedItem ¶ added in v1.6.0
func (c *Client) DisassociateOpsItemRelatedItem(ctx context.Context, params *DisassociateOpsItemRelatedItemInput, optFns ...func(*Options)) (*DisassociateOpsItemRelatedItemOutput, error)
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
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 a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses 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 Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html) in the Amazon Web Services 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. GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations . To get the command execution status across managed nodes, use ListCommands .
func (*Client) GetConnectionStatus ¶
func (c *Client) GetConnectionStatus(ctx context.Context, params *GetConnectionStatusInput, optFns ...func(*Options)) (*GetConnectionStatusOutput, error)
Retrieves the Session Manager connection status for a managed node 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. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. If you don't 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 managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document). If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.
func (*Client) GetDocument ¶
func (c *Client) GetDocument(ctx context.Context, params *GetDocumentInput, optFns ...func(*Options)) (*GetDocumentOutput, error)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
func (*Client) GetInventory ¶
func (c *Client) GetInventory(ctx context.Context, params *GetInventoryInput, optFns ...func(*Options)) (*GetInventoryOutput, error)
Query inventory information. This includes managed node status, such as Stopped or Terminated .
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)
Retrieves the details of a maintenance window task. For maintenance window tasks without a specified target, you can't 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 don't affect the running of your task and can be ignored. To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
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 Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the Amazon Web Services Systems Manager User Guide.
func (*Client) GetOpsMetadata ¶ added in v0.31.0
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 operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
func (*Client) GetParameter ¶
func (c *Client) GetParameter(ctx context.Context, params *GetParameterInput, optFns ...func(*Options)) (*GetParameterOutput, error)
Get information about a single parameter by specifying the parameter name. To get information about more than one parameter at a time, use the GetParameters operation.
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. If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing.
func (*Client) GetParameters ¶
func (c *Client) GetParameters(ctx context.Context, params *GetParametersInput, optFns ...func(*Options)) (*GetParametersOutput, error)
Get information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter operation instead.
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) GetResourcePolicies ¶ added in v1.33.0
func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
Returns an array of the Policy object.
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 Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team. Query the current service setting for the Amazon Web Services 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, Amazon Web Services 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.
- If you no longer want to use a parameter label, then you can either delete it or 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 isn't 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 Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
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 managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node 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 Amazon Web Services 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 operation 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 ¶ added in v0.31.0
func (c *Client) ListDocumentMetadataHistory(ctx context.Context, params *ListDocumentMetadataHistoryInput, optFns ...func(*Options)) (*ListDocumentMetadataHistoryOutput, error)
Information about approval reviews for a version of a change template in Change Manager.
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 Amazon Web Services account and Amazon Web Services 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 ¶ added in v0.31.0
func (c *Client) ListOpsItemEvents(ctx context.Context, params *ListOpsItemEventsInput, optFns ...func(*Options)) (*ListOpsItemEventsOutput, error)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
func (*Client) ListOpsItemRelatedItems ¶ added in v1.6.0
func (c *Client) ListOpsItemRelatedItems(ctx context.Context, params *ListOpsItemRelatedItemsInput, optFns ...func(*Options)) (*ListOpsItemRelatedItemsOutput, error)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
func (*Client) ListOpsMetadata ¶ added in v0.31.0
func (c *Client) ListOpsMetadata(ctx context.Context, params *ListOpsMetadataInput, optFns ...func(*Options)) (*ListOpsMetadataOutput, error)
Amazon Web Services Systems Manager calls this API operation 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. For information about the ID format for each supported resource type, see AddTagsToResource .
func (*Client) ModifyDocumentPermission ¶
func (c *Client) ModifyDocumentPermission(ctx context.Context, params *ModifyDocumentPermissionInput, optFns ...func(*Options)) (*ModifyDocumentPermissionOutput, error)
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user 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 operation 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 managed node.
- 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: An 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 or more managed nodes. 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) PutResourcePolicy ¶ added in v1.33.0
func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
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 Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (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 Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting. Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
func (*Client) ResumeSession ¶
func (c *Client) ResumeSession(ctx context.Context, params *ResumeSessionInput, optFns ...func(*Options)) (*ResumeSessionOutput, error)
Reconnects a session to a managed node 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 isn't 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 nodes.
func (*Client) StartAssociationsOnce ¶
func (c *Client) StartAssociationsOnce(ctx context.Context, params *StartAssociationsOnceInput, optFns ...func(*Options)) (*StartAssociationsOnceOutput, error)
Runs an association immediately and only one time. This operation 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 runbook.
func (*Client) StartChangeRequestExecution ¶ added in v0.31.0
func (c *Client) StartChangeRequestExecution(ctx context.Context, params *StartChangeRequestExecutionInput, optFns ...func(*Options)) (*StartChangeRequestExecutionOutput, error)
Creates a change request for Change Manager. The Automation runbooks 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, a managed node) 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. Amazon Web Services 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 Amazon Web Services CLI (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) in the Amazon Web Services Systems Manager User Guide. Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services 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 managed node. A terminated session can't be resumed.
func (*Client) UnlabelParameterVersion ¶ added in v1.4.0
func (c *Client) UnlabelParameterVersion(ctx context.Context, params *UnlabelParameterVersionInput, optFns ...func(*Options)) (*UnlabelParameterVersionOutput, error)
Remove a label or labels from a parameter.
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 Simple Storage Service (Amazon S3) output. When you call UpdateAssociation , the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call. In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. 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: isn't authorized to perform: ssm:DescribeAssociation on resource: When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.
func (*Client) UpdateAssociationStatus ¶
func (c *Client) UpdateAssociationStatus(ctx context.Context, params *UpdateAssociationStatusInput, optFns ...func(*Options)) (*UpdateAssociationStatusOutput, error)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node. UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.
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. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.
func (*Client) UpdateDocumentMetadata ¶ added in v0.31.0
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 change template in Change Manager.
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 isn't 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, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) in the Amazon Web Services Systems Manager User Guide. If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation 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 don't 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 Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes 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 Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) in the Amazon Web Services Systems Manager User Guide. Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the Amazon Web Services Systems Manager User Guide.
func (*Client) UpdateOpsMetadata ¶ added in v0.31.0
func (c *Client) UpdateOpsMetadata(ctx context.Context, params *UpdateOpsMetadataInput, optFns ...func(*Options)) (*UpdateOpsMetadataOutput, error)
Amazon Web Services Systems Manager calls this API operation 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-value pairs in PatchFilters for each supported operating system type, see PatchFilter .
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 Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one. This API operation 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 Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team. Update the service setting for the account.
type CommandExecutedWaiter ¶ added in v0.31.0
type CommandExecutedWaiter struct {
// contains filtered or unexported fields
}
CommandExecutedWaiter defines the waiters for CommandExecuted
func NewCommandExecutedWaiter ¶ added in v0.31.0
func NewCommandExecutedWaiter(client GetCommandInvocationAPIClient, optFns ...func(*CommandExecutedWaiterOptions)) *CommandExecutedWaiter
NewCommandExecutedWaiter constructs a CommandExecutedWaiter.
func (*CommandExecutedWaiter) Wait ¶ added in v0.31.0
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.
func (*CommandExecutedWaiter) WaitForOutput ¶ added in v1.15.0
func (w *CommandExecutedWaiter) WaitForOutput(ctx context.Context, params *GetCommandInvocationInput, maxWaitDur time.Duration, optFns ...func(*CommandExecutedWaiterOptions)) (*GetCommandInvocationOutput, error)
WaitForOutput calls the waiter function for CommandExecuted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type CommandExecutedWaiterOptions ¶ added in v0.31.0
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 name of the Identity and Access Management (IAM) role that you want to // assign to the managed node. This IAM role must provide AssumeRole permissions // for the Amazon Web Services 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 Amazon Web Services Systems Manager User Guide. You can't specify an IAM // service-linked role for this parameter. You must create a unique role. // // This member is required. IamRole *string // The name of the registered, managed node as it will appear in the Amazon Web // Services Systems Manager console or when you use the Amazon Web Services command // line tools to list Systems Manager resources. Don't enter personally // identifiable information in this field. DefaultInstanceName *string // A user-defined description of the resource that you want to register with // Systems Manager. Don't enter personally identifiable information in this field. Description *string // The date by which this activation request should expire, in timestamp format, // such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. // If you don't provide an expiration date, the activation code expires in 24 // hours. ExpirationDate *time.Time // Specify the maximum number of managed nodes you want to register. The default // value is 1 . RegistrationLimit *int32 // Reserved for internal use. RegistrationMetadata []types.RegistrationMetadataItem // 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-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, edge devices, and VMs after they connect to // Systems Manager for the first time and are assigned a managed node ID. This // means they are listed in the Amazon Web Services Systems Manager console with an // ID that is prefixed with "mi-". For information about how to add tags to your // managed nodes, see AddTagsToResource . For information about how to remove tags // from your managed nodes, see RemoveTagsFromResource . Tags []types.Tag // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type CreateAssociationBatchInput ¶
type CreateAssociationBatchInput struct { // One or more associations. // // This member is required. Entries []types.CreateAssociationBatchRequestEntry // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type CreateAssociationInput ¶
type CreateAssociationInput struct { // The name of the SSM Command document or Automation runbook that contains the // configuration information for the managed node. You can specify Amazon Web // Services-predefined documents, documents you created, or a document that is // shared with you from another Amazon Web Services account. For Systems Manager // documents (SSM documents) that are shared with you from other Amazon Web // Services 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 // Amazon Web Services-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 // The details for the CloudWatch alarm you want to apply to an automation or // command. AlarmConfiguration *types.AlarmConfiguration // By default, when you create a new association, 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 isn't supported for rate expressions. ApplyOnlyAtCronInterval bool // Specify a descriptive name for the association. AssociationName *string // Choose the parameter that will define how your automation will branch out. This // target is required for associations that use an Automation runbook and target // resources by using rate controls. Automation is a capability of Amazon Web // Services Systems Manager. AutomationTargetParameterName *string // The names or Amazon Resource Names (ARNs) of the Change Calendar type documents // you want to gate your associations under. The associations only run when that // change calendar is open. For more information, see Amazon Web Services Systems // Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) // . CalendarNames []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. State Manager doesn't support running // associations that use a new version of a document if that document is shared // from another account. State Manager always runs the default version of a // document if shared from another account, even though the Systems Manager console // shows that a new version was processed. If you want to run an association using // a new version of a document shared form another account, you must set the // document version to default . DocumentVersion *string // The managed node ID. InstanceId has been deprecated. To specify a managed node // ID for an association, use the Targets parameter. Requests that include the // parameter InstanceID with Systems Manager documents (SSM documents) that use // schema version 2.0 or later will fail. In addition, if you use the parameter // InstanceId , you can't 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 managed node 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 // managed node 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 // managed nodes 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 Amazon Simple Storage Service (Amazon 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 // Number of days to wait after the scheduled day to run an association. For // example, if you specified a cron schedule of cron(0 0 ? * THU#2 *) , you could // specify an offset of 3 to run the association each Sunday after the second // Thursday of the month. For more information about cron schedules for // associations, see Reference: Cron and rate expressions for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) // in the Amazon Web Services Systems Manager User Guide. To use offsets, you must // specify the ApplyOnlyAtCronInterval parameter. This option tells the system not // to run an association immediately after you create it. ScheduleOffset *int32 // 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 // operation. In this case, compliance data isn't managed by State Manager. It is // managed by your direct call to the PutComplianceItems API operation. By // default, all associations use AUTO mode. SyncCompliance types.AssociationSyncCompliance // Adds or overwrites one or more tags for a State Manager association. Tags are // metadata that you can assign to your Amazon Web Services resources. 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. Tags []types.Tag // A location is a combination of Amazon Web Services Regions and Amazon Web // Services accounts where you want to run the association. Use this action to // create an association in multiple Regions and multiple accounts. TargetLocations []types.TargetLocation // A key-value mapping of document parameters to target resources. Both Targets // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The targets for the association. You can target managed nodes by using tags, // Amazon Web Services resource groups, all managed nodes in an Amazon Web Services // account, or individual managed node IDs. You can target all managed nodes in an // Amazon Web Services account by specifying the InstanceIds key with a value of * // . 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 Amazon Web Services Systems Manager User Guide. Targets []types.Target // contains filtered or unexported fields }
type CreateAssociationOutput ¶
type CreateAssociationOutput struct { // Information about the association. AssociationDescription *types.AssociationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateDocumentInput ¶
type CreateDocumentInput struct { // The content for the new SSM document in JSON or YAML format. The content of the // document must not exceed 64KB. This quota also includes the content specified // for input parameters at runtime. 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 Amazon Web Services Systems // Manager User Guide. // - Create an SSM document (Amazon Web Services API) (https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html) // - Create an SSM document (Amazon Web Services 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 SSM document. You can't use the following strings as document // name prefixes. These are reserved by Amazon Web Services for use as document // name prefixes: // - aws // - amazon // - amzn // // This member is required. Name *string // A list of key-value pairs that describe attachments to a version of a document. Attachments []types.AttachmentsSource // An optional field where you can specify a friendly name for the SSM document. // This value can differ for each version of the document. You can update this // value at a later time using the UpdateDocument operation. DisplayName *string // 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. The DeploymentStrategy document type is an // internal-use-only document type reserved for AppConfig. DocumentType types.DocumentType // A list of SSM documents required by a document. This parameter is used // exclusively by 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 What is AppConfig? (https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) // in the AppConfig 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-value pairs: // - Key=OS,Value=Windows // - Key=Environment,Value=Production // To add tags to an existing SSM document, use the AddTagsToResource operation. 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 Amazon Web Services resource // and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the CloudFormation User Guide. TargetType *string // An optional field specifying the version of the artifact you are creating with // the document. For example, Release12.1 . This value is unique across all // versions of a document, and can't be changed. VersionName *string // contains filtered or unexported fields }
type CreateDocumentOutput ¶
type CreateDocumentOutput struct { // Information about the SSM document. DocumentDescription *types.DocumentDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateMaintenanceWindowInput ¶
type CreateMaintenanceWindowInput struct { // Enables a maintenance window task to run on managed nodes, even if you haven't // registered those nodes as targets. If enabled, then you must specify the // unregistered managed nodes (by node 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 Amazon Web // Services 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-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 // operation. Tags []types.Tag // contains filtered or unexported fields }
type CreateMaintenanceWindowOutput ¶
type CreateMaintenanceWindowOutput struct { // The ID of the created maintenance window. WindowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 target Amazon Web Services account where you want to create an OpsItem. To // make this call, your account must be configured to work with OpsItems across // accounts. For more information, see Set up OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) // in the Amazon Web Services Systems Manager User Guide. AccountId *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 operation) can // view and search on the specified data. Operational data that isn't searchable is // only viewable by users who have access to the OpsItem (as provided by the // GetOpsItem API operation). 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 // Amazon Web Services CLI example commands that use these keys, see Creating // OpsItems manually (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html) // in the Amazon Web Services Systems Manager User Guide. OperationalData map[string]types.OpsItemDataValue // The type of OpsItem to create. Systems Manager supports the following types of // OpsItems: // - /aws/issue This type of OpsItem is used for default OpsItems created by // OpsCenter. // - /aws/changerequest This type of OpsItem is used by Change Manager for // reviewing and approving or rejecting change requests. // - /aws/insights This type of OpsItem is used by OpsCenter for aggregating and // reporting on duplicate OpsItems. 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. Tags use a key-value pair. For // example: Key=Department,Value=Finance To add tags to a new OpsItem, a user must // have IAM permissions for both the ssm:CreateOpsItems operation and the // ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the // AddTagsToResource operation. Tags []types.Tag // contains filtered or unexported fields }
type CreateOpsItemOutput ¶
type CreateOpsItemOutput struct { // The OpsItem Amazon Resource Name (ARN). OpsItemArn *string // The ID of the OpsItem. OpsItemId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateOpsMetadataInput ¶ added in v0.31.0
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 // Optional metadata that you assign to a resource. You can specify a maximum of // five tags for an OpsMetadata object. 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 OpsMetadata object to identify an environment or target // Amazon Web Services Region. In this case, you could specify the following // key-value pairs: // - Key=Environment,Value=Production // - Key=Region,Value=us-east-2 Tags []types.Tag // contains filtered or unexported fields }
type CreateOpsMetadataOutput ¶ added in v0.31.0
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 // contains filtered or unexported fields }
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 Amazon Web Services Systems Manager User Guide. ApprovedPatches []string // Defines the compliance level for approved patches. When an approved patch is // reported as missing, this value describes 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 managed nodes. The default value is false . // Applies to Linux managed nodes 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 Amazon Web Services 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, aren't 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 managed nodes, including // target operating systems and source repositories. Applies to Linux managed nodes // 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-value pairs: // - Key=PatchSeverity,Value=Critical // - Key=OS,Value=Windows // To add tags to an existing patch baseline, use the AddTagsToResource operation. Tags []types.Tag // contains filtered or unexported fields }
type CreatePatchBaselineOutput ¶
type CreatePatchBaselineOutput struct { // The ID of the created patch baseline. BaselineId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 Amazon Web Services // accounts and Amazon Web Services Regions, as listed in Organizations for // Explorer. If you specify SyncFromSource , you must provide a value for // SyncSource . The default value is SyncToDestination . SyncType *string // contains filtered or unexported fields }
type CreateResourceDataSyncOutput ¶
type CreateResourceDataSyncOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteActivationInput ¶
type DeleteActivationInput struct { // The ID of the activation that you want to delete. // // This member is required. ActivationId *string // contains filtered or unexported fields }
type DeleteActivationOutput ¶
type DeleteActivationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAssociationInput ¶
type DeleteAssociationInput struct { // The association ID that you want to delete. AssociationId *string // The managed node ID. InstanceId has been deprecated. To specify a managed node // ID for an association, use the Targets parameter. Requests that include the // parameter InstanceID with Systems Manager documents (SSM documents) that use // schema version 2.0 or later will fail. In addition, if you use the parameter // InstanceId , you can't use the parameters AssociationName , DocumentVersion , // MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use // these parameters, you must use the Targets parameter. InstanceId *string // The name of the SSM document. Name *string // contains filtered or unexported fields }
type DeleteAssociationOutput ¶
type DeleteAssociationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 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 // contains filtered or unexported fields }
type DeleteDocumentOutput ¶
type DeleteDocumentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 operation 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 // contains filtered or unexported fields }
type DeleteInventoryOutput ¶
type DeleteInventoryOutput struct { // Every DeleteInventory operation 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 operations. 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 Amazon Web Services 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 // contains filtered or unexported fields }
type DeleteMaintenanceWindowInput ¶
type DeleteMaintenanceWindowInput struct { // The ID of the maintenance window to delete. // // This member is required. WindowId *string // contains filtered or unexported fields }
type DeleteMaintenanceWindowOutput ¶
type DeleteMaintenanceWindowOutput struct { // The ID of the deleted maintenance window. WindowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteOpsMetadataInput ¶ added in v0.31.0
type DeleteOpsMetadataInput struct { // The Amazon Resource Name (ARN) of an OpsMetadata Object to delete. // // This member is required. OpsMetadataArn *string // contains filtered or unexported fields }
type DeleteOpsMetadataOutput ¶ added in v0.31.0
type DeleteOpsMetadataOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteParameterInput ¶
type DeleteParameterInput struct { // The name of the parameter to delete. // // This member is required. Name *string // contains filtered or unexported fields }
type DeleteParameterOutput ¶
type DeleteParameterOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteParametersInput ¶
type DeleteParametersInput struct { // The names of the parameters to delete. After deleting a parameter, wait for at // least 30 seconds to create a parameter with the same name. // // This member is required. Names []string // contains filtered or unexported fields }
type DeleteParametersOutput ¶
type DeleteParametersOutput struct { // The names of the deleted parameters. DeletedParameters []string // The names of parameters that weren't deleted because the parameters aren't // valid. InvalidParameters []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePatchBaselineInput ¶
type DeletePatchBaselineInput struct { // The ID of the patch baseline to delete. // // This member is required. BaselineId *string // contains filtered or unexported fields }
type DeletePatchBaselineOutput ¶
type DeletePatchBaselineOutput struct { // The ID of the deleted patch baseline. BaselineId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteResourceDataSyncOutput ¶
type DeleteResourceDataSyncOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteResourcePolicyInput ¶ added in v1.33.0
type DeleteResourcePolicyInput struct { // ID of the current policy version. The hash helps to prevent multiple calls from // attempting to overwrite a policy. // // This member is required. PolicyHash *string // The policy ID. // // This member is required. PolicyId *string // Amazon Resource Name (ARN) of the resource to which the policies are attached. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type DeleteResourcePolicyOutput ¶ added in v1.33.0
type DeleteResourcePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeregisterManagedInstanceInput ¶
type DeregisterManagedInstanceInput struct { // The ID assigned to the managed node when you registered it using the activation // process. // // This member is required. InstanceId *string // contains filtered or unexported fields }
type DeregisterManagedInstanceOutput ¶
type DeregisterManagedInstanceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 doesn't deregister the target // from the maintenance window. Safe *bool // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DeregisterTaskFromMaintenanceWindowInput ¶
type DeregisterTaskFromMaintenanceWindowInput struct { // The ID of the maintenance window the task should be removed from. // // This member is required. WindowId *string // The ID of the task to remove from the maintenance window. // // This member is required. WindowTaskId *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeActivationsAPIClient ¶ added in v0.30.0
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 // contains filtered or unexported fields }
type DescribeActivationsOutput ¶
type DescribeActivationsOutput struct { // A list of activations for your Amazon Web Services 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 // contains filtered or unexported fields }
type DescribeActivationsPaginator ¶ added in v0.30.0
type DescribeActivationsPaginator struct {
// contains filtered or unexported fields
}
DescribeActivationsPaginator is a paginator for DescribeActivations
func NewDescribeActivationsPaginator ¶ added in v0.30.0
func NewDescribeActivationsPaginator(client DescribeActivationsAPIClient, params *DescribeActivationsInput, optFns ...func(*DescribeActivationsPaginatorOptions)) *DescribeActivationsPaginator
NewDescribeActivationsPaginator returns a new DescribeActivationsPaginator
func (*DescribeActivationsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeActivationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeActivationsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeActivationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeActivationsOutput, error)
NextPage retrieves the next DescribeActivations page.
type DescribeActivationsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeAssociationExecutionTargetsPaginator ¶ added in v0.30.0
type DescribeAssociationExecutionTargetsPaginator struct {
// contains filtered or unexported fields
}
DescribeAssociationExecutionTargetsPaginator is a paginator for DescribeAssociationExecutionTargets
func NewDescribeAssociationExecutionTargetsPaginator ¶ added in v0.30.0
func NewDescribeAssociationExecutionTargetsPaginator(client DescribeAssociationExecutionTargetsAPIClient, params *DescribeAssociationExecutionTargetsInput, optFns ...func(*DescribeAssociationExecutionTargetsPaginatorOptions)) *DescribeAssociationExecutionTargetsPaginator
NewDescribeAssociationExecutionTargetsPaginator returns a new DescribeAssociationExecutionTargetsPaginator
func (*DescribeAssociationExecutionTargetsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeAssociationExecutionTargetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAssociationExecutionTargetsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeAssociationExecutionTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAssociationExecutionTargetsOutput, error)
NextPage retrieves the next DescribeAssociationExecutionTargets page.
type DescribeAssociationExecutionTargetsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeAssociationExecutionsPaginator ¶ added in v0.30.0
type DescribeAssociationExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeAssociationExecutionsPaginator is a paginator for DescribeAssociationExecutions
func NewDescribeAssociationExecutionsPaginator ¶ added in v0.30.0
func NewDescribeAssociationExecutionsPaginator(client DescribeAssociationExecutionsAPIClient, params *DescribeAssociationExecutionsInput, optFns ...func(*DescribeAssociationExecutionsPaginatorOptions)) *DescribeAssociationExecutionsPaginator
NewDescribeAssociationExecutionsPaginator returns a new DescribeAssociationExecutionsPaginator
func (*DescribeAssociationExecutionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeAssociationExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAssociationExecutionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeAssociationExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAssociationExecutionsOutput, error)
NextPage retrieves the next DescribeAssociationExecutions page.
type DescribeAssociationExecutionsPaginatorOptions ¶ added in v0.30.0
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 a managed node, use ListAssociations . To get a list of // versions for a specific association, use ListAssociationVersions . AssociationVersion *string // The managed node ID. InstanceId *string // The name of the SSM document. Name *string // contains filtered or unexported fields }
type DescribeAssociationOutput ¶
type DescribeAssociationOutput struct { // Information about the association. AssociationDescription *types.AssociationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAutomationExecutionsAPIClient ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeAutomationExecutionsPaginator ¶ added in v0.30.0
type DescribeAutomationExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeAutomationExecutionsPaginator is a paginator for DescribeAutomationExecutions
func NewDescribeAutomationExecutionsPaginator ¶ added in v0.30.0
func NewDescribeAutomationExecutionsPaginator(client DescribeAutomationExecutionsAPIClient, params *DescribeAutomationExecutionsInput, optFns ...func(*DescribeAutomationExecutionsPaginatorOptions)) *DescribeAutomationExecutionsPaginator
NewDescribeAutomationExecutionsPaginator returns a new DescribeAutomationExecutionsPaginator
func (*DescribeAutomationExecutionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeAutomationExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAutomationExecutionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeAutomationExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAutomationExecutionsOutput, error)
NextPage retrieves the next DescribeAutomationExecutions page.
type DescribeAutomationExecutionsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // Indicates whether to list step executions in reverse order by start time. The // default value is 'false'. ReverseOrder *bool // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeAutomationStepExecutionsPaginator ¶ added in v0.30.0
type DescribeAutomationStepExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeAutomationStepExecutionsPaginator is a paginator for DescribeAutomationStepExecutions
func NewDescribeAutomationStepExecutionsPaginator ¶ added in v0.30.0
func NewDescribeAutomationStepExecutionsPaginator(client DescribeAutomationStepExecutionsAPIClient, params *DescribeAutomationStepExecutionsInput, optFns ...func(*DescribeAutomationStepExecutionsPaginatorOptions)) *DescribeAutomationStepExecutionsPaginator
NewDescribeAutomationStepExecutionsPaginator returns a new DescribeAutomationStepExecutionsPaginator
func (*DescribeAutomationStepExecutionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeAutomationStepExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAutomationStepExecutionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeAutomationStepExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAutomationStepExecutionsOutput, error)
NextPage retrieves the next DescribeAutomationStepExecutions page.
type DescribeAutomationStepExecutionsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 { // Each element in the array is a structure containing a key-value pair. Windows // Server Supported keys for Windows Server managed node patches include the // following: // - PATCH_SET Sample values: OS | APPLICATION // - PRODUCT Sample values: WindowsServer2012 | Office 2010 | // MicrosoftDefenderAntivirus // - PRODUCT_FAMILY Sample values: Windows | Office // - MSRC_SEVERITY Sample values: ServicePacks | Important | Moderate // - CLASSIFICATION Sample values: ServicePacks | SecurityUpdates | // DefinitionUpdates // - PATCH_ID Sample values: KB123456 | KB4516046 // Linux When specifying filters for Linux patches, you must specify a key-pair // for PRODUCT . For example, using the Command Line Interface (CLI), the following // command fails: aws ssm describe-available-patches --filters // Key=CVE_ID,Values=CVE-2018-3615 However, the following command succeeds: aws // ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 // Key=CVE_ID,Values=CVE-2018-3615 Supported keys for Linux managed node patches // include the following: // - PRODUCT Sample values: AmazonLinux2018.03 | AmazonLinux2.0 // - NAME Sample values: kernel-headers | samba-python | php // - SEVERITY Sample values: Critical | Important | Medium | Low // - EPOCH Sample values: 0 | 1 // - VERSION Sample values: 78.6.1 | 4.10.16 // - RELEASE Sample values: 9.56.amzn1 | 1.amzn2 // - ARCH Sample values: i686 | x86_64 // - REPOSITORY Sample values: Core | Updates // - ADVISORY_ID Sample values: ALAS-2018-1058 | ALAS2-2021-1594 // - CVE_ID Sample values: CVE-2018-3615 | CVE-2020-1472 // - BUGZILLA_ID Sample values: 1463241 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeAvailablePatchesPaginator ¶ added in v0.30.0
type DescribeAvailablePatchesPaginator struct {
// contains filtered or unexported fields
}
DescribeAvailablePatchesPaginator is a paginator for DescribeAvailablePatches
func NewDescribeAvailablePatchesPaginator ¶ added in v0.30.0
func NewDescribeAvailablePatchesPaginator(client DescribeAvailablePatchesAPIClient, params *DescribeAvailablePatchesInput, optFns ...func(*DescribeAvailablePatchesPaginatorOptions)) *DescribeAvailablePatchesPaginator
NewDescribeAvailablePatchesPaginator returns a new DescribeAvailablePatchesPaginator
func (*DescribeAvailablePatchesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeAvailablePatchesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAvailablePatchesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeAvailablePatchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAvailablePatchesOutput, error)
NextPage retrieves the next DescribeAvailablePatches page.
type DescribeAvailablePatchesPaginatorOptions ¶ added in v0.30.0
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 SSM 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 can't be changed. VersionName *string // contains filtered or unexported fields }
type DescribeDocumentOutput ¶
type DescribeDocumentOutput struct { // Information about the SSM document. Document *types.DocumentDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // 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 // contains filtered or unexported fields }
type DescribeDocumentPermissionOutput ¶
type DescribeDocumentPermissionOutput struct { // The account IDs that have permission to use this document. The ID can be either // an Amazon Web Services account or All. AccountIds []string // A list of Amazon Web Services accounts where the current document is shared and // the version shared with each account. AccountSharingInfoList []types.AccountSharingInfo // 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 // contains filtered or unexported fields }
type DescribeEffectiveInstanceAssociationsAPIClient ¶ added in v0.30.0
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 managed node 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 // contains filtered or unexported fields }
type DescribeEffectiveInstanceAssociationsOutput ¶
type DescribeEffectiveInstanceAssociationsOutput struct { // The associations for the requested managed node. 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 // contains filtered or unexported fields }
type DescribeEffectiveInstanceAssociationsPaginator ¶ added in v0.30.0
type DescribeEffectiveInstanceAssociationsPaginator struct {
// contains filtered or unexported fields
}
DescribeEffectiveInstanceAssociationsPaginator is a paginator for DescribeEffectiveInstanceAssociations
func NewDescribeEffectiveInstanceAssociationsPaginator ¶ added in v0.30.0
func NewDescribeEffectiveInstanceAssociationsPaginator(client DescribeEffectiveInstanceAssociationsAPIClient, params *DescribeEffectiveInstanceAssociationsInput, optFns ...func(*DescribeEffectiveInstanceAssociationsPaginatorOptions)) *DescribeEffectiveInstanceAssociationsPaginator
NewDescribeEffectiveInstanceAssociationsPaginator returns a new DescribeEffectiveInstanceAssociationsPaginator
func (*DescribeEffectiveInstanceAssociationsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeEffectiveInstanceAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeEffectiveInstanceAssociationsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeEffectiveInstanceAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEffectiveInstanceAssociationsOutput, error)
NextPage retrieves the next DescribeEffectiveInstanceAssociations page.
type DescribeEffectiveInstanceAssociationsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeEffectivePatchesForPatchBaselinePaginator ¶ added in v0.30.0
type DescribeEffectivePatchesForPatchBaselinePaginator struct {
// contains filtered or unexported fields
}
DescribeEffectivePatchesForPatchBaselinePaginator is a paginator for DescribeEffectivePatchesForPatchBaseline
func NewDescribeEffectivePatchesForPatchBaselinePaginator ¶ added in v0.30.0
func NewDescribeEffectivePatchesForPatchBaselinePaginator(client DescribeEffectivePatchesForPatchBaselineAPIClient, params *DescribeEffectivePatchesForPatchBaselineInput, optFns ...func(*DescribeEffectivePatchesForPatchBaselinePaginatorOptions)) *DescribeEffectivePatchesForPatchBaselinePaginator
NewDescribeEffectivePatchesForPatchBaselinePaginator returns a new DescribeEffectivePatchesForPatchBaselinePaginator
func (*DescribeEffectivePatchesForPatchBaselinePaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeEffectivePatchesForPatchBaselinePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeEffectivePatchesForPatchBaselinePaginator) NextPage ¶ added in v0.30.0
func (p *DescribeEffectivePatchesForPatchBaselinePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEffectivePatchesForPatchBaselineOutput, error)
NextPage retrieves the next DescribeEffectivePatchesForPatchBaseline page.
type DescribeEffectivePatchesForPatchBaselinePaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 managed node 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeInstanceAssociationsStatusPaginator ¶ added in v0.30.0
type DescribeInstanceAssociationsStatusPaginator struct {
// contains filtered or unexported fields
}
DescribeInstanceAssociationsStatusPaginator is a paginator for DescribeInstanceAssociationsStatus
func NewDescribeInstanceAssociationsStatusPaginator ¶ added in v0.30.0
func NewDescribeInstanceAssociationsStatusPaginator(client DescribeInstanceAssociationsStatusAPIClient, params *DescribeInstanceAssociationsStatusInput, optFns ...func(*DescribeInstanceAssociationsStatusPaginatorOptions)) *DescribeInstanceAssociationsStatusPaginator
NewDescribeInstanceAssociationsStatusPaginator returns a new DescribeInstanceAssociationsStatusPaginator
func (*DescribeInstanceAssociationsStatusPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeInstanceAssociationsStatusPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstanceAssociationsStatusPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeInstanceAssociationsStatusPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstanceAssociationsStatusOutput, error)
NextPage retrieves the next DescribeInstanceAssociationsStatus page.
type DescribeInstanceAssociationsStatusPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 managed // nodes. You can filter based on tags applied to your managed nodes. Tag filters // can't be combined with other filter types. 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 node information by // filtering based on tags applied to managed nodes. 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. // The default value is 10 items. MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string // contains filtered or unexported fields }
type DescribeInstanceInformationOutput ¶
type DescribeInstanceInformationOutput struct { // The managed node 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 // contains filtered or unexported fields }
type DescribeInstanceInformationPaginator ¶ added in v0.30.0
type DescribeInstanceInformationPaginator struct {
// contains filtered or unexported fields
}
DescribeInstanceInformationPaginator is a paginator for DescribeInstanceInformation
func NewDescribeInstanceInformationPaginator ¶ added in v0.30.0
func NewDescribeInstanceInformationPaginator(client DescribeInstanceInformationAPIClient, params *DescribeInstanceInformationInput, optFns ...func(*DescribeInstanceInformationPaginatorOptions)) *DescribeInstanceInformationPaginator
NewDescribeInstanceInformationPaginator returns a new DescribeInstanceInformationPaginator
func (*DescribeInstanceInformationPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeInstanceInformationPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstanceInformationPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeInstanceInformationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstanceInformationOutput, error)
NextPage retrieves the next DescribeInstanceInformation page.
type DescribeInstanceInformationPaginatorOptions ¶ added in v0.30.0
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. // The default value is 10 items. 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 ¶ added in v0.30.0
type DescribeInstancePatchStatesAPIClient interface {
DescribeInstancePatchStates(context.Context, *DescribeInstancePatchStatesInput, ...func(*Options)) (*DescribeInstancePatchStatesOutput, error)
}
DescribeInstancePatchStatesAPIClient is a client that implements the DescribeInstancePatchStates operation.
type DescribeInstancePatchStatesForPatchGroupAPIClient ¶ added in v0.30.0
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 // contains filtered or unexported fields }
type DescribeInstancePatchStatesForPatchGroupOutput ¶
type DescribeInstancePatchStatesForPatchGroupOutput struct { // The high-level patch state for the requested managed nodes. 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 // contains filtered or unexported fields }
type DescribeInstancePatchStatesForPatchGroupPaginator ¶ added in v0.30.0
type DescribeInstancePatchStatesForPatchGroupPaginator struct {
// contains filtered or unexported fields
}
DescribeInstancePatchStatesForPatchGroupPaginator is a paginator for DescribeInstancePatchStatesForPatchGroup
func NewDescribeInstancePatchStatesForPatchGroupPaginator ¶ added in v0.30.0
func NewDescribeInstancePatchStatesForPatchGroupPaginator(client DescribeInstancePatchStatesForPatchGroupAPIClient, params *DescribeInstancePatchStatesForPatchGroupInput, optFns ...func(*DescribeInstancePatchStatesForPatchGroupPaginatorOptions)) *DescribeInstancePatchStatesForPatchGroupPaginator
NewDescribeInstancePatchStatesForPatchGroupPaginator returns a new DescribeInstancePatchStatesForPatchGroupPaginator
func (*DescribeInstancePatchStatesForPatchGroupPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeInstancePatchStatesForPatchGroupPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstancePatchStatesForPatchGroupPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeInstancePatchStatesForPatchGroupPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstancePatchStatesForPatchGroupOutput, error)
NextPage retrieves the next DescribeInstancePatchStatesForPatchGroup page.
type DescribeInstancePatchStatesForPatchGroupPaginatorOptions ¶ added in v0.30.0
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 managed node for which patch state information should be // retrieved. // // This member is required. InstanceIds []string // The maximum number of managed nodes 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 // contains filtered or unexported fields }
type DescribeInstancePatchStatesOutput ¶
type DescribeInstancePatchStatesOutput struct { // The high-level patch state for the requested managed nodes. 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 // contains filtered or unexported fields }
type DescribeInstancePatchStatesPaginator ¶ added in v0.30.0
type DescribeInstancePatchStatesPaginator struct {
// contains filtered or unexported fields
}
DescribeInstancePatchStatesPaginator is a paginator for DescribeInstancePatchStates
func NewDescribeInstancePatchStatesPaginator ¶ added in v0.30.0
func NewDescribeInstancePatchStatesPaginator(client DescribeInstancePatchStatesAPIClient, params *DescribeInstancePatchStatesInput, optFns ...func(*DescribeInstancePatchStatesPaginatorOptions)) *DescribeInstancePatchStatesPaginator
NewDescribeInstancePatchStatesPaginator returns a new DescribeInstancePatchStatesPaginator
func (*DescribeInstancePatchStatesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeInstancePatchStatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstancePatchStatesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeInstancePatchStatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstancePatchStatesOutput, error)
NextPage retrieves the next DescribeInstancePatchStates page.
type DescribeInstancePatchStatesPaginatorOptions ¶ added in v0.30.0
type DescribeInstancePatchStatesPaginatorOptions struct { // The maximum number of managed nodes 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 ¶ added in v0.30.0
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 managed node whose patch state information should be retrieved. // // This member is required. InstanceId *string // Each element in the array is a structure containing a key-value pair. Supported // keys for DescribeInstancePatches include the following: // - Classification Sample values: Security | SecurityUpdates // - KBId Sample values: KB4480056 | java-1.7.0-openjdk.x86_64 // - Severity Sample values: Important | Medium | Low // - State Sample values: Installed | InstalledOther | InstalledPendingReboot 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeInstancePatchesPaginator ¶ added in v0.30.0
type DescribeInstancePatchesPaginator struct {
// contains filtered or unexported fields
}
DescribeInstancePatchesPaginator is a paginator for DescribeInstancePatches
func NewDescribeInstancePatchesPaginator ¶ added in v0.30.0
func NewDescribeInstancePatchesPaginator(client DescribeInstancePatchesAPIClient, params *DescribeInstancePatchesInput, optFns ...func(*DescribeInstancePatchesPaginatorOptions)) *DescribeInstancePatchesPaginator
NewDescribeInstancePatchesPaginator returns a new DescribeInstancePatchesPaginator
func (*DescribeInstancePatchesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeInstancePatchesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInstancePatchesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeInstancePatchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstancePatchesOutput, error)
NextPage retrieves the next DescribeInstancePatches page.
type DescribeInstancePatchesPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 operation. 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeInventoryDeletionsPaginator ¶ added in v0.30.0
type DescribeInventoryDeletionsPaginator struct {
// contains filtered or unexported fields
}
DescribeInventoryDeletionsPaginator is a paginator for DescribeInventoryDeletions
func NewDescribeInventoryDeletionsPaginator ¶ added in v0.30.0
func NewDescribeInventoryDeletionsPaginator(client DescribeInventoryDeletionsAPIClient, params *DescribeInventoryDeletionsInput, optFns ...func(*DescribeInventoryDeletionsPaginatorOptions)) *DescribeInventoryDeletionsPaginator
NewDescribeInventoryDeletionsPaginator returns a new DescribeInventoryDeletionsPaginator
func (*DescribeInventoryDeletionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeInventoryDeletionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeInventoryDeletionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeInventoryDeletionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInventoryDeletionsOutput, error)
NextPage retrieves the next DescribeInventoryDeletions page.
type DescribeInventoryDeletionsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeMaintenanceWindowExecutionTaskInvocationsPaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowExecutionTaskInvocationsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowExecutionTaskInvocationsPaginator is a paginator for DescribeMaintenanceWindowExecutionTaskInvocations
func NewDescribeMaintenanceWindowExecutionTaskInvocationsPaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowExecutionTaskInvocationsPaginator(client DescribeMaintenanceWindowExecutionTaskInvocationsAPIClient, params *DescribeMaintenanceWindowExecutionTaskInvocationsInput, optFns ...func(*DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorOptions)) *DescribeMaintenanceWindowExecutionTaskInvocationsPaginator
NewDescribeMaintenanceWindowExecutionTaskInvocationsPaginator returns a new DescribeMaintenanceWindowExecutionTaskInvocationsPaginator
func (*DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowExecutionTaskInvocationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowExecutionTaskInvocations page.
type DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeMaintenanceWindowExecutionTasksPaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowExecutionTasksPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowExecutionTasksPaginator is a paginator for DescribeMaintenanceWindowExecutionTasks
func NewDescribeMaintenanceWindowExecutionTasksPaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowExecutionTasksPaginator(client DescribeMaintenanceWindowExecutionTasksAPIClient, params *DescribeMaintenanceWindowExecutionTasksInput, optFns ...func(*DescribeMaintenanceWindowExecutionTasksPaginatorOptions)) *DescribeMaintenanceWindowExecutionTasksPaginator
NewDescribeMaintenanceWindowExecutionTasksPaginator returns a new DescribeMaintenanceWindowExecutionTasksPaginator
func (*DescribeMaintenanceWindowExecutionTasksPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowExecutionTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowExecutionTasksPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowExecutionTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionTasksOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowExecutionTasks page.
type DescribeMaintenanceWindowExecutionTasksPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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. A string between 1 and 128 characters. Supported keys include // ExecutedBefore and ExecutedAfter . // - Values. An array of strings, each between 1 and 256 characters. Supported // values are date/time strings in a valid ISO 8601 date/time format, such as // 2021-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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeMaintenanceWindowExecutionsPaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowExecutionsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowExecutionsPaginator is a paginator for DescribeMaintenanceWindowExecutions
func NewDescribeMaintenanceWindowExecutionsPaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowExecutionsPaginator(client DescribeMaintenanceWindowExecutionsAPIClient, params *DescribeMaintenanceWindowExecutionsInput, optFns ...func(*DescribeMaintenanceWindowExecutionsPaginatorOptions)) *DescribeMaintenanceWindowExecutionsPaginator
NewDescribeMaintenanceWindowExecutionsPaginator returns a new DescribeMaintenanceWindowExecutionsPaginator
func (*DescribeMaintenanceWindowExecutionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowExecutionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowExecutionsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowExecutions page.
type DescribeMaintenanceWindowExecutionsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 managed node ID or key-value pair to retrieve information about. Targets []types.Target // The ID of the maintenance window to retrieve information about. WindowId *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeMaintenanceWindowSchedulePaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowSchedulePaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowSchedulePaginator is a paginator for DescribeMaintenanceWindowSchedule
func NewDescribeMaintenanceWindowSchedulePaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowSchedulePaginator(client DescribeMaintenanceWindowScheduleAPIClient, params *DescribeMaintenanceWindowScheduleInput, optFns ...func(*DescribeMaintenanceWindowSchedulePaginatorOptions)) *DescribeMaintenanceWindowSchedulePaginator
NewDescribeMaintenanceWindowSchedulePaginator returns a new DescribeMaintenanceWindowSchedulePaginator
func (*DescribeMaintenanceWindowSchedulePaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowSchedulePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowSchedulePaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowSchedulePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowScheduleOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowSchedule page.
type DescribeMaintenanceWindowSchedulePaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeMaintenanceWindowTargetsPaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowTargetsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowTargetsPaginator is a paginator for DescribeMaintenanceWindowTargets
func NewDescribeMaintenanceWindowTargetsPaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowTargetsPaginator(client DescribeMaintenanceWindowTargetsAPIClient, params *DescribeMaintenanceWindowTargetsInput, optFns ...func(*DescribeMaintenanceWindowTargetsPaginatorOptions)) *DescribeMaintenanceWindowTargetsPaginator
NewDescribeMaintenanceWindowTargetsPaginator returns a new DescribeMaintenanceWindowTargetsPaginator
func (*DescribeMaintenanceWindowTargetsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowTargetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowTargetsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowTargetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowTargetsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowTargets page.
type DescribeMaintenanceWindowTargetsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeMaintenanceWindowTasksPaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowTasksPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowTasksPaginator is a paginator for DescribeMaintenanceWindowTasks
func NewDescribeMaintenanceWindowTasksPaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowTasksPaginator(client DescribeMaintenanceWindowTasksAPIClient, params *DescribeMaintenanceWindowTasksInput, optFns ...func(*DescribeMaintenanceWindowTasksPaginatorOptions)) *DescribeMaintenanceWindowTasksPaginator
NewDescribeMaintenanceWindowTasksPaginator returns a new DescribeMaintenanceWindowTasksPaginator
func (*DescribeMaintenanceWindowTasksPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowTasksPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowTasksOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowTasks page.
type DescribeMaintenanceWindowTasksPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
type DescribeMaintenanceWindowsAPIClient interface {
DescribeMaintenanceWindows(context.Context, *DescribeMaintenanceWindowsInput, ...func(*Options)) (*DescribeMaintenanceWindowsOutput, error)
}
DescribeMaintenanceWindowsAPIClient is a client that implements the DescribeMaintenanceWindows operation.
type DescribeMaintenanceWindowsForTargetAPIClient ¶ added in v0.30.0
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 managed node 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 // contains filtered or unexported fields }
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 a managed node is // associated with. WindowIdentities []types.MaintenanceWindowIdentityForTarget // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeMaintenanceWindowsForTargetPaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowsForTargetPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowsForTargetPaginator is a paginator for DescribeMaintenanceWindowsForTarget
func NewDescribeMaintenanceWindowsForTargetPaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowsForTargetPaginator(client DescribeMaintenanceWindowsForTargetAPIClient, params *DescribeMaintenanceWindowsForTargetInput, optFns ...func(*DescribeMaintenanceWindowsForTargetPaginatorOptions)) *DescribeMaintenanceWindowsForTargetPaginator
NewDescribeMaintenanceWindowsForTargetPaginator returns a new DescribeMaintenanceWindowsForTargetPaginator
func (*DescribeMaintenanceWindowsForTargetPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowsForTargetPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowsForTargetPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowsForTargetPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowsForTargetOutput, error)
NextPage retrieves the next DescribeMaintenanceWindowsForTarget page.
type DescribeMaintenanceWindowsForTargetPaginatorOptions ¶ added in v0.30.0
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 . For example, // Name=MyMaintenanceWindow and Enabled=True . 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeMaintenanceWindowsPaginator ¶ added in v0.30.0
type DescribeMaintenanceWindowsPaginator struct {
// contains filtered or unexported fields
}
DescribeMaintenanceWindowsPaginator is a paginator for DescribeMaintenanceWindows
func NewDescribeMaintenanceWindowsPaginator ¶ added in v0.30.0
func NewDescribeMaintenanceWindowsPaginator(client DescribeMaintenanceWindowsAPIClient, params *DescribeMaintenanceWindowsInput, optFns ...func(*DescribeMaintenanceWindowsPaginatorOptions)) *DescribeMaintenanceWindowsPaginator
NewDescribeMaintenanceWindowsPaginator returns a new DescribeMaintenanceWindowsPaginator
func (*DescribeMaintenanceWindowsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeMaintenanceWindowsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeMaintenanceWindowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeMaintenanceWindowsOutput, error)
NextPage retrieves the next DescribeMaintenanceWindows page.
type DescribeMaintenanceWindowsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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: Equals,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 // - Key: AccountId Operations: Equals // *The Equals operator for Title matches the first 100 characters. If you specify // more than 100 characters, they system returns an error that the filter value // exceeds the length limit. **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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeOpsItemsPaginator ¶ added in v0.30.0
type DescribeOpsItemsPaginator struct {
// contains filtered or unexported fields
}
DescribeOpsItemsPaginator is a paginator for DescribeOpsItems
func NewDescribeOpsItemsPaginator ¶ added in v0.30.0
func NewDescribeOpsItemsPaginator(client DescribeOpsItemsAPIClient, params *DescribeOpsItemsInput, optFns ...func(*DescribeOpsItemsPaginatorOptions)) *DescribeOpsItemsPaginator
NewDescribeOpsItemsPaginator returns a new DescribeOpsItemsPaginator
func (*DescribeOpsItemsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeOpsItemsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeOpsItemsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeOpsItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeOpsItemsOutput, error)
NextPage retrieves the next DescribeOpsItems page.
type DescribeOpsItemsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeParametersPaginator ¶ added in v0.30.0
type DescribeParametersPaginator struct {
// contains filtered or unexported fields
}
DescribeParametersPaginator is a paginator for DescribeParameters
func NewDescribeParametersPaginator ¶ added in v0.30.0
func NewDescribeParametersPaginator(client DescribeParametersAPIClient, params *DescribeParametersInput, optFns ...func(*DescribeParametersPaginatorOptions)) *DescribeParametersPaginator
NewDescribeParametersPaginator returns a new DescribeParametersPaginator
func (*DescribeParametersPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeParametersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeParametersPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeParametersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeParametersOutput, error)
NextPage retrieves the next DescribeParameters page.
type DescribeParametersPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 a key-value pair. Supported // keys for DescribePatchBaselines include the following: // - NAME_PREFIX Sample values: AWS- | My- // - OWNER Sample values: AWS | Self // - OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribePatchBaselinesPaginator ¶ added in v0.30.0
type DescribePatchBaselinesPaginator struct {
// contains filtered or unexported fields
}
DescribePatchBaselinesPaginator is a paginator for DescribePatchBaselines
func NewDescribePatchBaselinesPaginator ¶ added in v0.30.0
func NewDescribePatchBaselinesPaginator(client DescribePatchBaselinesAPIClient, params *DescribePatchBaselinesInput, optFns ...func(*DescribePatchBaselinesPaginatorOptions)) *DescribePatchBaselinesPaginator
NewDescribePatchBaselinesPaginator returns a new DescribePatchBaselinesPaginator
func (*DescribePatchBaselinesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribePatchBaselinesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePatchBaselinesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribePatchBaselinesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePatchBaselinesOutput, error)
NextPage retrieves the next DescribePatchBaselines page.
type DescribePatchBaselinesPaginatorOptions ¶ added in v0.30.0
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 // contains filtered or unexported fields }
type DescribePatchGroupStateOutput ¶
type DescribePatchGroupStateOutput struct { // The number of managed nodes in the patch group. Instances int32 // The number of managed nodes where patches that are specified as Critical for // compliance reporting in the patch baseline aren't installed. These patches might // be missing, have failed installation, were rejected, or were installed but // awaiting a required managed node reboot. The status of these managed nodes is // NON_COMPLIANT . InstancesWithCriticalNonCompliantPatches *int32 // The number of managed nodes with patches from the patch baseline that failed to // install. InstancesWithFailedPatches int32 // The number of managed nodes with patches installed that aren't defined in the // patch baseline. InstancesWithInstalledOtherPatches int32 // The number of managed nodes with installed patches. InstancesWithInstalledPatches int32 // The number of managed nodes with patches installed by Patch Manager that // haven't been rebooted after the patch installation. The status of these managed // nodes is NON_COMPLIANT . InstancesWithInstalledPendingRebootPatches *int32 // The number of managed nodes 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 managed nodes with missing patches from the patch baseline. InstancesWithMissingPatches int32 // The number of managed nodes with patches that aren't applicable. InstancesWithNotApplicablePatches int32 // The number of managed nodes with patches installed that are specified as other // than Critical or Security but aren't compliant with the patch baseline. The // status of these managed nodes is NON_COMPLIANT . InstancesWithOtherNonCompliantPatches *int32 // The number of managed nodes where patches that are specified as Security in a // patch advisory aren't installed. These patches might be missing, have failed // installation, were rejected, or were installed but awaiting a required managed // node reboot. The status of these managed nodes is NON_COMPLIANT . InstancesWithSecurityNonCompliantPatches *int32 // The number of managed nodes with NotApplicable patches beyond the supported // limit, which aren't reported by name to Inventory. Inventory is a capability of // Amazon Web Services Systems Manager. InstancesWithUnreportedNotApplicablePatches *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribePatchGroupsAPIClient ¶ added in v0.30.0
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 { // Each element in the array is a structure containing a key-value pair. Supported // keys for DescribePatchGroups include the following: // - NAME_PREFIX Sample values: AWS- | My- . // - OPERATING_SYSTEM Sample values: AMAZON_LINUX | SUSE | WINDOWS 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribePatchGroupsPaginator ¶ added in v0.30.0
type DescribePatchGroupsPaginator struct {
// contains filtered or unexported fields
}
DescribePatchGroupsPaginator is a paginator for DescribePatchGroups
func NewDescribePatchGroupsPaginator ¶ added in v0.30.0
func NewDescribePatchGroupsPaginator(client DescribePatchGroupsAPIClient, params *DescribePatchGroupsInput, optFns ...func(*DescribePatchGroupsPaginatorOptions)) *DescribePatchGroupsPaginator
NewDescribePatchGroupsPaginator returns a new DescribePatchGroupsPaginator
func (*DescribePatchGroupsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribePatchGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePatchGroupsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribePatchGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePatchGroupsOutput, error)
NextPage retrieves the next DescribePatchGroups page.
type DescribePatchGroupsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // applications released by Microsoft. Not applicable for the Linux or macOS // operating systems. PatchSet types.PatchSet // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribePatchPropertiesPaginator ¶ added in v0.30.0
type DescribePatchPropertiesPaginator struct {
// contains filtered or unexported fields
}
DescribePatchPropertiesPaginator is a paginator for DescribePatchProperties
func NewDescribePatchPropertiesPaginator ¶ added in v0.30.0
func NewDescribePatchPropertiesPaginator(client DescribePatchPropertiesAPIClient, params *DescribePatchPropertiesInput, optFns ...func(*DescribePatchPropertiesPaginatorOptions)) *DescribePatchPropertiesPaginator
NewDescribePatchPropertiesPaginator returns a new DescribePatchPropertiesPaginator
func (*DescribePatchPropertiesPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribePatchPropertiesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribePatchPropertiesPaginator) NextPage ¶ added in v0.30.0
func (p *DescribePatchPropertiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribePatchPropertiesOutput, error)
NextPage retrieves the next DescribePatchProperties page.
type DescribePatchPropertiesPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DescribeSessionsPaginator ¶ added in v0.30.0
type DescribeSessionsPaginator struct {
// contains filtered or unexported fields
}
DescribeSessionsPaginator is a paginator for DescribeSessions
func NewDescribeSessionsPaginator ¶ added in v0.30.0
func NewDescribeSessionsPaginator(client DescribeSessionsAPIClient, params *DescribeSessionsInput, optFns ...func(*DescribeSessionsPaginatorOptions)) *DescribeSessionsPaginator
NewDescribeSessionsPaginator returns a new DescribeSessionsPaginator
func (*DescribeSessionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *DescribeSessionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeSessionsPaginator) NextPage ¶ added in v0.30.0
func (p *DescribeSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSessionsOutput, error)
NextPage retrieves the next DescribeSessions page.
type DescribeSessionsPaginatorOptions ¶ added in v0.30.0
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 DisassociateOpsItemRelatedItemInput ¶ added in v1.6.0
type DisassociateOpsItemRelatedItemInput struct { // The ID of the association for which you want to delete an association between // the OpsItem and a related item. // // This member is required. AssociationId *string // The ID of the OpsItem for which you want to delete an association between the // OpsItem and a related item. // // This member is required. OpsItemId *string // contains filtered or unexported fields }
type DisassociateOpsItemRelatedItemOutput ¶ added in v1.6.0
type DisassociateOpsItemRelatedItemOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.37.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.37.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.37.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.37.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.37.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
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 runbook is initiated. // // This member is required. AutomationExecutionId *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type GetCalendarStateInput ¶
type GetCalendarStateInput struct { // The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM // 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 don't specify a value or AtTime , the current time is used. AtTime *string // contains filtered or unexported fields }
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 don't 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 aren't allowed to // proceed. State types.CalendarState // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetCommandInvocationAPIClient ¶ added in v0.31.0
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 node targeted by the command. A managed node // can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and // on-premises server or VM in your hybrid environment that is configured for // Amazon Web Services Systems Manager. // // This member is required. InstanceId *string // The name of the step for which you want detailed results. If the document // contains only one step, you can omit the name and details for that step. If the // document contains more than one step, you must specify the name of the step for // which you want to view details. Be sure to specify the name of the step, not the // name of a plugin like aws:RunShellScript . To find the PluginName , check the // document content and find the name of the step you want details for. // Alternatively, use ListCommandInvocations with the CommandId and Details // parameters. The PluginName is the Name attribute of the CommandPlugin object in // the CommandPlugins list. PluginName *string // contains filtered or unexported fields }
type GetCommandInvocationOutput ¶
type GetCommandInvocationOutput struct { // Amazon 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 Systems Manager document (SSM document) version used in the request. DocumentVersion *string // Duration since ExecutionStartDateTime . ExecutionElapsedTime *string // The date and time the plugin 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 Amazon Web Services CLI command uses the InvokedAfter filter. // aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If // the plugin hasn't 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-06-7. The // following sample Amazon Web Services CLI command uses the InvokedBefore filter. // aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If // the plugin hasn't started to run, the string is empty. ExecutionStartDateTime *string // The ID of the managed node targeted by the command. A managed node can be an // Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises // server or VM in your hybrid environment that is configured for Amazon Web // Services Systems Manager. InstanceId *string // The name of the plugin, or step name, for which details are reported. For // example, aws:RunShellScript is a plugin. PluginName *string // The error level response code for the plugin script. If the response code is -1 // , then the command hasn't started running on the managed node, or it wasn't // received by the node. ResponseCode int32 // The first 8,000 characters written by the plugin to stderr . If the command // hasn't finished running, then this string is empty. StandardErrorContent *string // The URL for the complete text written by the plugin to stderr . If the command // hasn't finished running, then this string is empty. StandardErrorUrl *string // The first 24,000 characters written by the plugin to stdout . If the command // hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, // then this string is empty. StandardOutputContent *string // The URL for the complete text written by the plugin to stdout in Amazon Simple // Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string // is empty. StandardOutputUrl *string // The status of this invocation plugin. This status can be different than // StatusDetails . Status types.CommandInvocationStatus // A detailed status of the command execution for an invocation. StatusDetails // includes more information than Status because it includes states resulting from // error and concurrency control parameters. StatusDetails can show different // results than Status . For more information about these statuses, see // Understanding command statuses (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html) // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one // of the following values: // - Pending: The command hasn't been sent to the managed node. // - In Progress: The command has been sent to the managed node but hasn't // reached a terminal state. // - Delayed: The system attempted to send the command to the target, but the // target wasn't available. The managed node might not be available because of // network issues, because the node was stopped, or for similar reasons. The system // will try to send the command again. // - Success: The command or plugin ran successfully. This is a terminal state. // - Delivery Timed Out: The command wasn't delivered to the managed node before // the delivery timeout expired. Delivery timeouts don't count against the parent // command's MaxErrors limit, but they do contribute to whether the parent // command status is Success or Incomplete. This is a terminal state. // - Execution Timed Out: The command started to run on the managed node, but // the execution wasn't complete before the timeout expired. Execution timeouts // count against the MaxErrors limit of the parent command. This is a terminal // state. // - Failed: The command wasn't run successfully on the managed node. For a // plugin, this indicates that the result code wasn't zero. For a command // invocation, this indicates that the result code for one or more plugins wasn't // zero. Invocation failures count against the MaxErrors limit of the parent // command. This is a terminal state. // - Cancelled: The command was terminated before it was completed. This is a // terminal state. // - Undeliverable: The command can't be delivered to the managed node. The node // might not exist or might not be responding. Undeliverable invocations don't // count against the parent command's MaxErrors limit and don't contribute to // whether the parent command status is Success or Incomplete. This is a terminal // state. // - Terminated: The parent command exceeded its MaxErrors limit and subsequent // command invocations were canceled by the system. This is a terminal state. StatusDetails *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetConnectionStatusInput ¶
type GetConnectionStatusInput struct { // The managed node ID. // // This member is required. Target *string // contains filtered or unexported fields }
type GetConnectionStatusOutput ¶
type GetConnectionStatusOutput struct { // The status of the connection to the managed node. For example, 'Connected' or // 'Not Connected'. Status types.ConnectionStatus // The ID of the managed node to check connection status. Target *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDefaultPatchBaselineInput ¶
type GetDefaultPatchBaselineInput struct { // Returns the default patch baseline for the specified operating system. OperatingSystem types.OperatingSystem // contains filtered or unexported fields }
type GetDefaultPatchBaselineOutput ¶
type GetDefaultPatchBaselineOutput struct { // The ID of the default patch baseline. BaselineId *string // The operating system for the returned patch baseline. OperatingSystem types.OperatingSystem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDeployablePatchSnapshotForInstanceInput ¶
type GetDeployablePatchSnapshotForInstanceInput struct { // The ID of the managed node for which the appropriate patch snapshot should be // retrieved. // // This member is required. InstanceId *string // The snapshot ID provided by the user when running AWS-RunPatchBaseline . // // This member is required. SnapshotId *string // Defines the basic information about a patch baseline override. BaselineOverride *types.BaselineOverride // contains filtered or unexported fields }
type GetDeployablePatchSnapshotForInstanceOutput ¶
type GetDeployablePatchSnapshotForInstanceOutput struct { // The managed node ID. InstanceId *string // Returns the specific operating system (for example Windows Server 2012 or // Amazon Linux 2015.09) on the managed node for the specified patch snapshot. Product *string // A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to // download the patch snapshot. SnapshotDownloadUrl *string // The user-defined snapshot ID. SnapshotId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDocumentInput ¶
type GetDocumentInput struct { // The name of the SSM document. // // This member is required. Name *string // Returns the document in the specified format. The document format can be either // JSON or YAML. JSON is the default format. DocumentFormat types.DocumentFormat // The document version for which you want information. DocumentVersion *string // An optional field specifying the version of the artifact associated with the // document. For example, "Release 12, Update 6". This value is unique across all // versions of a document and can't be changed. VersionName *string // contains filtered or unexported fields }
type GetDocumentOutput ¶
type GetDocumentOutput struct { // A description of the document attachments, including names, locations, sizes, // and so on. AttachmentsContent []types.AttachmentContent // The contents of the SSM document. Content *string // The date the SSM document was created. CreatedDate *time.Time // The friendly name of the SSM document. This value can differ for each version // of the document. If you want to update this value, see UpdateDocument . DisplayName *string // The document format, either JSON or YAML. DocumentFormat types.DocumentFormat // The document type. DocumentType types.DocumentType // The document version. DocumentVersion *string // The name of the SSM document. Name *string // A list of SSM documents required by a document. For example, an // ApplicationConfiguration document requires an ApplicationConfigurationSchema // document. Requires []types.DocumentRequires // The current review status of a new custom Systems Manager document (SSM // document) created by a member of your organization, or of the latest version of // an existing SSM document. Only one version of an SSM document can be in the // APPROVED state at a time. When a new version is approved, the status of the // previous version changes to REJECTED. Only one version of an SSM document can be // in review, or PENDING, at a time. ReviewStatus types.ReviewStatus // The status of the SSM document, such as Creating , Active , Updating , Failed , // and Deleting . Status types.DocumentStatus // A message returned by Amazon Web Services Systems Manager that explains the // Status value. For example, a Failed status might be explained by the // StatusInformation message, "The specified S3 bucket doesn't exist. Verify that // the URL of the S3 bucket is correct." StatusInformation *string // The version of the artifact associated with the document. For example, "Release // 12, Update 6". This value is unique across all versions of a document, and can't // be changed. VersionName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetInventoryAPIClient ¶ added in v0.30.0
type GetInventoryAPIClient interface {
GetInventory(context.Context, *GetInventoryInput, ...func(*Options)) (*GetInventoryOutput, error)
}
GetInventoryAPIClient is a client that implements the GetInventory operation.
type GetInventoryInput ¶
type GetInventoryInput struct { // Returns counts of inventory types based on one or more expressions. For // example, if you aggregate by using an expression that uses the // AWS:InstanceInformation.PlatformType type, you can see a count of how many // Windows and Linux managed nodes exist in your inventoried fleet. Aggregators []types.InventoryAggregator // One or more filters. Use a filter to return a more specific list of results. Filters []types.InventoryFilter // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string // The list of inventory item types to return. ResultAttributes []types.ResultAttribute // contains filtered or unexported fields }
type GetInventoryOutput ¶
type GetInventoryOutput struct { // Collection of inventory entities such as a collection of managed node inventory. Entities []types.InventoryResultEntity // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetInventoryPaginator ¶ added in v0.30.0
type GetInventoryPaginator struct {
// contains filtered or unexported fields
}
GetInventoryPaginator is a paginator for GetInventory
func NewGetInventoryPaginator ¶ added in v0.30.0
func NewGetInventoryPaginator(client GetInventoryAPIClient, params *GetInventoryInput, optFns ...func(*GetInventoryPaginatorOptions)) *GetInventoryPaginator
NewGetInventoryPaginator returns a new GetInventoryPaginator
func (*GetInventoryPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetInventoryPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetInventoryPaginator) NextPage ¶ added in v0.30.0
func (p *GetInventoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInventoryOutput, error)
NextPage retrieves the next GetInventory page.
type GetInventoryPaginatorOptions ¶ added in v0.30.0
type GetInventoryPaginatorOptions 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 }
GetInventoryPaginatorOptions is the paginator options for GetInventory
type GetInventorySchemaAPIClient ¶ added in v0.30.0
type GetInventorySchemaAPIClient interface {
GetInventorySchema(context.Context, *GetInventorySchemaInput, ...func(*Options)) (*GetInventorySchemaOutput, error)
}
GetInventorySchemaAPIClient is a client that implements the GetInventorySchema operation.
type GetInventorySchemaInput ¶
type GetInventorySchemaInput struct { // Returns inventory schemas that support aggregation. For example, this call // returns the AWS:InstanceInformation type, because it supports aggregation based // on the PlatformName , PlatformType , and PlatformVersion attributes. Aggregator bool // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string // Returns the sub-type schema for a specified inventory type. SubType *bool // The type of inventory item to return. TypeName *string // contains filtered or unexported fields }
type GetInventorySchemaOutput ¶
type GetInventorySchemaOutput 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 // Inventory schemas returned by the request. Schemas []types.InventoryItemSchema // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetInventorySchemaPaginator ¶ added in v0.30.0
type GetInventorySchemaPaginator struct {
// contains filtered or unexported fields
}
GetInventorySchemaPaginator is a paginator for GetInventorySchema
func NewGetInventorySchemaPaginator ¶ added in v0.30.0
func NewGetInventorySchemaPaginator(client GetInventorySchemaAPIClient, params *GetInventorySchemaInput, optFns ...func(*GetInventorySchemaPaginatorOptions)) *GetInventorySchemaPaginator
NewGetInventorySchemaPaginator returns a new GetInventorySchemaPaginator
func (*GetInventorySchemaPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetInventorySchemaPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetInventorySchemaPaginator) NextPage ¶ added in v0.30.0
func (p *GetInventorySchemaPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInventorySchemaOutput, error)
NextPage retrieves the next GetInventorySchema page.
type GetInventorySchemaPaginatorOptions ¶ added in v0.30.0
type GetInventorySchemaPaginatorOptions 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 }
GetInventorySchemaPaginatorOptions is the paginator options for GetInventorySchema
type GetMaintenanceWindowExecutionInput ¶
type GetMaintenanceWindowExecutionInput struct { // The ID of the maintenance window execution that includes the task. // // This member is required. WindowExecutionId *string // contains filtered or unexported fields }
type GetMaintenanceWindowExecutionOutput ¶
type GetMaintenanceWindowExecutionOutput struct { // The time the maintenance window finished running. EndTime *time.Time // The time the maintenance window started running. StartTime *time.Time // The status of the maintenance window execution. Status types.MaintenanceWindowExecutionStatus // The details explaining the status. Not available for all status values. StatusDetails *string // The ID of the task executions from the maintenance window execution. TaskIds []string // The ID of the maintenance window execution. WindowExecutionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMaintenanceWindowExecutionTaskInput ¶
type GetMaintenanceWindowExecutionTaskInput struct { // The ID of the specific task execution in the maintenance window task that // should be retrieved. // // This member is required. TaskId *string // The ID of the maintenance window execution that includes the task. // // This member is required. WindowExecutionId *string // contains filtered or unexported fields }
type GetMaintenanceWindowExecutionTaskInvocationInput ¶
type GetMaintenanceWindowExecutionTaskInvocationInput struct { // The invocation ID to retrieve. // // This member is required. InvocationId *string // 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 for which the task is a part. // // This member is required. WindowExecutionId *string // contains filtered or unexported fields }
type GetMaintenanceWindowExecutionTaskInvocationOutput ¶
type GetMaintenanceWindowExecutionTaskInvocationOutput struct { // The time that the task finished running on the target. EndTime *time.Time // The execution ID. ExecutionId *string // The invocation ID. InvocationId *string // User-provided value to be included in any Amazon CloudWatch Events or Amazon // EventBridge events raised while running tasks for these targets in this // maintenance window. OwnerInformation *string // The parameters used at the time that the task ran. Parameters *string // The time that the task started running on the target. StartTime *time.Time // The task status for an invocation. Status types.MaintenanceWindowExecutionStatus // The details explaining the status. Details are only available for certain // status values. StatusDetails *string // The task execution ID. TaskExecutionId *string // Retrieves the task type for a maintenance window. TaskType types.MaintenanceWindowTaskType // The maintenance window execution ID. WindowExecutionId *string // The maintenance window target ID. WindowTargetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMaintenanceWindowExecutionTaskOutput ¶
type GetMaintenanceWindowExecutionTaskOutput struct { // The details for the CloudWatch alarm you applied to your maintenance window // task. AlarmConfiguration *types.AlarmConfiguration // The time the task execution completed. EndTime *time.Time // The defined maximum number of task executions that could be run in parallel. MaxConcurrency *string // The defined maximum number of task execution errors allowed before scheduling // of the task execution would have been stopped. MaxErrors *string // The priority of the task. Priority int32 // The role that was assumed when running the task. ServiceRole *string // The time the task execution started. StartTime *time.Time // The status of the task. Status types.MaintenanceWindowExecutionStatus // The details explaining the status. Not available for all status values. StatusDetails *string // The Amazon Resource Name (ARN) of the task that ran. TaskArn *string // The ID of the specific task execution in the maintenance window task that was // retrieved. TaskExecutionId *string // The parameters passed to the task when it was run. TaskParameters has been // deprecated. To specify parameters to pass to a task when it runs, instead use // the Parameters option in the TaskInvocationParameters structure. For // information about how Systems Manager handles these options for the supported // maintenance window task types, see MaintenanceWindowTaskInvocationParameters . // The map has the following format: // - Key : string, between 1 and 255 characters // - Value : an array of strings, each between 1 and 255 characters TaskParameters []map[string]types.MaintenanceWindowTaskParameterValueExpression // The CloudWatch alarms that were invoked by the maintenance window task. TriggeredAlarms []types.AlarmStateInformation // The type of task that was run. Type types.MaintenanceWindowTaskType // The ID of the maintenance window execution that includes the task. WindowExecutionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMaintenanceWindowInput ¶
type GetMaintenanceWindowInput struct { // The ID of the maintenance window for which you want to retrieve information. // // This member is required. WindowId *string // contains filtered or unexported fields }
type GetMaintenanceWindowOutput ¶
type GetMaintenanceWindowOutput struct { // Whether targets must be registered with the maintenance window before tasks can // be defined for those targets. AllowUnassociatedTargets bool // The date the maintenance window was created. CreatedDate *time.Time // The number of hours before the end of the maintenance window that Amazon Web // Services Systems Manager stops scheduling new tasks for execution. Cutoff int32 // The description of the maintenance window. Description *string // The duration of the maintenance window in hours. Duration int32 // Indicates whether the maintenance window is enabled. Enabled bool // The date and time, in ISO-8601 Extended format, for when the maintenance window // is scheduled to become inactive. The maintenance window won't run after this // specified time. EndDate *string // The date the maintenance window was last modified. ModifiedDate *time.Time // The name of the maintenance window. Name *string // The next time the maintenance window will actually run, taking into account any // specified times for the maintenance window to become active or inactive. NextExecutionTime *string // The schedule of the maintenance window in the form of a cron or rate expression. Schedule *string // The number of days to wait to run a maintenance window after the scheduled cron // expression date and time. 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 the maintenance window // is scheduled to become active. The maintenance window won't run before this // specified time. StartDate *string // The ID of the created maintenance window. WindowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMaintenanceWindowTaskOutput ¶
type GetMaintenanceWindowTaskOutput struct { // The details for the CloudWatch alarm you applied to your maintenance window // task. AlarmConfiguration *types.AlarmConfiguration // The action to take on tasks when the maintenance window cutoff time is reached. // CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step // Functions tasks, CANCEL_TASK means that currently running task invocations // continue, but no new task invocations are started. For Run Command tasks, // CANCEL_TASK means the system attempts to stop the task by sending a // CancelCommand operation. CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior // The retrieved task description. Description *string // The location in Amazon Simple Storage Service (Amazon S3) where the task // results are logged. LoggingInfo has been deprecated. To specify an Amazon // Simple Storage Service (Amazon S3) bucket to contain logs, instead use the // OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters // structure. For information about how Amazon Web Services Systems Manager handles // these options for the supported maintenance window task types, see // MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The maximum number of targets allowed to run this task in parallel. For // maintenance window tasks without a target specified, you can't supply a value // for this option. Instead, the system inserts a placeholder value of 1 , which // may be reported in the response to this command. This value doesn't affect the // running of your task and can be ignored. MaxConcurrency *string // The maximum number of errors allowed before the task stops being scheduled. For // maintenance window tasks without a target specified, you can't supply a value // for this option. Instead, the system inserts a placeholder value of 1 , which // may be reported in the response to this command. This value doesn't affect the // running of your task and can be ignored. MaxErrors *string // The retrieved task name. Name *string // The priority of the task when it runs. The lower the number, the higher the // priority. Tasks that have the same priority are scheduled in parallel. Priority int32 // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // service role to use to publish Amazon Simple Notification Service (Amazon SNS) // notifications for maintenance window Run Command tasks. ServiceRoleArn *string // The targets where the task should run. Targets []types.Target // The resource that the task used during execution. For RUN_COMMAND and AUTOMATION // task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA // tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value // is the state machine ARN. TaskArn *string // The parameters to pass to the task when it runs. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters // The parameters to pass to the task when it runs. TaskParameters has been // deprecated. To specify parameters to pass to a task when it runs, instead use // the Parameters option in the TaskInvocationParameters structure. For // information about how Systems Manager handles these options for the supported // maintenance window task types, see MaintenanceWindowTaskInvocationParameters . TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression // The type of task to run. TaskType types.MaintenanceWindowTaskType // The retrieved maintenance window ID. WindowId *string // The retrieved maintenance window task ID. WindowTaskId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOpsItemInput ¶
type GetOpsItemOutput ¶
type GetOpsItemOutput struct { // The OpsItem. OpsItem *types.OpsItem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOpsMetadataInput ¶ added in v0.31.0
type GetOpsMetadataInput struct { // The Amazon Resource Name (ARN) of an OpsMetadata Object to view. // // This member is required. OpsMetadataArn *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 // contains filtered or unexported fields }
type GetOpsMetadataOutput ¶ added in v0.31.0
type GetOpsMetadataOutput struct { // OpsMetadata for an Application Manager application. Metadata map[string]types.MetadataValue // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // The resource ID of the Application Manager application. ResourceId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOpsSummaryAPIClient ¶ added in v0.30.0
type GetOpsSummaryAPIClient interface {
GetOpsSummary(context.Context, *GetOpsSummaryInput, ...func(*Options)) (*GetOpsSummaryOutput, error)
}
GetOpsSummaryAPIClient is a client that implements the GetOpsSummary operation.
type GetOpsSummaryInput ¶
type GetOpsSummaryInput struct { // Optional aggregators that return counts of OpsData based on one or more // expressions. Aggregators []types.OpsAggregator // Optional filters used to scope down the returned OpsData. Filters []types.OpsFilter // 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 // The OpsData data type to return. ResultAttributes []types.OpsResultAttribute // Specify the name of a resource data sync to get. SyncName *string // contains filtered or unexported fields }
type GetOpsSummaryOutput ¶
type GetOpsSummaryOutput struct { // The list of aggregated details and filtered OpsData. Entities []types.OpsEntity // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOpsSummaryPaginator ¶ added in v0.30.0
type GetOpsSummaryPaginator struct {
// contains filtered or unexported fields
}
GetOpsSummaryPaginator is a paginator for GetOpsSummary
func NewGetOpsSummaryPaginator ¶ added in v0.30.0
func NewGetOpsSummaryPaginator(client GetOpsSummaryAPIClient, params *GetOpsSummaryInput, optFns ...func(*GetOpsSummaryPaginatorOptions)) *GetOpsSummaryPaginator
NewGetOpsSummaryPaginator returns a new GetOpsSummaryPaginator
func (*GetOpsSummaryPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetOpsSummaryPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetOpsSummaryPaginator) NextPage ¶ added in v0.30.0
func (p *GetOpsSummaryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetOpsSummaryOutput, error)
NextPage retrieves the next GetOpsSummary page.
type GetOpsSummaryPaginatorOptions ¶ added in v0.30.0
type GetOpsSummaryPaginatorOptions 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 }
GetOpsSummaryPaginatorOptions is the paginator options for GetOpsSummary
type GetParameterHistoryAPIClient ¶ added in v0.30.0
type GetParameterHistoryAPIClient interface {
GetParameterHistory(context.Context, *GetParameterHistoryInput, ...func(*Options)) (*GetParameterHistoryOutput, error)
}
GetParameterHistoryAPIClient is a client that implements the GetParameterHistory operation.
type GetParameterHistoryInput ¶
type GetParameterHistoryInput struct { // The name of the parameter for which you want to review history. // // This member is required. Name *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 // Return decrypted values for secure string parameters. This flag is ignored for // String and StringList parameter types. WithDecryption *bool // contains filtered or unexported fields }
type GetParameterHistoryOutput ¶
type GetParameterHistoryOutput 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 parameters returned by the request. Parameters []types.ParameterHistory // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetParameterHistoryPaginator ¶ added in v0.30.0
type GetParameterHistoryPaginator struct {
// contains filtered or unexported fields
}
GetParameterHistoryPaginator is a paginator for GetParameterHistory
func NewGetParameterHistoryPaginator ¶ added in v0.30.0
func NewGetParameterHistoryPaginator(client GetParameterHistoryAPIClient, params *GetParameterHistoryInput, optFns ...func(*GetParameterHistoryPaginatorOptions)) *GetParameterHistoryPaginator
NewGetParameterHistoryPaginator returns a new GetParameterHistoryPaginator
func (*GetParameterHistoryPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetParameterHistoryPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetParameterHistoryPaginator) NextPage ¶ added in v0.30.0
func (p *GetParameterHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetParameterHistoryOutput, error)
NextPage retrieves the next GetParameterHistory page.
type GetParameterHistoryPaginatorOptions ¶ added in v0.30.0
type GetParameterHistoryPaginatorOptions 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 }
GetParameterHistoryPaginatorOptions is the paginator options for GetParameterHistory
type GetParameterInput ¶
type GetParameterInput struct { // The name of the parameter you want to query. To query by parameter label, use // "Name": "name:label" . To query by parameter version, use "Name": "name:version" // . // // This member is required. Name *string // Return decrypted values for secure string parameters. This flag is ignored for // String and StringList parameter types. WithDecryption *bool // contains filtered or unexported fields }
type GetParameterOutput ¶
type GetParameterOutput struct { // Information about a parameter. Parameter *types.Parameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetParametersByPathAPIClient ¶ added in v0.30.0
type GetParametersByPathAPIClient interface {
GetParametersByPath(context.Context, *GetParametersByPathInput, ...func(*Options)) (*GetParametersByPathOutput, error)
}
GetParametersByPathAPIClient is a client that implements the GetParametersByPath operation.
type GetParametersByPathInput ¶
type GetParametersByPathInput struct { // The hierarchy for the parameter. Hierarchies start with a forward slash (/). // The hierarchy is the parameter name except the last part of the parameter. For // the API call to succeed, the last part of the parameter name can't be in the // path. A parameter name hierarchy can have a maximum of 15 levels. Here is an // example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33 // // This member is required. Path *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 // Filters to limit the request results. The following Key values are supported // for GetParametersByPath : Type , KeyId , and Label . The following Key values // aren't supported for GetParametersByPath : tag , DataType , Name , Path , and // Tier . ParameterFilters []types.ParameterStringFilter // Retrieve all parameters within a hierarchy. If a user has access to a path, // then the user can access all levels of that path. For example, if a user has // permission to access path /a , then the user can also access /a/b . Even if a // user has explicitly been denied access in IAM for parameter /a/b , they can // still call the GetParametersByPath API operation recursively for /a and view // /a/b . Recursive *bool // Retrieve all parameters in a hierarchy with their value decrypted. WithDecryption *bool // contains filtered or unexported fields }
type GetParametersByPathOutput ¶
type GetParametersByPathOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // A list of parameters found in the specified hierarchy. Parameters []types.Parameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetParametersByPathPaginator ¶ added in v0.30.0
type GetParametersByPathPaginator struct {
// contains filtered or unexported fields
}
GetParametersByPathPaginator is a paginator for GetParametersByPath
func NewGetParametersByPathPaginator ¶ added in v0.30.0
func NewGetParametersByPathPaginator(client GetParametersByPathAPIClient, params *GetParametersByPathInput, optFns ...func(*GetParametersByPathPaginatorOptions)) *GetParametersByPathPaginator
NewGetParametersByPathPaginator returns a new GetParametersByPathPaginator
func (*GetParametersByPathPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetParametersByPathPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetParametersByPathPaginator) NextPage ¶ added in v0.30.0
func (p *GetParametersByPathPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetParametersByPathOutput, error)
NextPage retrieves the next GetParametersByPath page.
type GetParametersByPathPaginatorOptions ¶ added in v0.30.0
type GetParametersByPathPaginatorOptions 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 }
GetParametersByPathPaginatorOptions is the paginator options for GetParametersByPath
type GetParametersInput ¶
type GetParametersInput struct { // Names of the parameters for which you want to query information. To query by // parameter label, use "Name": "name:label" . To query by parameter version, use // "Name": "name:version" . // // This member is required. Names []string // Return decrypted secure string value. Return decrypted values for secure string // parameters. This flag is ignored for String and StringList parameter types. WithDecryption *bool // contains filtered or unexported fields }
type GetParametersOutput ¶
type GetParametersOutput struct { // A list of parameters that aren't formatted correctly or don't run during an // execution. InvalidParameters []string // A list of details for a parameter. Parameters []types.Parameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetPatchBaselineForPatchGroupInput ¶
type GetPatchBaselineForPatchGroupInput struct { // The name of the patch group whose patch baseline should be retrieved. // // This member is required. PatchGroup *string // Returns the operating system rule specified for patch groups using the patch // baseline. OperatingSystem types.OperatingSystem // contains filtered or unexported fields }
type GetPatchBaselineForPatchGroupOutput ¶
type GetPatchBaselineForPatchGroupOutput struct { // The ID of the patch baseline that should be used for the patch group. BaselineId *string // The operating system rule specified for patch groups using the patch baseline. OperatingSystem types.OperatingSystem // The name of the patch group. PatchGroup *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetPatchBaselineInput ¶
type GetPatchBaselineInput struct { // The ID of the patch baseline to retrieve. To retrieve information about an // Amazon Web Services managed patch baseline, specify the full Amazon Resource // Name (ARN) of the baseline. For example, for the baseline // AWS-AmazonLinuxDefaultPatchBaseline , specify // arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of // pb-0e392de35e7c563b7 . // // This member is required. BaselineId *string // contains filtered or unexported fields }
type GetPatchBaselineOutput ¶
type GetPatchBaselineOutput struct { // A set of rules used to include patches in the baseline. ApprovalRules *types.PatchRuleGroup // A list of explicitly approved patches for the baseline. ApprovedPatches []string // Returns the specified compliance severity level for approved patches in the // patch baseline. ApprovedPatchesComplianceLevel types.PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates // that should be applied to the managed nodes. The default value is false . // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity *bool // The ID of the retrieved patch baseline. BaselineId *string // The date the patch baseline was created. CreatedDate *time.Time // A description of the patch baseline. Description *string // A set of global filters used to exclude patches from the baseline. GlobalFilters *types.PatchFilterGroup // The date the patch baseline was last modified. ModifiedDate *time.Time // The name of the patch baseline. Name *string // Returns the operating system specified for the patch baseline. OperatingSystem types.OperatingSystem // Patch groups included in the patch baseline. PatchGroups []string // A list of explicitly rejected patches for the baseline. RejectedPatches []string // The action specified to take on patches included in the RejectedPatches list. A // patch can be allowed only if it is a dependency of another package, or blocked // entirely along with packages that include it as a dependency. RejectedPatchesAction types.PatchAction // Information about the patches to use to update the managed nodes, including // target operating systems and source repositories. Applies to Linux managed nodes // only. Sources []types.PatchSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourcePoliciesAPIClient ¶ added in v1.33.0
type GetResourcePoliciesAPIClient interface {
GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error)
}
GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies operation.
type GetResourcePoliciesInput ¶ added in v1.33.0
type GetResourcePoliciesInput struct { // Amazon Resource Name (ARN) of the resource to which the policies are attached. // // This member is required. ResourceArn *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 // contains filtered or unexported fields }
type GetResourcePoliciesOutput ¶ added in v1.33.0
type GetResourcePoliciesOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // An array of the Policy object. Policies []types.GetResourcePoliciesResponseEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourcePoliciesPaginator ¶ added in v1.33.0
type GetResourcePoliciesPaginator struct {
// contains filtered or unexported fields
}
GetResourcePoliciesPaginator is a paginator for GetResourcePolicies
func NewGetResourcePoliciesPaginator ¶ added in v1.33.0
func NewGetResourcePoliciesPaginator(client GetResourcePoliciesAPIClient, params *GetResourcePoliciesInput, optFns ...func(*GetResourcePoliciesPaginatorOptions)) *GetResourcePoliciesPaginator
NewGetResourcePoliciesPaginator returns a new GetResourcePoliciesPaginator
func (*GetResourcePoliciesPaginator) HasMorePages ¶ added in v1.33.0
func (p *GetResourcePoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourcePoliciesPaginator) NextPage ¶ added in v1.33.0
func (p *GetResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
NextPage retrieves the next GetResourcePolicies page.
type GetResourcePoliciesPaginatorOptions ¶ added in v1.33.0
type GetResourcePoliciesPaginatorOptions 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 }
GetResourcePoliciesPaginatorOptions is the paginator options for GetResourcePolicies
type GetServiceSettingInput ¶
type GetServiceSettingInput struct { // The ID of the service setting to get. The setting ID can be one of the // following. // - /ssm/managed-instance/default-ec2-instance-management-role // - /ssm/automation/customer-script-log-destination // - /ssm/automation/customer-script-log-group-name // - /ssm/documents/console/public-sharing-permission // - /ssm/managed-instance/activation-tier // - /ssm/opsinsights/opscenter // - /ssm/parameter-store/default-parameter-tier // - /ssm/parameter-store/high-throughput-enabled // // This member is required. SettingId *string // contains filtered or unexported fields }
The request body of the GetServiceSetting API operation.
type GetServiceSettingOutput ¶
type GetServiceSettingOutput struct { // The query result of the current service setting. ServiceSetting *types.ServiceSetting // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The query result body of the GetServiceSetting API operation.
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type LabelParameterVersionInput ¶
type LabelParameterVersionInput struct { // One or more labels to attach to the specified parameter version. // // This member is required. Labels []string // The parameter name on which you want to attach one or more labels. // // This member is required. Name *string // The specific version of the parameter on which you want to attach one or more // labels. If no version is specified, the system attaches the label to the latest // version. ParameterVersion *int64 // contains filtered or unexported fields }
type LabelParameterVersionOutput ¶
type LabelParameterVersionOutput struct { // The label doesn't meet the requirements. For information about parameter label // requirements, see Labeling parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html) // in the Amazon Web Services Systems Manager User Guide. InvalidLabels []string // The version of the parameter that has been labeled. ParameterVersion int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAssociationVersionsAPIClient ¶ added in v0.30.0
type ListAssociationVersionsAPIClient interface {
ListAssociationVersions(context.Context, *ListAssociationVersionsInput, ...func(*Options)) (*ListAssociationVersionsOutput, error)
}
ListAssociationVersionsAPIClient is a client that implements the ListAssociationVersions operation.
type ListAssociationVersionsInput ¶
type ListAssociationVersionsInput struct { // The association ID for which you want to view all versions. // // This member is required. AssociationId *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 // contains filtered or unexported fields }
type ListAssociationVersionsOutput ¶
type ListAssociationVersionsOutput struct { // Information about all versions of the association for the specified association // ID. AssociationVersions []types.AssociationVersionInfo // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAssociationVersionsPaginator ¶ added in v0.30.0
type ListAssociationVersionsPaginator struct {
// contains filtered or unexported fields
}
ListAssociationVersionsPaginator is a paginator for ListAssociationVersions
func NewListAssociationVersionsPaginator ¶ added in v0.30.0
func NewListAssociationVersionsPaginator(client ListAssociationVersionsAPIClient, params *ListAssociationVersionsInput, optFns ...func(*ListAssociationVersionsPaginatorOptions)) *ListAssociationVersionsPaginator
NewListAssociationVersionsPaginator returns a new ListAssociationVersionsPaginator
func (*ListAssociationVersionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListAssociationVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssociationVersionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListAssociationVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssociationVersionsOutput, error)
NextPage retrieves the next ListAssociationVersions page.
type ListAssociationVersionsPaginatorOptions ¶ added in v0.30.0
type ListAssociationVersionsPaginatorOptions 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 }
ListAssociationVersionsPaginatorOptions is the paginator options for ListAssociationVersions
type ListAssociationsAPIClient ¶ added in v0.30.0
type ListAssociationsAPIClient interface {
ListAssociations(context.Context, *ListAssociationsInput, ...func(*Options)) (*ListAssociationsOutput, error)
}
ListAssociationsAPIClient is a client that implements the ListAssociations operation.
type ListAssociationsInput ¶
type ListAssociationsInput struct { // One or more filters. Use a filter to return a more specific list of results. // Filtering associations using the InstanceID attribute only returns legacy // associations created using the InstanceID attribute. Associations targeting the // managed node that are part of the Target Attributes ResourceGroup or Tags // aren't returned. AssociationFilterList []types.AssociationFilter // 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 // contains filtered or unexported fields }
type ListAssociationsOutput ¶
type ListAssociationsOutput struct { // The associations. Associations []types.Association // 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 // contains filtered or unexported fields }
type ListAssociationsPaginator ¶ added in v0.30.0
type ListAssociationsPaginator struct {
// contains filtered or unexported fields
}
ListAssociationsPaginator is a paginator for ListAssociations
func NewListAssociationsPaginator ¶ added in v0.30.0
func NewListAssociationsPaginator(client ListAssociationsAPIClient, params *ListAssociationsInput, optFns ...func(*ListAssociationsPaginatorOptions)) *ListAssociationsPaginator
NewListAssociationsPaginator returns a new ListAssociationsPaginator
func (*ListAssociationsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssociationsPaginator) NextPage ¶ added in v0.30.0
func (p *ListAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssociationsOutput, error)
NextPage retrieves the next ListAssociations page.
type ListAssociationsPaginatorOptions ¶ added in v0.30.0
type ListAssociationsPaginatorOptions 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 }
ListAssociationsPaginatorOptions is the paginator options for ListAssociations
type ListCommandInvocationsAPIClient ¶ added in v0.30.0
type ListCommandInvocationsAPIClient interface {
ListCommandInvocations(context.Context, *ListCommandInvocationsInput, ...func(*Options)) (*ListCommandInvocationsOutput, error)
}
ListCommandInvocationsAPIClient is a client that implements the ListCommandInvocations operation.
type ListCommandInvocationsInput ¶
type ListCommandInvocationsInput struct { // (Optional) The invocations for a specific command ID. CommandId *string // (Optional) If set this returns the response of the command executions and any // command output. The default value is false . Details bool // (Optional) One or more filters. Use a filter to return a more specific list of // results. Filters []types.CommandFilter // (Optional) The command execution details for a specific managed node ID. InstanceId *string // (Optional) The maximum number of items to return for this call. The call also // returns a token that you can specify in a subsequent call to get the next set of // results. MaxResults *int32 // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string // contains filtered or unexported fields }
type ListCommandInvocationsOutput ¶
type ListCommandInvocationsOutput struct { // (Optional) A list of all invocations. CommandInvocations []types.CommandInvocation // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListCommandInvocationsPaginator ¶ added in v0.30.0
type ListCommandInvocationsPaginator struct {
// contains filtered or unexported fields
}
ListCommandInvocationsPaginator is a paginator for ListCommandInvocations
func NewListCommandInvocationsPaginator ¶ added in v0.30.0
func NewListCommandInvocationsPaginator(client ListCommandInvocationsAPIClient, params *ListCommandInvocationsInput, optFns ...func(*ListCommandInvocationsPaginatorOptions)) *ListCommandInvocationsPaginator
NewListCommandInvocationsPaginator returns a new ListCommandInvocationsPaginator
func (*ListCommandInvocationsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListCommandInvocationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListCommandInvocationsPaginator) NextPage ¶ added in v0.30.0
func (p *ListCommandInvocationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCommandInvocationsOutput, error)
NextPage retrieves the next ListCommandInvocations page.
type ListCommandInvocationsPaginatorOptions ¶ added in v0.30.0
type ListCommandInvocationsPaginatorOptions struct { // (Optional) The maximum number of items to return for this call. The call also // returns a token that you can specify in a subsequent call to get the next set of // results. 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 }
ListCommandInvocationsPaginatorOptions is the paginator options for ListCommandInvocations
type ListCommandsAPIClient ¶ added in v0.30.0
type ListCommandsAPIClient interface {
ListCommands(context.Context, *ListCommandsInput, ...func(*Options)) (*ListCommandsOutput, error)
}
ListCommandsAPIClient is a client that implements the ListCommands operation.
type ListCommandsInput ¶
type ListCommandsInput struct { // (Optional) If provided, lists only the specified command. CommandId *string // (Optional) One or more filters. Use a filter to return a more specific list of // results. Filters []types.CommandFilter // (Optional) Lists commands issued against this managed node ID. You can't // specify a managed node ID in the same command that you specify Status = Pending // . This is because the command hasn't reached the managed node yet. InstanceId *string // (Optional) The maximum number of items to return for this call. The call also // returns a token that you can specify in a subsequent call to get the next set of // results. MaxResults *int32 // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string // contains filtered or unexported fields }
type ListCommandsOutput ¶
type ListCommandsOutput struct { // (Optional) The list of commands requested by the user. Commands []types.Command // (Optional) The token for the next set of items to return. (You received this // token from a previous call.) NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListCommandsPaginator ¶ added in v0.30.0
type ListCommandsPaginator struct {
// contains filtered or unexported fields
}
ListCommandsPaginator is a paginator for ListCommands
func NewListCommandsPaginator ¶ added in v0.30.0
func NewListCommandsPaginator(client ListCommandsAPIClient, params *ListCommandsInput, optFns ...func(*ListCommandsPaginatorOptions)) *ListCommandsPaginator
NewListCommandsPaginator returns a new ListCommandsPaginator
func (*ListCommandsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListCommandsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListCommandsPaginator) NextPage ¶ added in v0.30.0
func (p *ListCommandsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCommandsOutput, error)
NextPage retrieves the next ListCommands page.
type ListCommandsPaginatorOptions ¶ added in v0.30.0
type ListCommandsPaginatorOptions struct { // (Optional) The maximum number of items to return for this call. The call also // returns a token that you can specify in a subsequent call to get the next set of // results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListCommandsPaginatorOptions is the paginator options for ListCommands
type ListComplianceItemsAPIClient ¶ added in v0.30.0
type ListComplianceItemsAPIClient interface {
ListComplianceItems(context.Context, *ListComplianceItemsInput, ...func(*Options)) (*ListComplianceItemsOutput, error)
}
ListComplianceItemsAPIClient is a client that implements the ListComplianceItems operation.
type ListComplianceItemsInput ¶
type ListComplianceItemsInput struct { // One or more compliance filters. Use a filter to return a more specific list of // results. Filters []types.ComplianceStringFilter // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string // The ID for the resources from which to get compliance information. Currently, // you can only specify one resource ID. ResourceIds []string // The type of resource from which to get compliance information. Currently, the // only supported resource type is ManagedInstance . ResourceTypes []string // contains filtered or unexported fields }
type ListComplianceItemsOutput ¶
type ListComplianceItemsOutput struct { // A list of compliance information for the specified resource ID. ComplianceItems []types.ComplianceItem // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListComplianceItemsPaginator ¶ added in v0.30.0
type ListComplianceItemsPaginator struct {
// contains filtered or unexported fields
}
ListComplianceItemsPaginator is a paginator for ListComplianceItems
func NewListComplianceItemsPaginator ¶ added in v0.30.0
func NewListComplianceItemsPaginator(client ListComplianceItemsAPIClient, params *ListComplianceItemsInput, optFns ...func(*ListComplianceItemsPaginatorOptions)) *ListComplianceItemsPaginator
NewListComplianceItemsPaginator returns a new ListComplianceItemsPaginator
func (*ListComplianceItemsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListComplianceItemsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListComplianceItemsPaginator) NextPage ¶ added in v0.30.0
func (p *ListComplianceItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListComplianceItemsOutput, error)
NextPage retrieves the next ListComplianceItems page.
type ListComplianceItemsPaginatorOptions ¶ added in v0.30.0
type ListComplianceItemsPaginatorOptions 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 }
ListComplianceItemsPaginatorOptions is the paginator options for ListComplianceItems
type ListComplianceSummariesAPIClient ¶ added in v0.30.0
type ListComplianceSummariesAPIClient interface {
ListComplianceSummaries(context.Context, *ListComplianceSummariesInput, ...func(*Options)) (*ListComplianceSummariesOutput, error)
}
ListComplianceSummariesAPIClient is a client that implements the ListComplianceSummaries operation.
type ListComplianceSummariesInput ¶
type ListComplianceSummariesInput struct { // One or more compliance or inventory filters. Use a filter to return a more // specific list of results. Filters []types.ComplianceStringFilter // The maximum number of items to return for this call. Currently, you can specify // null or 50. The call also returns a token that you can specify in a subsequent // call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListComplianceSummariesOutput ¶
type ListComplianceSummariesOutput struct { // A list of compliant and non-compliant summary counts based on compliance types. // For example, this call returns State Manager associations, patches, or custom // compliance types according to the filter criteria that you specified. ComplianceSummaryItems []types.ComplianceSummaryItem // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListComplianceSummariesPaginator ¶ added in v0.30.0
type ListComplianceSummariesPaginator struct {
// contains filtered or unexported fields
}
ListComplianceSummariesPaginator is a paginator for ListComplianceSummaries
func NewListComplianceSummariesPaginator ¶ added in v0.30.0
func NewListComplianceSummariesPaginator(client ListComplianceSummariesAPIClient, params *ListComplianceSummariesInput, optFns ...func(*ListComplianceSummariesPaginatorOptions)) *ListComplianceSummariesPaginator
NewListComplianceSummariesPaginator returns a new ListComplianceSummariesPaginator
func (*ListComplianceSummariesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListComplianceSummariesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListComplianceSummariesPaginator) NextPage ¶ added in v0.30.0
func (p *ListComplianceSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListComplianceSummariesOutput, error)
NextPage retrieves the next ListComplianceSummaries page.
type ListComplianceSummariesPaginatorOptions ¶ added in v0.30.0
type ListComplianceSummariesPaginatorOptions struct { // The maximum number of items to return for this call. Currently, you can specify // null or 50. The call also returns a token that you can specify in a subsequent // call to get the next set of results. 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 }
ListComplianceSummariesPaginatorOptions is the paginator options for ListComplianceSummaries
type ListDocumentMetadataHistoryInput ¶ added in v0.31.0
type ListDocumentMetadataHistoryInput struct { // The type of data for which details are being requested. Currently, the only // supported value is DocumentReviews . // // This member is required. Metadata types.DocumentMetadataEnum // The name of the change template. // // This member is required. Name *string // The version of the change template. DocumentVersion *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 // contains filtered or unexported fields }
type ListDocumentMetadataHistoryOutput ¶ added in v0.31.0
type ListDocumentMetadataHistoryOutput struct { // The user ID of the person in the organization who requested the review of the // change template. Author *string // The version of the change template. DocumentVersion *string // Information about the response to the change template approval request. Metadata *types.DocumentMetadataResponseInfo // The name of the change template. Name *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. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDocumentVersionsAPIClient ¶ added in v0.30.0
type ListDocumentVersionsAPIClient interface {
ListDocumentVersions(context.Context, *ListDocumentVersionsInput, ...func(*Options)) (*ListDocumentVersionsOutput, error)
}
ListDocumentVersionsAPIClient is a client that implements the ListDocumentVersions operation.
type ListDocumentVersionsInput ¶
type ListDocumentVersionsInput struct { // The name of the document. You can specify an Amazon Resource Name (ARN). // // This member is required. Name *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 // contains filtered or unexported fields }
type ListDocumentVersionsOutput ¶
type ListDocumentVersionsOutput struct { // The document versions. DocumentVersions []types.DocumentVersionInfo // 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 // contains filtered or unexported fields }
type ListDocumentVersionsPaginator ¶ added in v0.30.0
type ListDocumentVersionsPaginator struct {
// contains filtered or unexported fields
}
ListDocumentVersionsPaginator is a paginator for ListDocumentVersions
func NewListDocumentVersionsPaginator ¶ added in v0.30.0
func NewListDocumentVersionsPaginator(client ListDocumentVersionsAPIClient, params *ListDocumentVersionsInput, optFns ...func(*ListDocumentVersionsPaginatorOptions)) *ListDocumentVersionsPaginator
NewListDocumentVersionsPaginator returns a new ListDocumentVersionsPaginator
func (*ListDocumentVersionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDocumentVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDocumentVersionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDocumentVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDocumentVersionsOutput, error)
NextPage retrieves the next ListDocumentVersions page.
type ListDocumentVersionsPaginatorOptions ¶ added in v0.30.0
type ListDocumentVersionsPaginatorOptions 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 }
ListDocumentVersionsPaginatorOptions is the paginator options for ListDocumentVersions
type ListDocumentsAPIClient ¶ added in v0.30.0
type ListDocumentsAPIClient interface {
ListDocuments(context.Context, *ListDocumentsInput, ...func(*Options)) (*ListDocumentsOutput, error)
}
ListDocumentsAPIClient is a client that implements the ListDocuments operation.
type ListDocumentsInput ¶
type ListDocumentsInput struct { // This data type is deprecated. Instead, use Filters . DocumentFilterList []types.DocumentFilter // One or more DocumentKeyValuesFilter objects. Use a filter to return a more // specific list of results. For keys, you can specify one or more key-value pair // tags that have been applied to a document. Other valid keys include Owner , Name // , PlatformTypes , DocumentType , and TargetType . For example, to return // documents you own use Key=Owner,Values=Self . To specify a custom key-value // pair, use the format Key=tag:tagName,Values=valueName . This API operation only // supports filtering documents by using a single tag key and one or more tag // values. For example: Key=tag:tagName,Values=valueName1,valueName2 Filters []types.DocumentKeyValuesFilter // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string // contains filtered or unexported fields }
type ListDocumentsOutput ¶
type ListDocumentsOutput struct { // The names of the SSM documents. DocumentIdentifiers []types.DocumentIdentifier // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDocumentsPaginator ¶ added in v0.30.0
type ListDocumentsPaginator struct {
// contains filtered or unexported fields
}
ListDocumentsPaginator is a paginator for ListDocuments
func NewListDocumentsPaginator ¶ added in v0.30.0
func NewListDocumentsPaginator(client ListDocumentsAPIClient, params *ListDocumentsInput, optFns ...func(*ListDocumentsPaginatorOptions)) *ListDocumentsPaginator
NewListDocumentsPaginator returns a new ListDocumentsPaginator
func (*ListDocumentsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDocumentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDocumentsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDocumentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDocumentsOutput, error)
NextPage retrieves the next ListDocuments page.
type ListDocumentsPaginatorOptions ¶ added in v0.30.0
type ListDocumentsPaginatorOptions 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 }
ListDocumentsPaginatorOptions is the paginator options for ListDocuments
type ListInventoryEntriesInput ¶
type ListInventoryEntriesInput struct { // The managed node ID for which you want inventory information. // // This member is required. InstanceId *string // The type of inventory item for which you want information. // // This member is required. TypeName *string // One or more filters. Use a filter to return a more specific list of results. Filters []types.InventoryFilter // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // The token for the next set of items to return. (You received this token from a // previous call.) NextToken *string // contains filtered or unexported fields }
type ListInventoryEntriesOutput ¶
type ListInventoryEntriesOutput struct { // The time that inventory information was collected for the managed node(s). CaptureTime *string // A list of inventory items on the managed node(s). Entries []map[string]string // The managed node ID targeted by the request to query inventory information. InstanceId *string // The token to use when requesting the next set of items. If there are no // additional items to return, the string is empty. NextToken *string // The inventory schema version used by the managed node(s). SchemaVersion *string // The type of inventory item returned by the request. TypeName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOpsItemEventsAPIClient ¶ added in v0.31.0
type ListOpsItemEventsAPIClient interface {
ListOpsItemEvents(context.Context, *ListOpsItemEventsInput, ...func(*Options)) (*ListOpsItemEventsOutput, error)
}
ListOpsItemEventsAPIClient is a client that implements the ListOpsItemEvents operation.
type ListOpsItemEventsInput ¶ added in v0.31.0
type ListOpsItemEventsInput struct { // One or more OpsItem filters. Use a filter to return a more specific list of // results. Filters []types.OpsItemEventFilter // 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 // contains filtered or unexported fields }
type ListOpsItemEventsOutput ¶ added in v0.31.0
type ListOpsItemEventsOutput 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 event information for the specified OpsItems. Summaries []types.OpsItemEventSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOpsItemEventsPaginator ¶ added in v0.31.0
type ListOpsItemEventsPaginator struct {
// contains filtered or unexported fields
}
ListOpsItemEventsPaginator is a paginator for ListOpsItemEvents
func NewListOpsItemEventsPaginator ¶ added in v0.31.0
func NewListOpsItemEventsPaginator(client ListOpsItemEventsAPIClient, params *ListOpsItemEventsInput, optFns ...func(*ListOpsItemEventsPaginatorOptions)) *ListOpsItemEventsPaginator
NewListOpsItemEventsPaginator returns a new ListOpsItemEventsPaginator
func (*ListOpsItemEventsPaginator) HasMorePages ¶ added in v0.31.0
func (p *ListOpsItemEventsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOpsItemEventsPaginator) NextPage ¶ added in v0.31.0
func (p *ListOpsItemEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOpsItemEventsOutput, error)
NextPage retrieves the next ListOpsItemEvents page.
type ListOpsItemEventsPaginatorOptions ¶ added in v0.31.0
type ListOpsItemEventsPaginatorOptions 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 }
ListOpsItemEventsPaginatorOptions is the paginator options for ListOpsItemEvents
type ListOpsItemRelatedItemsAPIClient ¶ added in v1.6.0
type ListOpsItemRelatedItemsAPIClient interface {
ListOpsItemRelatedItems(context.Context, *ListOpsItemRelatedItemsInput, ...func(*Options)) (*ListOpsItemRelatedItemsOutput, error)
}
ListOpsItemRelatedItemsAPIClient is a client that implements the ListOpsItemRelatedItems operation.
type ListOpsItemRelatedItemsInput ¶ added in v1.6.0
type ListOpsItemRelatedItemsInput struct { // One or more OpsItem filters. Use a filter to return a more specific list of // results. Filters []types.OpsItemRelatedItemsFilter // 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 ID of the OpsItem for which you want to list all related-item resources. OpsItemId *string // contains filtered or unexported fields }
type ListOpsItemRelatedItemsOutput ¶ added in v1.6.0
type ListOpsItemRelatedItemsOutput 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 related-item resources for the specified OpsItem. Summaries []types.OpsItemRelatedItemSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOpsItemRelatedItemsPaginator ¶ added in v1.6.0
type ListOpsItemRelatedItemsPaginator struct {
// contains filtered or unexported fields
}
ListOpsItemRelatedItemsPaginator is a paginator for ListOpsItemRelatedItems
func NewListOpsItemRelatedItemsPaginator ¶ added in v1.6.0
func NewListOpsItemRelatedItemsPaginator(client ListOpsItemRelatedItemsAPIClient, params *ListOpsItemRelatedItemsInput, optFns ...func(*ListOpsItemRelatedItemsPaginatorOptions)) *ListOpsItemRelatedItemsPaginator
NewListOpsItemRelatedItemsPaginator returns a new ListOpsItemRelatedItemsPaginator
func (*ListOpsItemRelatedItemsPaginator) HasMorePages ¶ added in v1.6.0
func (p *ListOpsItemRelatedItemsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOpsItemRelatedItemsPaginator) NextPage ¶ added in v1.6.0
func (p *ListOpsItemRelatedItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOpsItemRelatedItemsOutput, error)
NextPage retrieves the next ListOpsItemRelatedItems page.
type ListOpsItemRelatedItemsPaginatorOptions ¶ added in v1.6.0
type ListOpsItemRelatedItemsPaginatorOptions 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 }
ListOpsItemRelatedItemsPaginatorOptions is the paginator options for ListOpsItemRelatedItems
type ListOpsMetadataAPIClient ¶ added in v0.31.0
type ListOpsMetadataAPIClient interface {
ListOpsMetadata(context.Context, *ListOpsMetadataInput, ...func(*Options)) (*ListOpsMetadataOutput, error)
}
ListOpsMetadataAPIClient is a client that implements the ListOpsMetadata operation.
type ListOpsMetadataInput ¶ added in v0.31.0
type ListOpsMetadataInput struct { // One or more filters to limit the number of OpsMetadata objects returned by the // call. Filters []types.OpsMetadataFilter // 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 // contains filtered or unexported fields }
type ListOpsMetadataOutput ¶ added in v0.31.0
type ListOpsMetadataOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // Returns a list of OpsMetadata objects. OpsMetadataList []types.OpsMetadata // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOpsMetadataPaginator ¶ added in v0.31.0
type ListOpsMetadataPaginator struct {
// contains filtered or unexported fields
}
ListOpsMetadataPaginator is a paginator for ListOpsMetadata
func NewListOpsMetadataPaginator ¶ added in v0.31.0
func NewListOpsMetadataPaginator(client ListOpsMetadataAPIClient, params *ListOpsMetadataInput, optFns ...func(*ListOpsMetadataPaginatorOptions)) *ListOpsMetadataPaginator
NewListOpsMetadataPaginator returns a new ListOpsMetadataPaginator
func (*ListOpsMetadataPaginator) HasMorePages ¶ added in v0.31.0
func (p *ListOpsMetadataPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOpsMetadataPaginator) NextPage ¶ added in v0.31.0
func (p *ListOpsMetadataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOpsMetadataOutput, error)
NextPage retrieves the next ListOpsMetadata page.
type ListOpsMetadataPaginatorOptions ¶ added in v0.31.0
type ListOpsMetadataPaginatorOptions 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 }
ListOpsMetadataPaginatorOptions is the paginator options for ListOpsMetadata
type ListResourceComplianceSummariesAPIClient ¶ added in v0.30.0
type ListResourceComplianceSummariesAPIClient interface {
ListResourceComplianceSummaries(context.Context, *ListResourceComplianceSummariesInput, ...func(*Options)) (*ListResourceComplianceSummariesOutput, error)
}
ListResourceComplianceSummariesAPIClient is a client that implements the ListResourceComplianceSummaries operation.
type ListResourceComplianceSummariesInput ¶
type ListResourceComplianceSummariesInput struct { // One or more filters. Use a filter to return a more specific list of results. Filters []types.ComplianceStringFilter // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string // contains filtered or unexported fields }
type ListResourceComplianceSummariesOutput ¶
type ListResourceComplianceSummariesOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // A summary count for specified or targeted managed nodes. Summary count includes // information about compliant and non-compliant State Manager associations, patch // status, or custom items according to the filter criteria that you specify. ResourceComplianceSummaryItems []types.ResourceComplianceSummaryItem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourceComplianceSummariesPaginator ¶ added in v0.30.0
type ListResourceComplianceSummariesPaginator struct {
// contains filtered or unexported fields
}
ListResourceComplianceSummariesPaginator is a paginator for ListResourceComplianceSummaries
func NewListResourceComplianceSummariesPaginator ¶ added in v0.30.0
func NewListResourceComplianceSummariesPaginator(client ListResourceComplianceSummariesAPIClient, params *ListResourceComplianceSummariesInput, optFns ...func(*ListResourceComplianceSummariesPaginatorOptions)) *ListResourceComplianceSummariesPaginator
NewListResourceComplianceSummariesPaginator returns a new ListResourceComplianceSummariesPaginator
func (*ListResourceComplianceSummariesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListResourceComplianceSummariesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourceComplianceSummariesPaginator) NextPage ¶ added in v0.30.0
func (p *ListResourceComplianceSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceComplianceSummariesOutput, error)
NextPage retrieves the next ListResourceComplianceSummaries page.
type ListResourceComplianceSummariesPaginatorOptions ¶ added in v0.30.0
type ListResourceComplianceSummariesPaginatorOptions 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 }
ListResourceComplianceSummariesPaginatorOptions is the paginator options for ListResourceComplianceSummaries
type ListResourceDataSyncAPIClient ¶ added in v0.30.0
type ListResourceDataSyncAPIClient interface {
ListResourceDataSync(context.Context, *ListResourceDataSyncInput, ...func(*Options)) (*ListResourceDataSyncOutput, error)
}
ListResourceDataSyncAPIClient is a client that implements the ListResourceDataSync operation.
type ListResourceDataSyncInput ¶
type ListResourceDataSyncInput struct { // The maximum number of items to return for this call. The call also returns a // token that you can specify in a subsequent call to get the next set of results. MaxResults *int32 // A token to start the list. Use this token to get the next set of results. NextToken *string // View a list of resource data syncs according to the sync type. Specify // SyncToDestination to view resource data syncs that synchronize data to an Amazon // S3 bucket. Specify SyncFromSource to view resource data syncs from // Organizations or from multiple Amazon Web Services Regions. SyncType *string // contains filtered or unexported fields }
type ListResourceDataSyncOutput ¶
type ListResourceDataSyncOutput struct { // The token for the next set of items to return. Use this token to get the next // set of results. NextToken *string // A list of your current resource data sync configurations and their statuses. ResourceDataSyncItems []types.ResourceDataSyncItem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourceDataSyncPaginator ¶ added in v0.30.0
type ListResourceDataSyncPaginator struct {
// contains filtered or unexported fields
}
ListResourceDataSyncPaginator is a paginator for ListResourceDataSync
func NewListResourceDataSyncPaginator ¶ added in v0.30.0
func NewListResourceDataSyncPaginator(client ListResourceDataSyncAPIClient, params *ListResourceDataSyncInput, optFns ...func(*ListResourceDataSyncPaginatorOptions)) *ListResourceDataSyncPaginator
NewListResourceDataSyncPaginator returns a new ListResourceDataSyncPaginator
func (*ListResourceDataSyncPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListResourceDataSyncPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourceDataSyncPaginator) NextPage ¶ added in v0.30.0
func (p *ListResourceDataSyncPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceDataSyncOutput, error)
NextPage retrieves the next ListResourceDataSync page.
type ListResourceDataSyncPaginatorOptions ¶ added in v0.30.0
type ListResourceDataSyncPaginatorOptions 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 }
ListResourceDataSyncPaginatorOptions is the paginator options for ListResourceDataSync
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The resource ID for which you want to see a list of tags. // // This member is required. ResourceId *string // Returns a list of tags for a specific resource type. // // This member is required. ResourceType types.ResourceTypeForTagging // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A list of tags. TagList []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ModifyDocumentPermissionInput ¶
type ModifyDocumentPermissionInput struct { // The name of the document that you want to share. // // 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 // The Amazon Web Services users that should have access to the document. The // account IDs can either be a group of account IDs or All. AccountIdsToAdd []string // The Amazon Web Services users that should no longer have access to the // document. The Amazon Web Services user can either be a group of account IDs or // All. This action has a higher priority than AccountIdsToAdd. If you specify an // ID to add and the same ID to remove, the system removes access to the document. AccountIdsToRemove []string // system choose the Default version to share. SharedDocumentVersion *string // contains filtered or unexported fields }
type ModifyDocumentPermissionOutput ¶
type ModifyDocumentPermissionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom // endpoint, set the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service. This should be used over // the deprecated EndpointResolver EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
type PutComplianceItemsInput ¶
type PutComplianceItemsInput struct { // Specify the compliance type. For example, specify Association (for a State // Manager association), Patch, or Custom: string . // // This member is required. ComplianceType *string // A summary of the call execution that includes an execution ID, the type of // execution (for example, Command ), and the date/time of the execution using a // datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'. // // This member is required. ExecutionSummary *types.ComplianceExecutionSummary // Information about the compliance as defined by the resource type. For example, // for a patch compliance type, Items includes information about the // PatchSeverity, Classification, and so on. // // This member is required. Items []types.ComplianceItemEntry // Specify an ID for this resource. For a managed node, this is the node ID. // // This member is required. ResourceId *string // Specify the type of resource. ManagedInstance is currently the only supported // resource type. // // This member is required. ResourceType *string // MD5 or SHA-256 content hash. The content hash is used to determine if existing // information should be overwritten or ignored. If the content hashes match, the // request to put compliance information is ignored. ItemContentHash *string // The mode for uploading compliance items. You can specify COMPLETE or PARTIAL . // In COMPLETE mode, the system overwrites all existing compliance information for // the resource. You must provide a full list of compliance items each time you // send the request. In PARTIAL mode, the system overwrites compliance information // for a specific association. The association must be configured with // SyncCompliance set to MANUAL . By default, all requests use COMPLETE mode. This // attribute is only valid for association compliance. UploadType types.ComplianceUploadType // contains filtered or unexported fields }
type PutComplianceItemsOutput ¶
type PutComplianceItemsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutInventoryInput ¶
type PutInventoryInput struct { // An managed node ID where you want to add or update inventory items. // // This member is required. InstanceId *string // The inventory items that you want to add or update on managed nodes. // // This member is required. Items []types.InventoryItem // contains filtered or unexported fields }
type PutInventoryOutput ¶
type PutInventoryOutput struct { // Information about the request. Message *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutParameterInput ¶
type PutParameterInput struct { // The fully qualified name of the parameter that you want to add to the system. // The fully qualified name includes the complete hierarchy of the parameter path // and name. For parameters in a hierarchy, you must include a leading forward // slash character (/) when you create or reference a parameter. For example: // /Dev/DBServer/MySQL/db-string13 Naming Constraints: // - Parameter names are case sensitive. // - A parameter name must be unique within an Amazon Web Services Region // - A parameter name can't be prefixed with " aws " or " ssm " // (case-insensitive). // - Parameter names can include only the following symbols and letters: // a-zA-Z0-9_.- In addition, the slash character ( / ) is used to delineate // hierarchies in parameter names. For example: // /Dev/Production/East/Project-ABC/MyParameter // - A parameter name can't include spaces. // - Parameter hierarchies are limited to a maximum depth of fifteen levels. // For additional information about valid values for parameter names, see Creating // Systems Manager parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html) // in the Amazon Web Services Systems Manager User Guide. The maximum length // constraint of 2048 characters listed below includes 1037 characters reserved for // internal use by Systems Manager. The maximum length for a parameter name that // you create is 1011 characters. This includes the characters in the ARN that // precede the name you specify, such as // arn:aws:ssm:us-east-2:111122223333:parameter/ . // // This member is required. Name *string // The parameter value that you want to add to the system. Standard parameters // have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB. // Parameters can't be referenced or nested in the values of other parameters. You // can't include {{}} or {{ssm:parameter-name}} in a parameter value. // // This member is required. Value *string // A regular expression used to validate the parameter value. For example, for // String types with values restricted to numbers, you can specify the following: // AllowedPattern=^\d+$ AllowedPattern *string // The data type for a String parameter. Supported data types include plain text // and Amazon Machine Image (AMI) IDs. The following data type values are // supported. // - text // - aws:ec2:image // - aws:ssm:integration // When you create a String parameter and specify aws:ec2:image , Amazon Web // Services Systems Manager validates the parameter value is in the required // format, such as ami-12345abcdeEXAMPLE , and that the specified AMI is available // in your Amazon Web Services account. If the action is successful, the service // sends back an HTTP 200 response which indicates a successful PutParameter call // for all cases except for data type aws:ec2:image . If you call PutParameter // with aws:ec2:image data type, a successful HTTP 200 response does not guarantee // that your parameter was successfully created or updated. The aws:ec2:image // value is validated asynchronously, and the PutParameter call returns before the // validation is complete. If you submit an invalid AMI value, the PutParameter // operation will return success, but the asynchronous validation will fail and the // parameter will not be created or updated. To monitor whether your aws:ec2:image // parameters are created successfully, see Setting up notifications or trigger // actions based on Parameter Store events (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html) // . For more information about AMI format validation , see Native parameter // support for Amazon Machine Image (AMI) IDs (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html) // . DataType *string // Information about the parameter that you want to add to the system. Optional // but recommended. Don't enter personally identifiable information in this field. Description *string // The Key Management Service (KMS) ID that you want to use to encrypt a // parameter. Use a custom key for better security. Required for parameters that // use the SecureString data type. If you don't specify a key ID, the system uses // the default key associated with your Amazon Web Services account which is not as // secure as using a custom key. // - To use a custom KMS key, choose the SecureString data type with the Key ID // parameter. KeyId *string // Overwrite an existing parameter. The default value is false . Overwrite *bool // One or more policies to apply to a parameter. This operation takes a JSON // array. Parameter Store, a capability of Amazon Web Services Systems Manager // supports the following policy types: Expiration: This policy deletes the // parameter after it expires. When you create the policy, you specify the // expiration date. You can update the expiration date and time by updating the // policy. Updating the parameter doesn't affect the expiration date and time. When // the expiration time is reached, Parameter Store deletes the parameter. // ExpirationNotification: This policy initiates an event in Amazon CloudWatch // Events that notifies you about the expiration. By using this policy, you can // receive notification before or after the expiration time is reached, in units of // days or hours. NoChangeNotification: This policy initiates a CloudWatch Events // event if a parameter hasn't been modified for a specified period of time. This // policy type is useful when, for example, a secret needs to be changed within a // period of time, but it hasn't been changed. All existing policies are preserved // until you send new policies or an empty policy. For more information about // parameter policies, see Assigning parameter policies (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) // . Policies *string // Optional metadata that you assign to a resource. Tags enable you to categorize // a resource in different ways, such as by purpose, owner, or environment. For // example, you might want to tag a Systems Manager parameter to identify the type // of resource to which it applies, the environment, or the type of configuration // data referenced by the parameter. In this case, you could specify the following // key-value pairs: // - Key=Resource,Value=S3bucket // - Key=OS,Value=Windows // - Key=ParameterType,Value=LicenseKey // To add tags to an existing Systems Manager parameter, use the AddTagsToResource // operation. Tags []types.Tag // The parameter tier to assign to a parameter. Parameter Store offers a standard // tier and an advanced tier for parameters. Standard parameters have a content // size limit of 4 KB and can't be configured to use parameter policies. You can // create a maximum of 10,000 standard parameters for each Region in an Amazon Web // Services account. Standard parameters are offered at no additional cost. // Advanced parameters have a content size limit of 8 KB and can be configured to // use parameter policies. You can create a maximum of 100,000 advanced parameters // for each Region in an Amazon Web Services account. Advanced parameters incur a // charge. For more information, see Standard and advanced parameter tiers (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html) // in the Amazon Web Services Systems Manager User Guide. You can change a standard // parameter to an advanced parameter any time. But you can't revert an advanced // parameter to a standard parameter. Reverting an advanced parameter to a standard // parameter would result in data loss because the system would truncate the size // of the parameter from 8 KB to 4 KB. Reverting would also remove any policies // attached to the parameter. Lastly, advanced parameters use a different form of // encryption than standard parameters. If you no longer need an advanced // parameter, or if you no longer want to incur charges for an advanced parameter, // you must delete it and recreate it as a new standard parameter. Using the // Default Tier Configuration In PutParameter requests, you can specify the tier // to create the parameter in. Whenever you specify a tier in the request, // Parameter Store creates or updates the parameter according to that request. // However, if you don't specify a tier in a request, Parameter Store assigns the // tier based on the current Parameter Store default tier configuration. The // default tier when you begin using Parameter Store is the standard-parameter // tier. If you use the advanced-parameter tier, you can specify one of the // following as the default: // - Advanced: With this option, Parameter Store evaluates all requests as // advanced parameters. // - Intelligent-Tiering: With this option, Parameter Store evaluates each // request to determine if the parameter is standard or advanced. If the request // doesn't include any options that require an advanced parameter, the parameter is // created in the standard-parameter tier. If one or more options requiring an // advanced parameter are included in the request, Parameter Store create a // parameter in the advanced-parameter tier. This approach helps control your // parameter-related costs by always creating standard parameters unless an // advanced parameter is necessary. // Options that require an advanced parameter include the following: // - The content size of the parameter is more than 4 KB. // - The parameter uses a parameter policy. // - More than 10,000 parameters already exist in your Amazon Web Services // account in the current Amazon Web Services Region. // For more information about configuring the default tier option, see Specifying // a default parameter tier (https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html) // in the Amazon Web Services Systems Manager User Guide. Tier types.ParameterTier // The type of parameter that you want to add to the system. SecureString isn't // currently supported for CloudFormation templates. Items in a StringList must be // separated by a comma (,). You can't use other punctuation or special character // to escape items in the list. If you have a parameter value that requires a // comma, then use the String data type. Specifying a parameter type isn't // required when updating a parameter. You must specify a parameter type when // creating a parameter. Type types.ParameterType // contains filtered or unexported fields }
type PutParameterOutput ¶
type PutParameterOutput struct { // The tier assigned to the parameter. Tier types.ParameterTier // The new version number of a parameter. If you edit a parameter value, Parameter // Store automatically creates a new version and assigns this new version a unique // ID. You can reference a parameter version ID in API operations or in Systems // Manager documents (SSM documents). By default, if you don't specify a specific // version, the system returns the latest parameter value when a parameter is // called. Version int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutResourcePolicyInput ¶ added in v1.33.0
type PutResourcePolicyInput struct { // A policy you want to associate with a resource. // // This member is required. Policy *string // Amazon Resource Name (ARN) of the resource to which you want to attach a policy. // // This member is required. ResourceArn *string // ID of the current policy version. The hash helps to prevent a situation where // multiple users attempt to overwrite a policy. You must provide this hash when // updating or deleting a policy. PolicyHash *string // The policy ID. PolicyId *string // contains filtered or unexported fields }
type PutResourcePolicyOutput ¶ added in v1.33.0
type PutResourcePolicyOutput struct { // ID of the current policy version. PolicyHash *string // The policy ID. To update a policy, you must specify PolicyId and PolicyHash . PolicyId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RegisterDefaultPatchBaselineInput ¶
type RegisterDefaultPatchBaselineInput struct { // The ID of the patch baseline that should be the default patch baseline. // // This member is required. BaselineId *string // contains filtered or unexported fields }
type RegisterDefaultPatchBaselineOutput ¶
type RegisterDefaultPatchBaselineOutput struct { // The ID of the default patch baseline. BaselineId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RegisterPatchBaselineForPatchGroupInput ¶
type RegisterPatchBaselineForPatchGroupInput struct { // The ID of the patch baseline to register with the patch group. // // This member is required. BaselineId *string // The name of the patch group to be registered with the patch baseline. // // This member is required. PatchGroup *string // contains filtered or unexported fields }
type RegisterPatchBaselineForPatchGroupOutput ¶
type RegisterPatchBaselineForPatchGroupOutput struct { // The ID of the patch baseline the patch group was registered with. BaselineId *string // The name of the patch group registered with the patch baseline. PatchGroup *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RegisterTargetWithMaintenanceWindowInput ¶
type RegisterTargetWithMaintenanceWindowInput struct { // The type of target being registered with the maintenance window. // // This member is required. ResourceType types.MaintenanceWindowResourceType // The targets to register with the maintenance window. In other words, the // managed nodes to run commands on when the maintenance window runs. If a single // maintenance window task is registered with multiple targets, its task // invocations occur sequentially and not in parallel. If your task must run on // multiple targets at the same time, register a task for each target individually // and assign each task the same priority level. You can specify targets using // managed node IDs, resource group names, or tags that have been applied to // managed nodes. Example 1: Specify managed node IDs Key=InstanceIds,Values=,, // Example 2: Use tag key-pairs applied to managed nodes Key=tag:,Values=, Example // 3: Use tag-keys applied to managed nodes Key=tag-key,Values=, Example 4: Use // resource group names Key=resource-groups:Name,Values= Example 5: Use filters // for resource group types Key=resource-groups:ResourceTypeFilters,Values=, For // Key=resource-groups:ResourceTypeFilters , specify resource types in the // following format // Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC // For more information about these examples formats, including the best use case // for each one, see Examples: Register targets with a maintenance window (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html) // in the Amazon Web Services Systems Manager User Guide. // // This member is required. Targets []types.Target // The ID of the maintenance window the target should be registered with. // // This member is required. WindowId *string // User-provided idempotency token. ClientToken *string // An optional description for the target. Description *string // An optional name for the target. Name *string // User-provided value that will be included in any Amazon CloudWatch Events // events raised while running tasks for these targets in this maintenance window. OwnerInformation *string // contains filtered or unexported fields }
type RegisterTargetWithMaintenanceWindowOutput ¶
type RegisterTargetWithMaintenanceWindowOutput struct { // The ID of the target definition in this maintenance window. WindowTargetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RegisterTaskWithMaintenanceWindowInput ¶
type RegisterTaskWithMaintenanceWindowInput struct { // The ARN of the task to run. // // This member is required. TaskArn *string // The type of task being registered. // // This member is required. TaskType types.MaintenanceWindowTaskType // The ID of the maintenance window the task should be added to. // // This member is required. WindowId *string // The CloudWatch alarm you want to apply to your maintenance window task. AlarmConfiguration *types.AlarmConfiguration // User-provided idempotency token. ClientToken *string // Indicates whether tasks should continue to run after the cutoff time specified // in the maintenance windows is reached. // - CONTINUE_TASK : When the cutoff time is reached, any tasks that are running // continue. The default value. // - CANCEL_TASK : // - For Automation, Lambda, Step Functions tasks: When the cutoff time is // reached, any task invocations that are already running continue, but no new task // invocations are started. // - For Run Command tasks: When the cutoff time is reached, the system sends a // CancelCommand operation that attempts to cancel the command associated with // the task. However, there is no guarantee that the command will be terminated and // the underlying process stopped. The status for tasks that are not completed // is TIMED_OUT . CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior // An optional description for the task. Description *string // A structure containing information about an Amazon Simple Storage Service // (Amazon S3) bucket to write managed node-level logs to. LoggingInfo has been // deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to // contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options // in the TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance // window task types, see MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The maximum number of targets this task can be run for, in parallel. Although // this element is listed as "Required: No", a value can be omitted only when you // are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxConcurrency *string // The maximum number of errors allowed before this task stops being scheduled. // Although this element is listed as "Required: No", a value can be omitted only // when you are registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxErrors *string // An optional name for the task. Name *string // The priority of the task in the maintenance window, the lower the number the // higher the priority. Tasks in a maintenance window are scheduled in priority // order with tasks that have the same priority scheduled in parallel. Priority *int32 // The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services // Systems Manager to assume when running a maintenance window task. If you do not // specify a service role ARN, Systems Manager uses your account's service-linked // role. If no service-linked role for Systems Manager exists in your account, it // is created when you run RegisterTaskWithMaintenanceWindow . For more // information, see the following topics in the in the Amazon Web Services Systems // Manager User Guide: // - Using service-linked roles for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) // - Should I use a service-linked role or a custom service role to run // maintenance window tasks? (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) ServiceRoleArn *string // The targets (either managed nodes or maintenance window targets). 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, Lambda, and Step Functions). For more information about // running tasks that don't specify targets, see Registering maintenance window // tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // in the Amazon Web Services Systems Manager User Guide. Specify managed nodes // using the following format: Key=InstanceIds,Values=, Specify maintenance window // targets using the following format: Key=WindowTargetIds,Values=, Targets []types.Target // The parameters that the task should use during execution. Populate only the // fields that match the task type. All other fields should be empty. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters // The parameters that should be passed to the task when it is run. TaskParameters // has been deprecated. To specify parameters to pass to a task when it runs, // instead use the Parameters option in the TaskInvocationParameters structure. // For information about how Systems Manager handles these options for the // supported maintenance window task types, see // MaintenanceWindowTaskInvocationParameters . TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression // contains filtered or unexported fields }
type RegisterTaskWithMaintenanceWindowOutput ¶
type RegisterTaskWithMaintenanceWindowOutput struct { // The ID of the task in the maintenance window. WindowTaskId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RemoveTagsFromResourceInput ¶
type RemoveTagsFromResourceInput struct { // The ID of the resource from which you want to remove tags. For example: // ManagedInstance: mi-012345abcde MaintenanceWindow: mw-012345abcde Automation : // example-c160-4567-8519-012345abcde PatchBaseline: pb-012345abcde OpsMetadata // object: ResourceID for tagging is created from the Amazon Resource Name (ARN) // for the object. Specifically, ResourceID is created from the strings that come // after the word opsmetadata in the ARN. For example, an OpsMetadata object with // an ARN of // arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a // ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager . // For the Document and Parameter values, use the name of the resource. The // ManagedInstance type for this API operation is only for on-premises managed // nodes. Specify the name of the managed node in the following format: // mi-ID_number. For example, mi-1a2b3c4d5e6f. // // This member is required. ResourceId *string // The type of resource from which you want to remove a tag. The ManagedInstance // type for this API operation is only for on-premises managed nodes. Specify the // name of the managed node in the following format: mi-ID_number . For example, // mi-1a2b3c4d5e6f . // // This member is required. ResourceType types.ResourceTypeForTagging // Tag keys that you want to remove from the specified resource. // // This member is required. TagKeys []string // contains filtered or unexported fields }
type RemoveTagsFromResourceOutput ¶
type RemoveTagsFromResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResetServiceSettingInput ¶
type ResetServiceSettingInput struct { // The Amazon Resource Name (ARN) of the service setting to reset. The setting ID // can be one of the following. // - /ssm/managed-instance/default-ec2-instance-management-role // - /ssm/automation/customer-script-log-destination // - /ssm/automation/customer-script-log-group-name // - /ssm/documents/console/public-sharing-permission // - /ssm/managed-instance/activation-tier // - /ssm/opsinsights/opscenter // - /ssm/parameter-store/default-parameter-tier // - /ssm/parameter-store/high-throughput-enabled // // This member is required. SettingId *string // contains filtered or unexported fields }
The request body of the ResetServiceSetting API operation.
type ResetServiceSettingOutput ¶
type ResetServiceSettingOutput struct { // The current, effective service setting after calling the ResetServiceSetting // API operation. ServiceSetting *types.ServiceSetting // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The result body of the ResetServiceSetting API operation.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResumeSessionInput ¶
type ResumeSessionInput struct { // The ID of the disconnected session to resume. // // This member is required. SessionId *string // contains filtered or unexported fields }
type ResumeSessionOutput ¶
type ResumeSessionOutput struct { // The ID of the session. SessionId *string // A URL back to SSM Agent on the managed node that the Session Manager client // uses to send commands and receive output from the managed node. Format: // wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) // . region represents the Region identifier for an Amazon Web Services Region // supported by Amazon Web Services Systems Manager, such as us-east-2 for the US // East (Ohio) Region. For a list of supported region values, see the Region column // in Systems Manager service endpoints (https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) // in the Amazon Web Services General Reference. session-id represents the ID of a // Session Manager session, such as 1a2b3c4dEXAMPLE . StreamUrl *string // An encrypted token value containing session and caller information. Used to // authenticate the connection to the managed node. TokenValue *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SendAutomationSignalInput ¶
type SendAutomationSignalInput struct { // The unique identifier for an existing Automation execution that you want to // send the signal to. // // This member is required. AutomationExecutionId *string // The type of signal to send to an Automation execution. // // This member is required. SignalType types.SignalType // The data sent with the signal. The data schema depends on the type of signal // used in the request. For Approve and Reject signal types, the payload is an // optional comment that you can send with the signal type. For example: // Comment="Looks good" For StartStep and Resume signal types, you must send the // name of the Automation step to start or resume as the payload. For example: // StepName="step1" For the StopStep signal type, you must send the step execution // ID as the payload. For example: // StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab" Payload map[string][]string // contains filtered or unexported fields }
type SendAutomationSignalOutput ¶
type SendAutomationSignalOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type SendCommandInput ¶
type SendCommandInput struct { // The name of the Amazon Web Services Systems Manager document (SSM document) to // run. This can be a public document or a custom document. To run a shared // document belonging to another account, specify the document Amazon Resource Name // (ARN). For more information about how to use shared documents, see Using shared // SSM documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) // in the Amazon Web Services Systems Manager User Guide. If you specify a document // name or ARN that hasn't been shared with your account, you receive an // InvalidDocument error. // // This member is required. DocumentName *string // The CloudWatch alarm you want to apply to your command. AlarmConfiguration *types.AlarmConfiguration // Enables Amazon Web Services Systems Manager to send Run Command output to // Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services // Systems Manager. CloudWatchOutputConfig *types.CloudWatchOutputConfig // User-specified information about the command, such as a brief description of // what the command should do. Comment *string // The Sha256 or Sha1 hash created by the system when the document was created. // Sha1 hashes have been deprecated. DocumentHash *string // Sha256 or Sha1. Sha1 hashes have been deprecated. DocumentHashType types.DocumentHashType // The SSM document version to use in the request. You can specify $DEFAULT, // $LATEST, or a specific version number. If you run commands by using the Command // Line Interface (Amazon Web Services CLI), then you must escape the first two // options by using a backslash. If you specify a version number, then you don't // need to use the backslash. For example: --document-version "\$DEFAULT" // --document-version "\$LATEST" --document-version "3" DocumentVersion *string // The IDs of the managed nodes where the command should run. Specifying managed // node IDs is most useful when you are targeting a limited number of managed // nodes, though you can specify up to 50 IDs. To target a larger number of managed // nodes, or if you prefer not to list individual node IDs, we recommend using the // Targets option instead. Using Targets , which accepts tag key-value pairs to // identify the managed nodes to send commands to, you can a send command to tens, // hundreds, or thousands of nodes at once. For more information about how to use // targets, see Using targets and rate controls to send commands to a fleet (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) // in the Amazon Web Services Systems Manager User Guide. InstanceIds []string // (Optional) The maximum number of managed nodes that are allowed to run the // command at the same time. You can specify a number such as 10 or a percentage // such as 10%. The default value is 50 . For more information about how to use // MaxConcurrency , see Using concurrency controls (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity) // in the Amazon Web Services Systems Manager User Guide. MaxConcurrency *string // The maximum number of errors allowed without the command failing. When the // command fails one more time beyond the value of MaxErrors , the systems stops // sending the command to additional targets. You can specify a number like 10 or a // percentage like 10%. The default value is 0 . For more information about how to // use MaxErrors , see Using error controls (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors) // in the Amazon Web Services Systems Manager User Guide. MaxErrors *string // Configurations for sending notifications. NotificationConfig *types.NotificationConfig // The name of the S3 bucket where command execution responses should be stored. OutputS3BucketName *string // The directory structure within the S3 bucket where the responses should be // stored. OutputS3KeyPrefix *string // (Deprecated) You can no longer specify this parameter. The system ignores it. // Instead, Systems Manager automatically determines the Amazon Web Services Region // of the S3 bucket. OutputS3Region *string // The required and optional parameters specified in the document being run. Parameters map[string][]string // The ARN of the Identity and Access Management (IAM) service role to use to // publish Amazon Simple Notification Service (Amazon SNS) notifications for Run // Command commands. This role must provide the sns:Publish permission for your // notification topic. For information about creating and using this service role, // see Monitoring Systems Manager status changes using Amazon SNS notifications (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) // in the Amazon Web Services Systems Manager User Guide. ServiceRoleArn *string // An array of search criteria that targets managed nodes using a Key,Value // combination that you specify. Specifying targets is most useful when you want to // send a command to a large number of managed nodes at once. Using Targets , which // accepts tag key-value pairs to identify managed nodes, you can send a command to // tens, hundreds, or thousands of nodes at once. To send a command to a smaller // number of managed nodes, you can use the InstanceIds option instead. For more // information about how to use targets, see Sending commands to a fleet (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) // in the Amazon Web Services Systems Manager User Guide. Targets []types.Target // If this time is reached and the command hasn't already started running, it // won't run. TimeoutSeconds *int32 // contains filtered or unexported fields }
type SendCommandOutput ¶
type SendCommandOutput struct { // The request as it was received by Systems Manager. Also provides the command ID // which can be used future references to this request. Command *types.Command // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartAssociationsOnceInput ¶
type StartAssociationsOnceInput struct { // The association IDs that you want to run immediately and only one time. // // This member is required. AssociationIds []string // contains filtered or unexported fields }
type StartAssociationsOnceOutput ¶
type StartAssociationsOnceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartAutomationExecutionInput ¶
type StartAutomationExecutionInput struct { // The name of the SSM document to run. This can be a public document or a custom // document. To run a shared document belonging to another account, specify the // document ARN. For more information about how to use shared documents, see Using // shared SSM documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html) // in the Amazon Web Services Systems Manager User Guide. // // This member is required. DocumentName *string // The CloudWatch alarm you want to apply to your automation. AlarmConfiguration *types.AlarmConfiguration // User-provided idempotency token. The token must be unique, is case insensitive, // enforces the UUID format, and can't be reused. ClientToken *string // The version of the Automation runbook to use for this execution. DocumentVersion *string // The maximum number of targets allowed to run this task in parallel. You can // specify a number, such as 10, or a percentage, such as 10%. The default value is // 10 . MaxConcurrency *string // The number of errors that are allowed before the system stops running the // automation on additional targets. You can specify either an absolute number of // errors, for example 10, or a percentage of the target set, for example 10%. If // you specify 3, for example, the system stops running the automation when the // fourth error is received. If you specify 0, then the system stops running the // automation on additional targets after the first error result is returned. If // you run an automation on 50 resources and set max-errors to 10%, then the system // stops running the automation on additional targets when the sixth error is // received. Executions that are already running an automation when max-errors is // reached are allowed to complete, but some of these executions may fail as well. // If you need to ensure that there won't be more than max-errors failed // executions, set max-concurrency to 1 so the executions proceed one at a time. MaxErrors *string // The execution mode of the automation. Valid modes include the following: Auto // and Interactive. The default mode is Auto. Mode types.ExecutionMode // A key-value map of execution parameters, which match the declared parameters in // the Automation runbook. Parameters map[string][]string // Optional metadata that you assign to a resource. You can specify a maximum of // five tags for an automation. Tags enable you to categorize a resource in // different ways, such as by purpose, owner, or environment. For example, you // might want to tag an automation to identify an environment or operating system. // In this case, you could specify the following key-value pairs: // - Key=environment,Value=test // - Key=OS,Value=Windows // To add tags to an existing automation, use the AddTagsToResource operation. Tags []types.Tag // A location is a combination of Amazon Web Services Regions and/or Amazon Web // Services accounts where you want to run the automation. Use this operation to // start an automation in multiple Amazon Web Services Regions and multiple Amazon // Web Services accounts. For more information, see Running Automation workflows // in multiple Amazon Web Services Regions and Amazon Web Services accounts (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html) // in the Amazon Web Services Systems Manager User Guide. TargetLocations []types.TargetLocation // A key-value mapping of document parameters to target resources. Both Targets // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The name of the parameter used as the target resource for the rate-controlled // execution. Required if you specify targets. TargetParameterName *string // A key-value mapping to target resources. Required if you specify // TargetParameterName. Targets []types.Target // contains filtered or unexported fields }
type StartAutomationExecutionOutput ¶
type StartAutomationExecutionOutput struct { // The unique ID of a newly scheduled automation execution. AutomationExecutionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartChangeRequestExecutionInput ¶ added in v0.31.0
type StartChangeRequestExecutionInput struct { // The name of the change template document to run during the runbook workflow. // // This member is required. DocumentName *string // Information about the Automation runbooks that are run during the runbook // workflow. The Automation runbooks specified for the runbook workflow can't run // until all required approvals for the change request have been received. // // This member is required. Runbooks []types.Runbook // Indicates whether the change request can be approved automatically without the // need for manual approvals. If AutoApprovable is enabled in a change template, // then setting AutoApprove to true in StartChangeRequestExecution creates a // change request that bypasses approver review. Change Calendar restrictions are // not bypassed in this scenario. If the state of an associated calendar is CLOSED // , change freeze approvers must still grant permission for this change request to // run. If they don't, the change won't be processed until the calendar state is // again OPEN . AutoApprove bool // User-provided details about the change. If no details are provided, content // specified in the Template information section of the associated change template // is added. ChangeDetails *string // The name of the change request associated with the runbook workflow to be run. ChangeRequestName *string // The user-provided idempotency token. The token must be unique, is case // insensitive, enforces the UUID format, and can't be reused. ClientToken *string // The version of the change template document to run during the runbook workflow. DocumentVersion *string // A key-value map of parameters that match the declared parameters in the change // template document. Parameters map[string][]string // The time that the requester expects the runbook workflow related to the change // request to complete. The time is an estimate only that the requester provides // for reviewers. ScheduledEndTime *time.Time // The date and time specified in the change request to run the Automation // runbooks. The Automation runbooks specified for the runbook workflow can't run // until all required approvals for the change request have been received. ScheduledTime *time.Time // Optional metadata that you assign to a resource. You can specify a maximum of // five tags for a change request. 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 change request to identify an environment or target Amazon // Web Services Region. In this case, you could specify the following key-value // pairs: // - Key=Environment,Value=Production // - Key=Region,Value=us-east-2 Tags []types.Tag // contains filtered or unexported fields }
type StartChangeRequestExecutionOutput ¶ added in v0.31.0
type StartChangeRequestExecutionOutput struct { // The unique ID of a runbook workflow operation. (A runbook workflow is a type of // Automation operation.) AutomationExecutionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartSessionInput ¶
type StartSessionInput struct { // The managed node to connect to for the session. // // This member is required. Target *string // The name of the SSM document you want to use to define the type of session, // input parameters, or preferences for the session. For example, // SSM-SessionManagerRunShell . You can call the GetDocument API to verify the // document exists before attempting to start a session. If no document name is // provided, a shell to the managed node is launched by default. For more // information, see Start a session (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html) // in the Amazon Web Services Systems Manager User Guide. DocumentName *string // The values you want to specify for the parameters defined in the Session // document. Parameters map[string][]string // The reason for connecting to the instance. This value is included in the // details for the Amazon CloudWatch Events event created when you start the // session. Reason *string // contains filtered or unexported fields }
type StartSessionOutput ¶
type StartSessionOutput struct { // The ID of the session. SessionId *string // A URL back to SSM Agent on the managed node that the Session Manager client // uses to send commands and receive output from the node. Format: // wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) // region represents the Region identifier for an Amazon Web Services Region // supported by Amazon Web Services Systems Manager, such as us-east-2 for the US // East (Ohio) Region. For a list of supported region values, see the Region column // in Systems Manager service endpoints (https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) // in the Amazon Web Services General Reference. session-id represents the ID of a // Session Manager session, such as 1a2b3c4dEXAMPLE . StreamUrl *string // An encrypted token value containing session and caller information. This token // is used to authenticate the connection to the managed node, and is valid only // long enough to ensure the connection is successful. Never share your session's // token. TokenValue *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopAutomationExecutionInput ¶
type StopAutomationExecutionInput struct { // The execution ID of the Automation to stop. // // This member is required. AutomationExecutionId *string // The stop request type. Valid types include the following: Cancel and Complete. // The default type is Cancel. Type types.StopType // contains filtered or unexported fields }
type StopAutomationExecutionOutput ¶
type StopAutomationExecutionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TerminateSessionInput ¶
type TerminateSessionInput struct { // The ID of the session to terminate. // // This member is required. SessionId *string // contains filtered or unexported fields }
type TerminateSessionOutput ¶
type TerminateSessionOutput struct { // The ID of the session that has been terminated. SessionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UnlabelParameterVersionInput ¶ added in v1.4.0
type UnlabelParameterVersionInput struct { // One or more labels to delete from the specified parameter version. // // This member is required. Labels []string // The name of the parameter from which you want to delete one or more labels. // // This member is required. Name *string // The specific version of the parameter which you want to delete one or more // labels from. If it isn't present, the call will fail. // // This member is required. ParameterVersion *int64 // contains filtered or unexported fields }
type UnlabelParameterVersionOutput ¶ added in v1.4.0
type UnlabelParameterVersionOutput struct { // The labels that aren't attached to the given parameter version. InvalidLabels []string // A list of all labels deleted from the parameter. RemovedLabels []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAssociationInput ¶
type UpdateAssociationInput struct { // The ID of the association you want to update. // // This member is required. AssociationId *string // The details for the CloudWatch alarm you want to apply to an automation or // command. AlarmConfiguration *types.AlarmConfiguration // By default, when you update an association, the system runs it immediately // after it is updated and then according to the schedule you specified. Specify // this option if you don't want an association to run immediately after you update // it. This parameter isn't supported for rate expressions. If you chose this // option when you created an association and later you edit that association or // you make changes to the SSM document on which that association is based (by // using the Documents page in the console), State Manager applies the association // at the next specified cron interval. For example, if you chose the Latest // version of an SSM document when you created an association and you edit the // association by choosing a different document version on the Documents page, // State Manager applies the association at the next specified cron interval if you // previously selected this option. If this option wasn't selected, State Manager // immediately runs the association. You can reset this option. To do so, specify // the no-apply-only-at-cron-interval parameter when you update the association // from the command line. This parameter forces the association to run immediately // after updating it and according to the interval specified. ApplyOnlyAtCronInterval bool // The name of the association that you want to update. AssociationName *string // This parameter is provided for concurrency control purposes. You must specify // the latest association version in the service. If you want to ensure that this // request succeeds, either specify $LATEST , or omit this parameter. AssociationVersion *string // Choose the parameter that will define how your automation will branch out. This // target is required for associations that use an Automation runbook and target // resources by using rate controls. Automation is a capability of Amazon Web // Services Systems Manager. AutomationTargetParameterName *string // The names or Amazon Resource Names (ARNs) of the Change Calendar type documents // you want to gate your associations under. The associations only run when that // change calendar is open. For more information, see Amazon Web Services Systems // Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) // . CalendarNames []string // The severity level to assign to the association. ComplianceSeverity types.AssociationComplianceSeverity // The document version you want update for the association. State Manager doesn't // support running associations that use a new version of a document if that // document is shared from another account. State Manager always runs the default // version of a document if shared from another account, even though the Systems // Manager console shows that a new version was processed. If you want to run an // association using a new version of a document shared form another account, you // must set the document version to default . DocumentVersion *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 managed node 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 // managed node 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 // managed nodes 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 // The name of the SSM Command document or Automation runbook that contains the // configuration information for the managed node. You can specify Amazon Web // Services-predefined documents, documents you created, or a document that is // shared with you from another account. For Systems Manager document (SSM // document) that are shared with you from other Amazon Web Services accounts, you // must specify the complete SSM document ARN, in the following format: // arn:aws:ssm:region:account-id:document/document-name For example: // arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document For Amazon Web // Services-predefined documents and SSM documents you created in your account, you // only need to specify the document name. For example, AWS-ApplyPatchBaseline or // My-Document . Name *string // An S3 bucket where you want to store the results of this request. OutputLocation *types.InstanceAssociationOutputLocation // The parameters you want to update for the association. If you create a // parameter using Parameter Store, a capability of Amazon Web Services Systems // Manager, you can reference the parameter using {{ssm:parameter-name}} . Parameters map[string][]string // The cron expression used to schedule the association that you want to update. ScheduleExpression *string // Number of days to wait after the scheduled day to run an association. For // example, if you specified a cron schedule of cron(0 0 ? * THU#2 *) , you could // specify an offset of 3 to run the association each Sunday after the second // Thursday of the month. For more information about cron schedules for // associations, see Reference: Cron and rate expressions for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html) // in the Amazon Web Services Systems Manager User Guide. To use offsets, you must // specify the ApplyOnlyAtCronInterval parameter. This option tells the system not // to run an association immediately after you create it. ScheduleOffset *int32 // 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 // operation. In this case, compliance data isn't managed by State Manager, a // capability of Amazon Web Services Systems Manager. It is managed by your direct // call to the PutComplianceItems API operation. By default, all associations use // AUTO mode. SyncCompliance types.AssociationSyncCompliance // A location is a combination of Amazon Web Services Regions and Amazon Web // Services accounts where you want to run the association. Use this action to // update an association in multiple Regions and multiple accounts. TargetLocations []types.TargetLocation // A key-value mapping of document parameters to target resources. Both Targets // and TargetMaps can't be specified together. TargetMaps []map[string][]string // The targets of the association. Targets []types.Target // contains filtered or unexported fields }
type UpdateAssociationOutput ¶
type UpdateAssociationOutput struct { // The description of the association that was updated. AssociationDescription *types.AssociationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAssociationStatusInput ¶
type UpdateAssociationStatusInput struct { // The association status. // // This member is required. AssociationStatus *types.AssociationStatus // The managed node ID. // // This member is required. InstanceId *string // The name of the SSM document. // // This member is required. Name *string // contains filtered or unexported fields }
type UpdateAssociationStatusOutput ¶
type UpdateAssociationStatusOutput struct { // Information about the association. AssociationDescription *types.AssociationDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDocumentDefaultVersionInput ¶
type UpdateDocumentDefaultVersionInput struct { // The version of a custom document that you want to set as the default version. // // This member is required. DocumentVersion *string // The name of a custom document that you want to set as the default version. // // This member is required. Name *string // contains filtered or unexported fields }
type UpdateDocumentDefaultVersionOutput ¶
type UpdateDocumentDefaultVersionOutput struct { // The description of a custom document that you want to set as the default // version. Description *types.DocumentDefaultVersionDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDocumentInput ¶
type UpdateDocumentInput struct { // A valid JSON or YAML string. // // This member is required. Content *string // The name of the SSM document that you want to update. // // This member is required. Name *string // A list of key-value pairs that describe attachments to a version of a document. Attachments []types.AttachmentsSource // The friendly name of the SSM document that you want to update. This value can // differ for each version of the document. If you don't specify a value for this // parameter in your request, the existing value is applied to the new document // version. DisplayName *string // Specify the document format for the new document version. Systems Manager // supports JSON and YAML documents. JSON is the default format. DocumentFormat types.DocumentFormat // The version of the document that you want to update. Currently, Systems Manager // supports updating only the latest version of the document. You can specify the // version number of the latest version or use the $LATEST variable. If you change // a document version for a State Manager association, Systems Manager immediately // runs the association unless you previously specifed the // apply-only-at-cron-interval parameter. DocumentVersion *string // Specify a new target type for the document. TargetType *string // An optional field specifying the version of the artifact you are updating with // the document. For example, "Release 12, Update 6". This value is unique across // all versions of a document, and can't be changed. VersionName *string // contains filtered or unexported fields }
type UpdateDocumentMetadataInput ¶ added in v0.31.0
type UpdateDocumentMetadataInput struct { // The change template review details to update. // // This member is required. DocumentReviews *types.DocumentReviews // The name of the change template for which a version's metadata is to be updated. // // This member is required. Name *string // The version of a change template in which to update approval metadata. DocumentVersion *string // contains filtered or unexported fields }
type UpdateDocumentMetadataOutput ¶ added in v0.31.0
type UpdateDocumentMetadataOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDocumentOutput ¶
type UpdateDocumentOutput struct { // A description of the document that was updated. DocumentDescription *types.DocumentDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateMaintenanceWindowInput ¶
type UpdateMaintenanceWindowInput struct { // The ID of the maintenance window to update. // // This member is required. WindowId *string // Whether targets must be registered with the maintenance window before tasks can // be defined for those targets. AllowUnassociatedTargets *bool // The number of hours before the end of the maintenance window that Amazon Web // Services Systems Manager stops scheduling new tasks for execution. Cutoff *int32 // An optional description for the update request. Description *string // The duration of the maintenance window in hours. Duration *int32 // Whether the maintenance window is enabled. Enabled *bool // 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 name of the maintenance window. Name *string // If True , then all fields that are required by the CreateMaintenanceWindow // operation are also required for this API request. Optional fields that aren't // specified are set to null. Replace *bool // The schedule of the maintenance window in the form of a cron or rate expression. Schedule *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 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 // contains filtered or unexported fields }
type UpdateMaintenanceWindowOutput ¶
type UpdateMaintenanceWindowOutput struct { // Whether targets must be registered with the maintenance window before tasks can // be defined for those targets. AllowUnassociatedTargets bool // The number of hours before the end of the maintenance window that Amazon Web // Services Systems Manager stops scheduling new tasks for execution. Cutoff int32 // An optional description of the update. Description *string // The duration of the maintenance window in hours. Duration int32 // Whether the maintenance window is enabled. Enabled bool // The date and time, in ISO-8601 Extended format, for when the maintenance window // is scheduled to become inactive. The maintenance window won't run after this // specified time. EndDate *string // The name of the maintenance window. Name *string // The schedule of the maintenance window in the form of a cron or rate expression. Schedule *string // The number of days to wait to run a maintenance window after the scheduled cron // expression date and time. 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 the maintenance window // is scheduled to become active. The maintenance window won't run before this // specified time. StartDate *string // The ID of the created maintenance window. WindowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateMaintenanceWindowTargetInput ¶
type UpdateMaintenanceWindowTargetInput struct { // The maintenance window ID with which to modify the target. // // This member is required. WindowId *string // The target ID to modify. // // This member is required. WindowTargetId *string // An optional description for the update. Description *string // A name for the update. Name *string // User-provided value that will be included in any Amazon CloudWatch Events // events raised while running tasks for these targets in this maintenance window. OwnerInformation *string // If True , then all fields that are required by the // RegisterTargetWithMaintenanceWindow operation are also required for this API // request. Optional fields that aren't specified are set to null. Replace *bool // The targets to add or replace. Targets []types.Target // contains filtered or unexported fields }
type UpdateMaintenanceWindowTargetOutput ¶
type UpdateMaintenanceWindowTargetOutput struct { // The updated description. Description *string // The updated name. Name *string // The updated owner. OwnerInformation *string // The updated targets. Targets []types.Target // The maintenance window ID specified in the update request. WindowId *string // The target ID specified in the update request. WindowTargetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateMaintenanceWindowTaskInput ¶
type UpdateMaintenanceWindowTaskInput struct { // The maintenance window ID that contains the task to modify. // // This member is required. WindowId *string // The task ID to modify. // // This member is required. WindowTaskId *string // The CloudWatch alarm you want to apply to your maintenance window task. AlarmConfiguration *types.AlarmConfiguration // Indicates whether tasks should continue to run after the cutoff time specified // in the maintenance windows is reached. // - CONTINUE_TASK : When the cutoff time is reached, any tasks that are running // continue. The default value. // - CANCEL_TASK : // - For Automation, Lambda, Step Functions tasks: When the cutoff time is // reached, any task invocations that are already running continue, but no new task // invocations are started. // - For Run Command tasks: When the cutoff time is reached, the system sends a // CancelCommand operation that attempts to cancel the command associated with // the task. However, there is no guarantee that the command will be terminated and // the underlying process stopped. The status for tasks that are not completed // is TIMED_OUT . CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior // The new task description to specify. Description *string // The new logging location in Amazon S3 to specify. LoggingInfo has been // deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to // contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options // in the TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance // window task types, see MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The new MaxConcurrency value you want to specify. MaxConcurrency is the number // of targets that are allowed to run this task, in parallel. Although this element // is listed as "Required: No", a value can be omitted only when you are // registering or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxConcurrency *string // The new MaxErrors value to specify. MaxErrors is the maximum number of errors // that are allowed before the task stops being scheduled. Although this element is // listed as "Required: No", a value can be omitted only when you are registering // or updating a targetless task (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // You must provide a value in all other cases. For maintenance window tasks // without a target specified, you can't supply a value for this option. Instead, // the system inserts a placeholder value of 1 . This value doesn't affect the // running of your task. MaxErrors *string // The new task name to specify. Name *string // The new task priority to specify. The lower the number, the higher the // priority. Tasks that have the same priority are scheduled in parallel. Priority *int32 // If True, then all fields that are required by the // RegisterTaskWithMaintenanceWindow operation are also required for this API // request. Optional fields that aren't specified are set to null. Replace *bool // The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services // Systems Manager to assume when running a maintenance window task. If you do not // specify a service role ARN, Systems Manager uses your account's service-linked // role. If no service-linked role for Systems Manager exists in your account, it // is created when you run RegisterTaskWithMaintenanceWindow . For more // information, see the following topics in the in the Amazon Web Services Systems // Manager User Guide: // - Using service-linked roles for Systems Manager (https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions) // - Should I use a service-linked role or a custom service role to run // maintenance window tasks? (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role) ServiceRoleArn *string // The targets (either managed nodes or tags) to modify. Managed nodes are // specified using the format Key=instanceids,Values=instanceID_1,instanceID_2 . // Tags are specified using the format Key=tag_name,Values=tag_value . 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, Lambda, and Step Functions). For more information about // running tasks that don't specify targets, see Registering maintenance window // tasks without targets (https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) // in the Amazon Web Services Systems Manager User Guide. Targets []types.Target // The task ARN to modify. TaskArn *string // The parameters that the task should use during execution. Populate only the // fields that match the task type. All other fields should be empty. 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 don't // 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. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters // The parameters to modify. TaskParameters has been deprecated. To specify // parameters to pass to a task when it runs, instead use the Parameters option in // the TaskInvocationParameters structure. For information about how Systems // Manager handles these options for the supported maintenance window task types, // see MaintenanceWindowTaskInvocationParameters . The map has the following // format: Key: string, between 1 and 255 characters Value: an array of strings, // each string is between 1 and 255 characters TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression // contains filtered or unexported fields }
type UpdateMaintenanceWindowTaskOutput ¶
type UpdateMaintenanceWindowTaskOutput struct { // The details for the CloudWatch alarm you applied to your maintenance window // task. AlarmConfiguration *types.AlarmConfiguration // The specification for whether tasks should continue to run after the cutoff // time specified in the maintenance windows is reached. CutoffBehavior types.MaintenanceWindowTaskCutoffBehavior // The updated task description. Description *string // The updated logging information in Amazon S3. LoggingInfo has been deprecated. // To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, // instead use the OutputS3BucketName and OutputS3KeyPrefix options in the // TaskInvocationParameters structure. For information about how Amazon Web // Services Systems Manager handles these options for the supported maintenance // window task types, see MaintenanceWindowTaskInvocationParameters . LoggingInfo *types.LoggingInfo // The updated MaxConcurrency value. MaxConcurrency *string // The updated MaxErrors value. MaxErrors *string // The updated task name. Name *string // The updated priority value. Priority int32 // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) // service role to use to publish Amazon Simple Notification Service (Amazon SNS) // notifications for maintenance window Run Command tasks. ServiceRoleArn *string // The updated target values. Targets []types.Target // The updated task ARN value. TaskArn *string // The updated parameter values. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters // The updated parameter values. TaskParameters has been deprecated. To specify // parameters to pass to a task when it runs, instead use the Parameters option in // the TaskInvocationParameters structure. For information about how Systems // Manager handles these options for the supported maintenance window task types, // see MaintenanceWindowTaskInvocationParameters . TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression // The ID of the maintenance window that was updated. WindowId *string // The task ID of the maintenance window that was updated. WindowTaskId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateManagedInstanceRoleInput ¶
type UpdateManagedInstanceRoleInput struct { // The name of the Identity and Access Management (IAM) role that you want to // assign to the managed node. This IAM role must provide AssumeRole permissions // for the Amazon Web Services 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 Amazon Web Services Systems Manager User Guide. You can't specify an IAM // service-linked role for this parameter. You must create a unique role. // // This member is required. IamRole *string // The ID of the managed node where you want to update the role. // // This member is required. InstanceId *string // contains filtered or unexported fields }
type UpdateManagedInstanceRoleOutput ¶
type UpdateManagedInstanceRoleOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateOpsItemInput ¶
type UpdateOpsItemInput struct { // The ID of the OpsItem. // // This member is required. OpsItemId *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 new category for an OpsItem. Category *string // Update the information about the OpsItem. Provide enough information so that // users reading this OpsItem for the first time understand the issue. Description *string // The Amazon Resource Name (ARN) of an SNS topic where notifications are sent // when this OpsItem is edited or changed. Notifications []types.OpsItemNotification // Add new keys or edit existing key-value pairs of the OperationalData map in the // OpsItem object. Operational data is custom data that provides useful reference // details about the OpsItem. For example, you can specify log files, error // strings, license keys, troubleshooting tips, or other relevant data. You enter // operational data as key-value pairs. The key has a maximum length of 128 // characters. The value has a maximum size of 20 KB. 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 // operation) can view and search on the specified data. Operational data that // isn't searchable is only viewable by users who have access to the OpsItem (as // provided by the GetOpsItem API operation). 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 Amazon Web Services CLI example commands that use these // keys, see Creating OpsItems manually (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html) // in the Amazon Web Services Systems Manager User Guide. OperationalData map[string]types.OpsItemDataValue // Keys that you want to remove from the OperationalData map. OperationalDataToDelete []string // The OpsItem Amazon Resource Name (ARN). OpsItemArn *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 new severity for an OpsItem. Severity *string // The OpsItem status. Status can be Open , In Progress , or Resolved . For more // information, see Editing OpsItem details (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html) // in the Amazon Web Services Systems Manager User Guide. Status types.OpsItemStatus // A short heading that describes the nature of the OpsItem and the impacted // resource. Title *string // contains filtered or unexported fields }
type UpdateOpsItemOutput ¶
type UpdateOpsItemOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateOpsMetadataInput ¶ added in v0.31.0
type UpdateOpsMetadataInput struct { // The Amazon Resource Name (ARN) of the OpsMetadata Object to update. // // This member is required. OpsMetadataArn *string // The metadata keys to delete from the OpsMetadata object. KeysToDelete []string // Metadata to add to an OpsMetadata object. MetadataToUpdate map[string]types.MetadataValue // contains filtered or unexported fields }
type UpdateOpsMetadataOutput ¶ added in v0.31.0
type UpdateOpsMetadataOutput struct { // The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated. OpsMetadataArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdatePatchBaselineInput ¶
type UpdatePatchBaselineInput struct { // The ID of the patch baseline to update. // // This member is required. BaselineId *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 Amazon Web Services Systems Manager User Guide. ApprovedPatches []string // Assigns a new compliance severity level to an existing patch baseline. ApprovedPatchesComplianceLevel types.PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates // that should be applied to the managed nodes. The default value is false . // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity *bool // A description of the patch baseline. Description *string // A set of global filters used to include patches in the baseline. GlobalFilters *types.PatchFilterGroup // The name of the patch baseline. Name *string // A list of explicitly rejected patches for the baseline. For information about // accepted formats for lists of approved patches and rejected patches, see About // package name formats for approved and rejected patch lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) // in the Amazon Web Services 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, aren't 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 // If True, then all fields that are required by the CreatePatchBaseline operation // are also required for this API request. Optional fields that aren't specified // are set to null. Replace *bool // Information about the patches to use to update the managed nodes, including // target operating systems and source repositories. Applies to Linux managed nodes // only. Sources []types.PatchSource // contains filtered or unexported fields }
type UpdatePatchBaselineOutput ¶
type UpdatePatchBaselineOutput struct { // A set of rules used to include patches in the baseline. ApprovalRules *types.PatchRuleGroup // A list of explicitly approved patches for the baseline. ApprovedPatches []string // The compliance severity level assigned to the patch baseline after the update // completed. ApprovedPatchesComplianceLevel types.PatchComplianceLevel // Indicates whether the list of approved patches includes non-security updates // that should be applied to the managed nodes. The default value is false . // Applies to Linux managed nodes only. ApprovedPatchesEnableNonSecurity *bool // The ID of the deleted patch baseline. BaselineId *string // The date when the patch baseline was created. CreatedDate *time.Time // A description of the patch baseline. Description *string // A set of global filters used to exclude patches from the baseline. GlobalFilters *types.PatchFilterGroup // The date when the patch baseline was last modified. ModifiedDate *time.Time // The name of the patch baseline. Name *string // The operating system rule used by the updated patch baseline. OperatingSystem types.OperatingSystem // A list of explicitly rejected patches for the baseline. RejectedPatches []string // The action specified to take on patches included in the RejectedPatches list. A // patch can be allowed only if it is a dependency of another package, or blocked // entirely along with packages that include it as a dependency. RejectedPatchesAction types.PatchAction // Information about the patches to use to update the managed nodes, including // target operating systems and source repositories. Applies to Linux managed nodes // only. Sources []types.PatchSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateResourceDataSyncInput ¶
type UpdateResourceDataSyncInput struct { // The name of the resource data sync you want to update. // // This member is required. SyncName *string // Specify information about the data sources to synchronize. // // This member is required. SyncSource *types.ResourceDataSyncSource // The type of resource data sync. The supported SyncType is SyncFromSource. // // This member is required. SyncType *string // contains filtered or unexported fields }
type UpdateResourceDataSyncOutput ¶
type UpdateResourceDataSyncOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateServiceSettingInput ¶
type UpdateServiceSettingInput struct { // The Amazon Resource Name (ARN) of the service setting to update. For example, // arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled // . The setting ID can be one of the following. // - /ssm/managed-instance/default-ec2-instance-management-role // - /ssm/automation/customer-script-log-destination // - /ssm/automation/customer-script-log-group-name // - /ssm/documents/console/public-sharing-permission // - /ssm/managed-instance/activation-tier // - /ssm/opsinsights/opscenter // - /ssm/parameter-store/default-parameter-tier // - /ssm/parameter-store/high-throughput-enabled // Permissions to update the // /ssm/managed-instance/default-ec2-instance-management-role setting should only // be provided to administrators. Implement least privilege access when allowing // individuals to configure or modify the Default Host Management Configuration. // // This member is required. SettingId *string // The new value to specify for the service setting. The following list specifies // the available values for each setting. // - /ssm/managed-instance/default-ec2-instance-management-role: The name of an // IAM role // - /ssm/automation/customer-script-log-destination : CloudWatch // - /ssm/automation/customer-script-log-group-name : The name of an Amazon // CloudWatch Logs log group // - /ssm/documents/console/public-sharing-permission : Enable or Disable // - /ssm/managed-instance/activation-tier : standard or advanced // - /ssm/opsinsights/opscenter : Enabled or Disabled // - /ssm/parameter-store/default-parameter-tier : Standard , Advanced , // Intelligent-Tiering // - /ssm/parameter-store/high-throughput-enabled : true or false // // This member is required. SettingValue *string // contains filtered or unexported fields }
The request body of the UpdateServiceSetting API operation.
type UpdateServiceSettingOutput ¶
type UpdateServiceSettingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The result body of the UpdateServiceSetting API operation.
Source Files ¶
- api_client.go
- api_op_AddTagsToResource.go
- api_op_AssociateOpsItemRelatedItem.go
- api_op_CancelCommand.go
- api_op_CancelMaintenanceWindowExecution.go
- api_op_CreateActivation.go
- api_op_CreateAssociation.go
- api_op_CreateAssociationBatch.go
- api_op_CreateDocument.go
- api_op_CreateMaintenanceWindow.go
- api_op_CreateOpsItem.go
- api_op_CreateOpsMetadata.go
- api_op_CreatePatchBaseline.go
- api_op_CreateResourceDataSync.go
- api_op_DeleteActivation.go
- api_op_DeleteAssociation.go
- api_op_DeleteDocument.go
- api_op_DeleteInventory.go
- api_op_DeleteMaintenanceWindow.go
- api_op_DeleteOpsMetadata.go
- api_op_DeleteParameter.go
- api_op_DeleteParameters.go
- api_op_DeletePatchBaseline.go
- api_op_DeleteResourceDataSync.go
- api_op_DeleteResourcePolicy.go
- api_op_DeregisterManagedInstance.go
- api_op_DeregisterPatchBaselineForPatchGroup.go
- api_op_DeregisterTargetFromMaintenanceWindow.go
- api_op_DeregisterTaskFromMaintenanceWindow.go
- api_op_DescribeActivations.go
- api_op_DescribeAssociation.go
- api_op_DescribeAssociationExecutionTargets.go
- api_op_DescribeAssociationExecutions.go
- api_op_DescribeAutomationExecutions.go
- api_op_DescribeAutomationStepExecutions.go
- api_op_DescribeAvailablePatches.go
- api_op_DescribeDocument.go
- api_op_DescribeDocumentPermission.go
- api_op_DescribeEffectiveInstanceAssociations.go
- api_op_DescribeEffectivePatchesForPatchBaseline.go
- api_op_DescribeInstanceAssociationsStatus.go
- api_op_DescribeInstanceInformation.go
- api_op_DescribeInstancePatchStates.go
- api_op_DescribeInstancePatchStatesForPatchGroup.go
- api_op_DescribeInstancePatches.go
- api_op_DescribeInventoryDeletions.go
- api_op_DescribeMaintenanceWindowExecutionTaskInvocations.go
- api_op_DescribeMaintenanceWindowExecutionTasks.go
- api_op_DescribeMaintenanceWindowExecutions.go
- api_op_DescribeMaintenanceWindowSchedule.go
- api_op_DescribeMaintenanceWindowTargets.go
- api_op_DescribeMaintenanceWindowTasks.go
- api_op_DescribeMaintenanceWindows.go
- api_op_DescribeMaintenanceWindowsForTarget.go
- api_op_DescribeOpsItems.go
- api_op_DescribeParameters.go
- api_op_DescribePatchBaselines.go
- api_op_DescribePatchGroupState.go
- api_op_DescribePatchGroups.go
- api_op_DescribePatchProperties.go
- api_op_DescribeSessions.go
- api_op_DisassociateOpsItemRelatedItem.go
- api_op_GetAutomationExecution.go
- api_op_GetCalendarState.go
- api_op_GetCommandInvocation.go
- api_op_GetConnectionStatus.go
- api_op_GetDefaultPatchBaseline.go
- api_op_GetDeployablePatchSnapshotForInstance.go
- api_op_GetDocument.go
- api_op_GetInventory.go
- api_op_GetInventorySchema.go
- api_op_GetMaintenanceWindow.go
- api_op_GetMaintenanceWindowExecution.go
- api_op_GetMaintenanceWindowExecutionTask.go
- api_op_GetMaintenanceWindowExecutionTaskInvocation.go
- api_op_GetMaintenanceWindowTask.go
- api_op_GetOpsItem.go
- api_op_GetOpsMetadata.go
- api_op_GetOpsSummary.go
- api_op_GetParameter.go
- api_op_GetParameterHistory.go
- api_op_GetParameters.go
- api_op_GetParametersByPath.go
- api_op_GetPatchBaseline.go
- api_op_GetPatchBaselineForPatchGroup.go
- api_op_GetResourcePolicies.go
- api_op_GetServiceSetting.go
- api_op_LabelParameterVersion.go
- api_op_ListAssociationVersions.go
- api_op_ListAssociations.go
- api_op_ListCommandInvocations.go
- api_op_ListCommands.go
- api_op_ListComplianceItems.go
- api_op_ListComplianceSummaries.go
- api_op_ListDocumentMetadataHistory.go
- api_op_ListDocumentVersions.go
- api_op_ListDocuments.go
- api_op_ListInventoryEntries.go
- api_op_ListOpsItemEvents.go
- api_op_ListOpsItemRelatedItems.go
- api_op_ListOpsMetadata.go
- api_op_ListResourceComplianceSummaries.go
- api_op_ListResourceDataSync.go
- api_op_ListTagsForResource.go
- api_op_ModifyDocumentPermission.go
- api_op_PutComplianceItems.go
- api_op_PutInventory.go
- api_op_PutParameter.go
- api_op_PutResourcePolicy.go
- api_op_RegisterDefaultPatchBaseline.go
- api_op_RegisterPatchBaselineForPatchGroup.go
- api_op_RegisterTargetWithMaintenanceWindow.go
- api_op_RegisterTaskWithMaintenanceWindow.go
- api_op_RemoveTagsFromResource.go
- api_op_ResetServiceSetting.go
- api_op_ResumeSession.go
- api_op_SendAutomationSignal.go
- api_op_SendCommand.go
- api_op_StartAssociationsOnce.go
- api_op_StartAutomationExecution.go
- api_op_StartChangeRequestExecution.go
- api_op_StartSession.go
- api_op_StopAutomationExecution.go
- api_op_TerminateSession.go
- api_op_UnlabelParameterVersion.go
- api_op_UpdateAssociation.go
- api_op_UpdateAssociationStatus.go
- api_op_UpdateDocument.go
- api_op_UpdateDocumentDefaultVersion.go
- api_op_UpdateDocumentMetadata.go
- api_op_UpdateMaintenanceWindow.go
- api_op_UpdateMaintenanceWindowTarget.go
- api_op_UpdateMaintenanceWindowTask.go
- api_op_UpdateManagedInstanceRole.go
- api_op_UpdateOpsItem.go
- api_op_UpdateOpsMetadata.go
- api_op_UpdatePatchBaseline.go
- api_op_UpdateResourceDataSync.go
- api_op_UpdateServiceSetting.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go