ssm

package
v1.99.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package ssm provides the client and types for making API requests to Amazon Simple Systems Manager (SSM).

AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.

This reference is intended to be used with the AWS Systems Manager User Guide (http://docs.aws.amazon.com/systems-manager/latest/userguide/).

To get started, verify prerequisites and configure managed instances. For more information, see Setting Up AWS Systems Manager (http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html) in the AWS Systems Manager User Guide.

For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/). For information about how to use a Query API, see Making API Requests (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/making-api-requests.html).

See https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06 for more information on this service.

See ssm package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/ssm/

Using the Client

To contact Amazon Simple Systems Manager (SSM) with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Simple Systems Manager (SSM) client SSM for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ssm/#New

Index

Constants

View Source
const (
	// AssociationComplianceSeverityCritical is a AssociationComplianceSeverity enum value
	AssociationComplianceSeverityCritical = "CRITICAL"

	// AssociationComplianceSeverityHigh is a AssociationComplianceSeverity enum value
	AssociationComplianceSeverityHigh = "HIGH"

	// AssociationComplianceSeverityMedium is a AssociationComplianceSeverity enum value
	AssociationComplianceSeverityMedium = "MEDIUM"

	// AssociationComplianceSeverityLow is a AssociationComplianceSeverity enum value
	AssociationComplianceSeverityLow = "LOW"

	// AssociationComplianceSeverityUnspecified is a AssociationComplianceSeverity enum value
	AssociationComplianceSeverityUnspecified = "UNSPECIFIED"
)
View Source
const (
	// AssociationExecutionFilterKeyExecutionId is a AssociationExecutionFilterKey enum value
	AssociationExecutionFilterKeyExecutionId = "ExecutionId"

	// AssociationExecutionFilterKeyStatus is a AssociationExecutionFilterKey enum value
	AssociationExecutionFilterKeyStatus = "Status"

	// AssociationExecutionFilterKeyCreatedTime is a AssociationExecutionFilterKey enum value
	AssociationExecutionFilterKeyCreatedTime = "CreatedTime"
)
View Source
const (
	// AssociationExecutionTargetsFilterKeyStatus is a AssociationExecutionTargetsFilterKey enum value
	AssociationExecutionTargetsFilterKeyStatus = "Status"

	// AssociationExecutionTargetsFilterKeyResourceId is a AssociationExecutionTargetsFilterKey enum value
	AssociationExecutionTargetsFilterKeyResourceId = "ResourceId"

	// AssociationExecutionTargetsFilterKeyResourceType is a AssociationExecutionTargetsFilterKey enum value
	AssociationExecutionTargetsFilterKeyResourceType = "ResourceType"
)
View Source
const (
	// AssociationFilterKeyInstanceId is a AssociationFilterKey enum value
	AssociationFilterKeyInstanceId = "InstanceId"

	// AssociationFilterKeyName is a AssociationFilterKey enum value
	AssociationFilterKeyName = "Name"

	// AssociationFilterKeyAssociationId is a AssociationFilterKey enum value
	AssociationFilterKeyAssociationId = "AssociationId"

	// AssociationFilterKeyAssociationStatusName is a AssociationFilterKey enum value
	AssociationFilterKeyAssociationStatusName = "AssociationStatusName"

	// AssociationFilterKeyLastExecutedBefore is a AssociationFilterKey enum value
	AssociationFilterKeyLastExecutedBefore = "LastExecutedBefore"

	// AssociationFilterKeyLastExecutedAfter is a AssociationFilterKey enum value
	AssociationFilterKeyLastExecutedAfter = "LastExecutedAfter"

	// AssociationFilterKeyAssociationName is a AssociationFilterKey enum value
	AssociationFilterKeyAssociationName = "AssociationName"
)
View Source
const (
	// AssociationFilterOperatorTypeEqual is a AssociationFilterOperatorType enum value
	AssociationFilterOperatorTypeEqual = "EQUAL"

	// AssociationFilterOperatorTypeLessThan is a AssociationFilterOperatorType enum value
	AssociationFilterOperatorTypeLessThan = "LESS_THAN"

	// AssociationFilterOperatorTypeGreaterThan is a AssociationFilterOperatorType enum value
	AssociationFilterOperatorTypeGreaterThan = "GREATER_THAN"
)
View Source
const (
	// AssociationStatusNamePending is a AssociationStatusName enum value
	AssociationStatusNamePending = "Pending"

	// AssociationStatusNameSuccess is a AssociationStatusName enum value
	AssociationStatusNameSuccess = "Success"

	// AssociationStatusNameFailed is a AssociationStatusName enum value
	AssociationStatusNameFailed = "Failed"
)
View Source
const (
	// AutomationExecutionFilterKeyDocumentNamePrefix is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyDocumentNamePrefix = "DocumentNamePrefix"

	// AutomationExecutionFilterKeyExecutionStatus is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyExecutionStatus = "ExecutionStatus"

	// AutomationExecutionFilterKeyExecutionId is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyExecutionId = "ExecutionId"

	// AutomationExecutionFilterKeyParentExecutionId is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyParentExecutionId = "ParentExecutionId"

	// AutomationExecutionFilterKeyCurrentAction is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyCurrentAction = "CurrentAction"

	// AutomationExecutionFilterKeyStartTimeBefore is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyStartTimeBefore = "StartTimeBefore"

	// AutomationExecutionFilterKeyStartTimeAfter is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyStartTimeAfter = "StartTimeAfter"

	// AutomationExecutionFilterKeyAutomationType is a AutomationExecutionFilterKey enum value
	AutomationExecutionFilterKeyAutomationType = "AutomationType"
)
View Source
const (
	// AutomationExecutionStatusPending is a AutomationExecutionStatus enum value
	AutomationExecutionStatusPending = "Pending"

	// AutomationExecutionStatusInProgress is a AutomationExecutionStatus enum value
	AutomationExecutionStatusInProgress = "InProgress"

	// AutomationExecutionStatusWaiting is a AutomationExecutionStatus enum value
	AutomationExecutionStatusWaiting = "Waiting"

	// AutomationExecutionStatusSuccess is a AutomationExecutionStatus enum value
	AutomationExecutionStatusSuccess = "Success"

	// AutomationExecutionStatusTimedOut is a AutomationExecutionStatus enum value
	AutomationExecutionStatusTimedOut = "TimedOut"

	// AutomationExecutionStatusCancelling is a AutomationExecutionStatus enum value
	AutomationExecutionStatusCancelling = "Cancelling"

	// AutomationExecutionStatusCancelled is a AutomationExecutionStatus enum value
	AutomationExecutionStatusCancelled = "Cancelled"

	// AutomationExecutionStatusFailed is a AutomationExecutionStatus enum value
	AutomationExecutionStatusFailed = "Failed"
)
View Source
const (
	// AutomationTypeCrossAccount is a AutomationType enum value
	AutomationTypeCrossAccount = "CrossAccount"

	// AutomationTypeLocal is a AutomationType enum value
	AutomationTypeLocal = "Local"
)
View Source
const (
	// CommandFilterKeyInvokedAfter is a CommandFilterKey enum value
	CommandFilterKeyInvokedAfter = "InvokedAfter"

	// CommandFilterKeyInvokedBefore is a CommandFilterKey enum value
	CommandFilterKeyInvokedBefore = "InvokedBefore"

	// CommandFilterKeyStatus is a CommandFilterKey enum value
	CommandFilterKeyStatus = "Status"

	// CommandFilterKeyExecutionStage is a CommandFilterKey enum value
	CommandFilterKeyExecutionStage = "ExecutionStage"

	// CommandFilterKeyDocumentName is a CommandFilterKey enum value
	CommandFilterKeyDocumentName = "DocumentName"
)
View Source
const (
	// CommandInvocationStatusPending is a CommandInvocationStatus enum value
	CommandInvocationStatusPending = "Pending"

	// CommandInvocationStatusInProgress is a CommandInvocationStatus enum value
	CommandInvocationStatusInProgress = "InProgress"

	// CommandInvocationStatusDelayed is a CommandInvocationStatus enum value
	CommandInvocationStatusDelayed = "Delayed"

	// CommandInvocationStatusSuccess is a CommandInvocationStatus enum value
	CommandInvocationStatusSuccess = "Success"

	// CommandInvocationStatusCancelled is a CommandInvocationStatus enum value
	CommandInvocationStatusCancelled = "Cancelled"

	// CommandInvocationStatusTimedOut is a CommandInvocationStatus enum value
	CommandInvocationStatusTimedOut = "TimedOut"

	// CommandInvocationStatusFailed is a CommandInvocationStatus enum value
	CommandInvocationStatusFailed = "Failed"

	// CommandInvocationStatusCancelling is a CommandInvocationStatus enum value
	CommandInvocationStatusCancelling = "Cancelling"
)
View Source
const (
	// CommandPluginStatusPending is a CommandPluginStatus enum value
	CommandPluginStatusPending = "Pending"

	// CommandPluginStatusInProgress is a CommandPluginStatus enum value
	CommandPluginStatusInProgress = "InProgress"

	// CommandPluginStatusSuccess is a CommandPluginStatus enum value
	CommandPluginStatusSuccess = "Success"

	// CommandPluginStatusTimedOut is a CommandPluginStatus enum value
	CommandPluginStatusTimedOut = "TimedOut"

	// CommandPluginStatusCancelled is a CommandPluginStatus enum value
	CommandPluginStatusCancelled = "Cancelled"

	// CommandPluginStatusFailed is a CommandPluginStatus enum value
	CommandPluginStatusFailed = "Failed"
)
View Source
const (
	// CommandStatusPending is a CommandStatus enum value
	CommandStatusPending = "Pending"

	// CommandStatusInProgress is a CommandStatus enum value
	CommandStatusInProgress = "InProgress"

	// CommandStatusSuccess is a CommandStatus enum value
	CommandStatusSuccess = "Success"

	// CommandStatusCancelled is a CommandStatus enum value
	CommandStatusCancelled = "Cancelled"

	// CommandStatusFailed is a CommandStatus enum value
	CommandStatusFailed = "Failed"

	// CommandStatusTimedOut is a CommandStatus enum value
	CommandStatusTimedOut = "TimedOut"

	// CommandStatusCancelling is a CommandStatus enum value
	CommandStatusCancelling = "Cancelling"
)
View Source
const (
	// ComplianceQueryOperatorTypeEqual is a ComplianceQueryOperatorType enum value
	ComplianceQueryOperatorTypeEqual = "EQUAL"

	// ComplianceQueryOperatorTypeNotEqual is a ComplianceQueryOperatorType enum value
	ComplianceQueryOperatorTypeNotEqual = "NOT_EQUAL"

	// ComplianceQueryOperatorTypeBeginWith is a ComplianceQueryOperatorType enum value
	ComplianceQueryOperatorTypeBeginWith = "BEGIN_WITH"

	// ComplianceQueryOperatorTypeLessThan is a ComplianceQueryOperatorType enum value
	ComplianceQueryOperatorTypeLessThan = "LESS_THAN"

	// ComplianceQueryOperatorTypeGreaterThan is a ComplianceQueryOperatorType enum value
	ComplianceQueryOperatorTypeGreaterThan = "GREATER_THAN"
)
View Source
const (
	// ComplianceSeverityCritical is a ComplianceSeverity enum value
	ComplianceSeverityCritical = "CRITICAL"

	// ComplianceSeverityHigh is a ComplianceSeverity enum value
	ComplianceSeverityHigh = "HIGH"

	// ComplianceSeverityMedium is a ComplianceSeverity enum value
	ComplianceSeverityMedium = "MEDIUM"

	// ComplianceSeverityLow is a ComplianceSeverity enum value
	ComplianceSeverityLow = "LOW"

	// ComplianceSeverityInformational is a ComplianceSeverity enum value
	ComplianceSeverityInformational = "INFORMATIONAL"

	// ComplianceSeverityUnspecified is a ComplianceSeverity enum value
	ComplianceSeverityUnspecified = "UNSPECIFIED"
)
View Source
const (
	// ComplianceStatusCompliant is a ComplianceStatus enum value
	ComplianceStatusCompliant = "COMPLIANT"

	// ComplianceStatusNonCompliant is a ComplianceStatus enum value
	ComplianceStatusNonCompliant = "NON_COMPLIANT"
)
View Source
const (
	// ConnectionStatusConnected is a ConnectionStatus enum value
	ConnectionStatusConnected = "Connected"

	// ConnectionStatusNotConnected is a ConnectionStatus enum value
	ConnectionStatusNotConnected = "NotConnected"
)
View Source
const (
	// DescribeActivationsFilterKeysActivationIds is a DescribeActivationsFilterKeys enum value
	DescribeActivationsFilterKeysActivationIds = "ActivationIds"

	// DescribeActivationsFilterKeysDefaultInstanceName is a DescribeActivationsFilterKeys enum value
	DescribeActivationsFilterKeysDefaultInstanceName = "DefaultInstanceName"

	// DescribeActivationsFilterKeysIamRole is a DescribeActivationsFilterKeys enum value
	DescribeActivationsFilterKeysIamRole = "IamRole"
)
View Source
const (
	// DocumentFilterKeyName is a DocumentFilterKey enum value
	DocumentFilterKeyName = "Name"

	// DocumentFilterKeyOwner is a DocumentFilterKey enum value
	DocumentFilterKeyOwner = "Owner"

	// DocumentFilterKeyPlatformTypes is a DocumentFilterKey enum value
	DocumentFilterKeyPlatformTypes = "PlatformTypes"

	// DocumentFilterKeyDocumentType is a DocumentFilterKey enum value
	DocumentFilterKeyDocumentType = "DocumentType"
)
View Source
const (
	// DocumentFormatYaml is a DocumentFormat enum value
	DocumentFormatYaml = "YAML"

	// DocumentFormatJson is a DocumentFormat enum value
	DocumentFormatJson = "JSON"
)
View Source
const (
	// DocumentHashTypeSha256 is a DocumentHashType enum value
	DocumentHashTypeSha256 = "Sha256"

	// DocumentHashTypeSha1 is a DocumentHashType enum value
	DocumentHashTypeSha1 = "Sha1"
)
View Source
const (
	// DocumentParameterTypeString is a DocumentParameterType enum value
	DocumentParameterTypeString = "String"

	// DocumentParameterTypeStringList is a DocumentParameterType enum value
	DocumentParameterTypeStringList = "StringList"
)
View Source
const (
	// DocumentStatusCreating is a DocumentStatus enum value
	DocumentStatusCreating = "Creating"

	// DocumentStatusActive is a DocumentStatus enum value
	DocumentStatusActive = "Active"

	// DocumentStatusUpdating is a DocumentStatus enum value
	DocumentStatusUpdating = "Updating"

	// DocumentStatusDeleting is a DocumentStatus enum value
	DocumentStatusDeleting = "Deleting"

	// DocumentStatusFailed is a DocumentStatus enum value
	DocumentStatusFailed = "Failed"
)

The status of a document.

View Source
const (
	// DocumentTypeCommand is a DocumentType enum value
	DocumentTypeCommand = "Command"

	// DocumentTypePolicy is a DocumentType enum value
	DocumentTypePolicy = "Policy"

	// DocumentTypeAutomation is a DocumentType enum value
	DocumentTypeAutomation = "Automation"

	// DocumentTypeSession is a DocumentType enum value
	DocumentTypeSession = "Session"

	// DocumentTypePackage is a DocumentType enum value
	DocumentTypePackage = "Package"
)
View Source
const (
	// ExecutionModeAuto is a ExecutionMode enum value
	ExecutionModeAuto = "Auto"

	// ExecutionModeInteractive is a ExecutionMode enum value
	ExecutionModeInteractive = "Interactive"
)
View Source
const (
	// FaultClient is a Fault enum value
	FaultClient = "Client"

	// FaultServer is a Fault enum value
	FaultServer = "Server"

	// FaultUnknown is a Fault enum value
	FaultUnknown = "Unknown"
)
View Source
const (
	// InstanceInformationFilterKeyInstanceIds is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyInstanceIds = "InstanceIds"

	// InstanceInformationFilterKeyAgentVersion is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyAgentVersion = "AgentVersion"

	// InstanceInformationFilterKeyPingStatus is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyPingStatus = "PingStatus"

	// InstanceInformationFilterKeyPlatformTypes is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyPlatformTypes = "PlatformTypes"

	// InstanceInformationFilterKeyActivationIds is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyActivationIds = "ActivationIds"

	// InstanceInformationFilterKeyIamRole is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyIamRole = "IamRole"

	// InstanceInformationFilterKeyResourceType is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyResourceType = "ResourceType"

	// InstanceInformationFilterKeyAssociationStatus is a InstanceInformationFilterKey enum value
	InstanceInformationFilterKeyAssociationStatus = "AssociationStatus"
)
View Source
const (
	// InstancePatchStateOperatorTypeEqual is a InstancePatchStateOperatorType enum value
	InstancePatchStateOperatorTypeEqual = "Equal"

	// InstancePatchStateOperatorTypeNotEqual is a InstancePatchStateOperatorType enum value
	InstancePatchStateOperatorTypeNotEqual = "NotEqual"

	// InstancePatchStateOperatorTypeLessThan is a InstancePatchStateOperatorType enum value
	InstancePatchStateOperatorTypeLessThan = "LessThan"

	// InstancePatchStateOperatorTypeGreaterThan is a InstancePatchStateOperatorType enum value
	InstancePatchStateOperatorTypeGreaterThan = "GreaterThan"
)
View Source
const (
	// InventoryAttributeDataTypeString is a InventoryAttributeDataType enum value
	InventoryAttributeDataTypeString = "string"

	// InventoryAttributeDataTypeNumber is a InventoryAttributeDataType enum value
	InventoryAttributeDataTypeNumber = "number"
)
View Source
const (
	// InventoryDeletionStatusInProgress is a InventoryDeletionStatus enum value
	InventoryDeletionStatusInProgress = "InProgress"

	// InventoryDeletionStatusComplete is a InventoryDeletionStatus enum value
	InventoryDeletionStatusComplete = "Complete"
)
View Source
const (
	// InventoryQueryOperatorTypeEqual is a InventoryQueryOperatorType enum value
	InventoryQueryOperatorTypeEqual = "Equal"

	// InventoryQueryOperatorTypeNotEqual is a InventoryQueryOperatorType enum value
	InventoryQueryOperatorTypeNotEqual = "NotEqual"

	// InventoryQueryOperatorTypeBeginWith is a InventoryQueryOperatorType enum value
	InventoryQueryOperatorTypeBeginWith = "BeginWith"

	// InventoryQueryOperatorTypeLessThan is a InventoryQueryOperatorType enum value
	InventoryQueryOperatorTypeLessThan = "LessThan"

	// InventoryQueryOperatorTypeGreaterThan is a InventoryQueryOperatorType enum value
	InventoryQueryOperatorTypeGreaterThan = "GreaterThan"

	// InventoryQueryOperatorTypeExists is a InventoryQueryOperatorType enum value
	InventoryQueryOperatorTypeExists = "Exists"
)
View Source
const (
	// InventorySchemaDeleteOptionDisableSchema is a InventorySchemaDeleteOption enum value
	InventorySchemaDeleteOptionDisableSchema = "DisableSchema"

	// InventorySchemaDeleteOptionDeleteSchema is a InventorySchemaDeleteOption enum value
	InventorySchemaDeleteOptionDeleteSchema = "DeleteSchema"
)
View Source
const (
	// LastResourceDataSyncStatusSuccessful is a LastResourceDataSyncStatus enum value
	LastResourceDataSyncStatusSuccessful = "Successful"

	// LastResourceDataSyncStatusFailed is a LastResourceDataSyncStatus enum value
	LastResourceDataSyncStatusFailed = "Failed"

	// LastResourceDataSyncStatusInProgress is a LastResourceDataSyncStatus enum value
	LastResourceDataSyncStatusInProgress = "InProgress"
)
View Source
const (
	// MaintenanceWindowExecutionStatusPending is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusPending = "PENDING"

	// MaintenanceWindowExecutionStatusInProgress is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusInProgress = "IN_PROGRESS"

	// MaintenanceWindowExecutionStatusSuccess is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusSuccess = "SUCCESS"

	// MaintenanceWindowExecutionStatusFailed is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusFailed = "FAILED"

	// MaintenanceWindowExecutionStatusTimedOut is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusTimedOut = "TIMED_OUT"

	// MaintenanceWindowExecutionStatusCancelling is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusCancelling = "CANCELLING"

	// MaintenanceWindowExecutionStatusCancelled is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusCancelled = "CANCELLED"

	// MaintenanceWindowExecutionStatusSkippedOverlapping is a MaintenanceWindowExecutionStatus enum value
	MaintenanceWindowExecutionStatusSkippedOverlapping = "SKIPPED_OVERLAPPING"
)
View Source
const (
	// MaintenanceWindowResourceTypeInstance is a MaintenanceWindowResourceType enum value
	MaintenanceWindowResourceTypeInstance = "INSTANCE"

	// MaintenanceWindowResourceTypeResourceGroup is a MaintenanceWindowResourceType enum value
	MaintenanceWindowResourceTypeResourceGroup = "RESOURCE_GROUP"
)
View Source
const (
	// MaintenanceWindowTaskTypeRunCommand is a MaintenanceWindowTaskType enum value
	MaintenanceWindowTaskTypeRunCommand = "RUN_COMMAND"

	// MaintenanceWindowTaskTypeAutomation is a MaintenanceWindowTaskType enum value
	MaintenanceWindowTaskTypeAutomation = "AUTOMATION"

	// MaintenanceWindowTaskTypeStepFunctions is a MaintenanceWindowTaskType enum value
	MaintenanceWindowTaskTypeStepFunctions = "STEP_FUNCTIONS"

	// MaintenanceWindowTaskTypeLambda is a MaintenanceWindowTaskType enum value
	MaintenanceWindowTaskTypeLambda = "LAMBDA"
)
View Source
const (
	// NotificationEventAll is a NotificationEvent enum value
	NotificationEventAll = "All"

	// NotificationEventInProgress is a NotificationEvent enum value
	NotificationEventInProgress = "InProgress"

	// NotificationEventSuccess is a NotificationEvent enum value
	NotificationEventSuccess = "Success"

	// NotificationEventTimedOut is a NotificationEvent enum value
	NotificationEventTimedOut = "TimedOut"

	// NotificationEventCancelled is a NotificationEvent enum value
	NotificationEventCancelled = "Cancelled"

	// NotificationEventFailed is a NotificationEvent enum value
	NotificationEventFailed = "Failed"
)
View Source
const (
	// NotificationTypeCommand is a NotificationType enum value
	NotificationTypeCommand = "Command"

	// NotificationTypeInvocation is a NotificationType enum value
	NotificationTypeInvocation = "Invocation"
)
View Source
const (
	// OperatingSystemWindows is a OperatingSystem enum value
	OperatingSystemWindows = "WINDOWS"

	// OperatingSystemAmazonLinux is a OperatingSystem enum value
	OperatingSystemAmazonLinux = "AMAZON_LINUX"

	// OperatingSystemAmazonLinux2 is a OperatingSystem enum value
	OperatingSystemAmazonLinux2 = "AMAZON_LINUX_2"

	// OperatingSystemUbuntu is a OperatingSystem enum value
	OperatingSystemUbuntu = "UBUNTU"

	// OperatingSystemRedhatEnterpriseLinux is a OperatingSystem enum value
	OperatingSystemRedhatEnterpriseLinux = "REDHAT_ENTERPRISE_LINUX"

	// OperatingSystemSuse is a OperatingSystem enum value
	OperatingSystemSuse = "SUSE"

	// OperatingSystemCentos is a OperatingSystem enum value
	OperatingSystemCentos = "CENTOS"
)
View Source
const (
	// OpsFilterOperatorTypeEqual is a OpsFilterOperatorType enum value
	OpsFilterOperatorTypeEqual = "Equal"

	// OpsFilterOperatorTypeNotEqual is a OpsFilterOperatorType enum value
	OpsFilterOperatorTypeNotEqual = "NotEqual"

	// OpsFilterOperatorTypeBeginWith is a OpsFilterOperatorType enum value
	OpsFilterOperatorTypeBeginWith = "BeginWith"

	// OpsFilterOperatorTypeLessThan is a OpsFilterOperatorType enum value
	OpsFilterOperatorTypeLessThan = "LessThan"

	// OpsFilterOperatorTypeGreaterThan is a OpsFilterOperatorType enum value
	OpsFilterOperatorTypeGreaterThan = "GreaterThan"

	// OpsFilterOperatorTypeExists is a OpsFilterOperatorType enum value
	OpsFilterOperatorTypeExists = "Exists"
)
View Source
const (
	// OpsItemDataTypeSearchableString is a OpsItemDataType enum value
	OpsItemDataTypeSearchableString = "SearchableString"

	// OpsItemDataTypeString is a OpsItemDataType enum value
	OpsItemDataTypeString = "String"
)
View Source
const (
	// OpsItemFilterKeyStatus is a OpsItemFilterKey enum value
	OpsItemFilterKeyStatus = "Status"

	// OpsItemFilterKeyCreatedBy is a OpsItemFilterKey enum value
	OpsItemFilterKeyCreatedBy = "CreatedBy"

	// OpsItemFilterKeySource is a OpsItemFilterKey enum value
	OpsItemFilterKeySource = "Source"

	// OpsItemFilterKeyPriority is a OpsItemFilterKey enum value
	OpsItemFilterKeyPriority = "Priority"

	// OpsItemFilterKeyTitle is a OpsItemFilterKey enum value
	OpsItemFilterKeyTitle = "Title"

	// OpsItemFilterKeyOpsItemId is a OpsItemFilterKey enum value
	OpsItemFilterKeyOpsItemId = "OpsItemId"

	// OpsItemFilterKeyCreatedTime is a OpsItemFilterKey enum value
	OpsItemFilterKeyCreatedTime = "CreatedTime"

	// OpsItemFilterKeyLastModifiedTime is a OpsItemFilterKey enum value
	OpsItemFilterKeyLastModifiedTime = "LastModifiedTime"

	// OpsItemFilterKeyOperationalData is a OpsItemFilterKey enum value
	OpsItemFilterKeyOperationalData = "OperationalData"

	// OpsItemFilterKeyOperationalDataKey is a OpsItemFilterKey enum value
	OpsItemFilterKeyOperationalDataKey = "OperationalDataKey"

	// OpsItemFilterKeyOperationalDataValue is a OpsItemFilterKey enum value
	OpsItemFilterKeyOperationalDataValue = "OperationalDataValue"

	// OpsItemFilterKeyResourceId is a OpsItemFilterKey enum value
	OpsItemFilterKeyResourceId = "ResourceId"

	// OpsItemFilterKeyAutomationId is a OpsItemFilterKey enum value
	OpsItemFilterKeyAutomationId = "AutomationId"
)
View Source
const (
	// OpsItemFilterOperatorEqual is a OpsItemFilterOperator enum value
	OpsItemFilterOperatorEqual = "Equal"

	// OpsItemFilterOperatorContains is a OpsItemFilterOperator enum value
	OpsItemFilterOperatorContains = "Contains"

	// OpsItemFilterOperatorGreaterThan is a OpsItemFilterOperator enum value
	OpsItemFilterOperatorGreaterThan = "GreaterThan"

	// OpsItemFilterOperatorLessThan is a OpsItemFilterOperator enum value
	OpsItemFilterOperatorLessThan = "LessThan"
)
View Source
const (
	// OpsItemStatusOpen is a OpsItemStatus enum value
	OpsItemStatusOpen = "Open"

	// OpsItemStatusInProgress is a OpsItemStatus enum value
	OpsItemStatusInProgress = "InProgress"

	// OpsItemStatusResolved is a OpsItemStatus enum value
	OpsItemStatusResolved = "Resolved"
)
View Source
const (
	// ParameterTierStandard is a ParameterTier enum value
	ParameterTierStandard = "Standard"

	// ParameterTierAdvanced is a ParameterTier enum value
	ParameterTierAdvanced = "Advanced"
)
View Source
const (
	// ParameterTypeString is a ParameterType enum value
	ParameterTypeString = "String"

	// ParameterTypeStringList is a ParameterType enum value
	ParameterTypeStringList = "StringList"

	// ParameterTypeSecureString is a ParameterType enum value
	ParameterTypeSecureString = "SecureString"
)
View Source
const (
	// ParametersFilterKeyName is a ParametersFilterKey enum value
	ParametersFilterKeyName = "Name"

	// ParametersFilterKeyType is a ParametersFilterKey enum value
	ParametersFilterKeyType = "Type"

	// ParametersFilterKeyKeyId is a ParametersFilterKey enum value
	ParametersFilterKeyKeyId = "KeyId"
)
View Source
const (
	// PatchActionAllowAsDependency is a PatchAction enum value
	PatchActionAllowAsDependency = "ALLOW_AS_DEPENDENCY"

	// PatchActionBlock is a PatchAction enum value
	PatchActionBlock = "BLOCK"
)
View Source
const (
	// PatchComplianceDataStateInstalled is a PatchComplianceDataState enum value
	PatchComplianceDataStateInstalled = "INSTALLED"

	// PatchComplianceDataStateInstalledOther is a PatchComplianceDataState enum value
	PatchComplianceDataStateInstalledOther = "INSTALLED_OTHER"

	// PatchComplianceDataStateInstalledRejected is a PatchComplianceDataState enum value
	PatchComplianceDataStateInstalledRejected = "INSTALLED_REJECTED"

	// PatchComplianceDataStateMissing is a PatchComplianceDataState enum value
	PatchComplianceDataStateMissing = "MISSING"

	// PatchComplianceDataStateNotApplicable is a PatchComplianceDataState enum value
	PatchComplianceDataStateNotApplicable = "NOT_APPLICABLE"

	// PatchComplianceDataStateFailed is a PatchComplianceDataState enum value
	PatchComplianceDataStateFailed = "FAILED"
)
View Source
const (
	// PatchComplianceLevelCritical is a PatchComplianceLevel enum value
	PatchComplianceLevelCritical = "CRITICAL"

	// PatchComplianceLevelHigh is a PatchComplianceLevel enum value
	PatchComplianceLevelHigh = "HIGH"

	// PatchComplianceLevelMedium is a PatchComplianceLevel enum value
	PatchComplianceLevelMedium = "MEDIUM"

	// PatchComplianceLevelLow is a PatchComplianceLevel enum value
	PatchComplianceLevelLow = "LOW"

	// PatchComplianceLevelInformational is a PatchComplianceLevel enum value
	PatchComplianceLevelInformational = "INFORMATIONAL"

	// PatchComplianceLevelUnspecified is a PatchComplianceLevel enum value
	PatchComplianceLevelUnspecified = "UNSPECIFIED"
)
View Source
const (
	// PatchDeploymentStatusApproved is a PatchDeploymentStatus enum value
	PatchDeploymentStatusApproved = "APPROVED"

	// PatchDeploymentStatusPendingApproval is a PatchDeploymentStatus enum value
	PatchDeploymentStatusPendingApproval = "PENDING_APPROVAL"

	// PatchDeploymentStatusExplicitApproved is a PatchDeploymentStatus enum value
	PatchDeploymentStatusExplicitApproved = "EXPLICIT_APPROVED"

	// PatchDeploymentStatusExplicitRejected is a PatchDeploymentStatus enum value
	PatchDeploymentStatusExplicitRejected = "EXPLICIT_REJECTED"
)
View Source
const (
	// PatchFilterKeyPatchSet is a PatchFilterKey enum value
	PatchFilterKeyPatchSet = "PATCH_SET"

	// PatchFilterKeyProduct is a PatchFilterKey enum value
	PatchFilterKeyProduct = "PRODUCT"

	// PatchFilterKeyProductFamily is a PatchFilterKey enum value
	PatchFilterKeyProductFamily = "PRODUCT_FAMILY"

	// PatchFilterKeyClassification is a PatchFilterKey enum value
	PatchFilterKeyClassification = "CLASSIFICATION"

	// PatchFilterKeyMsrcSeverity is a PatchFilterKey enum value
	PatchFilterKeyMsrcSeverity = "MSRC_SEVERITY"

	// PatchFilterKeyPatchId is a PatchFilterKey enum value
	PatchFilterKeyPatchId = "PATCH_ID"

	// PatchFilterKeySection is a PatchFilterKey enum value
	PatchFilterKeySection = "SECTION"

	// PatchFilterKeyPriority is a PatchFilterKey enum value
	PatchFilterKeyPriority = "PRIORITY"

	// PatchFilterKeySeverity is a PatchFilterKey enum value
	PatchFilterKeySeverity = "SEVERITY"
)
View Source
const (
	// PatchOperationTypeScan is a PatchOperationType enum value
	PatchOperationTypeScan = "Scan"

	// PatchOperationTypeInstall is a PatchOperationType enum value
	PatchOperationTypeInstall = "Install"
)
View Source
const (
	// PatchPropertyProduct is a PatchProperty enum value
	PatchPropertyProduct = "PRODUCT"

	// PatchPropertyProductFamily is a PatchProperty enum value
	PatchPropertyProductFamily = "PRODUCT_FAMILY"

	// PatchPropertyClassification is a PatchProperty enum value
	PatchPropertyClassification = "CLASSIFICATION"

	// PatchPropertyMsrcSeverity is a PatchProperty enum value
	PatchPropertyMsrcSeverity = "MSRC_SEVERITY"

	// PatchPropertyPriority is a PatchProperty enum value
	PatchPropertyPriority = "PRIORITY"

	// PatchPropertySeverity is a PatchProperty enum value
	PatchPropertySeverity = "SEVERITY"
)
View Source
const (
	// PatchSetOs is a PatchSet enum value
	PatchSetOs = "OS"

	// PatchSetApplication is a PatchSet enum value
	PatchSetApplication = "APPLICATION"
)
View Source
const (
	// PingStatusOnline is a PingStatus enum value
	PingStatusOnline = "Online"

	// PingStatusConnectionLost is a PingStatus enum value
	PingStatusConnectionLost = "ConnectionLost"

	// PingStatusInactive is a PingStatus enum value
	PingStatusInactive = "Inactive"
)
View Source
const (
	// PlatformTypeWindows is a PlatformType enum value
	PlatformTypeWindows = "Windows"

	// PlatformTypeLinux is a PlatformType enum value
	PlatformTypeLinux = "Linux"
)
View Source
const (
	// ResourceTypeManagedInstance is a ResourceType enum value
	ResourceTypeManagedInstance = "ManagedInstance"

	// ResourceTypeDocument is a ResourceType enum value
	ResourceTypeDocument = "Document"

	// ResourceTypeEc2instance is a ResourceType enum value
	ResourceTypeEc2instance = "EC2Instance"
)
View Source
const (
	// ResourceTypeForTaggingDocument is a ResourceTypeForTagging enum value
	ResourceTypeForTaggingDocument = "Document"

	// ResourceTypeForTaggingManagedInstance is a ResourceTypeForTagging enum value
	ResourceTypeForTaggingManagedInstance = "ManagedInstance"

	// ResourceTypeForTaggingMaintenanceWindow is a ResourceTypeForTagging enum value
	ResourceTypeForTaggingMaintenanceWindow = "MaintenanceWindow"

	// ResourceTypeForTaggingParameter is a ResourceTypeForTagging enum value
	ResourceTypeForTaggingParameter = "Parameter"

	// ResourceTypeForTaggingPatchBaseline is a ResourceTypeForTagging enum value
	ResourceTypeForTaggingPatchBaseline = "PatchBaseline"

	// ResourceTypeForTaggingOpsItem is a ResourceTypeForTagging enum value
	ResourceTypeForTaggingOpsItem = "OpsItem"
)
View Source
const (
	// SessionFilterKeyInvokedAfter is a SessionFilterKey enum value
	SessionFilterKeyInvokedAfter = "InvokedAfter"

	// SessionFilterKeyInvokedBefore is a SessionFilterKey enum value
	SessionFilterKeyInvokedBefore = "InvokedBefore"

	// SessionFilterKeyTarget is a SessionFilterKey enum value
	SessionFilterKeyTarget = "Target"

	// SessionFilterKeyOwner is a SessionFilterKey enum value
	SessionFilterKeyOwner = "Owner"

	// SessionFilterKeyStatus is a SessionFilterKey enum value
	SessionFilterKeyStatus = "Status"
)
View Source
const (
	// SessionStateActive is a SessionState enum value
	SessionStateActive = "Active"

	// SessionStateHistory is a SessionState enum value
	SessionStateHistory = "History"
)
View Source
const (
	// SessionStatusConnected is a SessionStatus enum value
	SessionStatusConnected = "Connected"

	// SessionStatusConnecting is a SessionStatus enum value
	SessionStatusConnecting = "Connecting"

	// SessionStatusDisconnected is a SessionStatus enum value
	SessionStatusDisconnected = "Disconnected"

	// SessionStatusTerminated is a SessionStatus enum value
	SessionStatusTerminated = "Terminated"

	// SessionStatusTerminating is a SessionStatus enum value
	SessionStatusTerminating = "Terminating"

	// SessionStatusFailed is a SessionStatus enum value
	SessionStatusFailed = "Failed"
)
View Source
const (
	// SignalTypeApprove is a SignalType enum value
	SignalTypeApprove = "Approve"

	// SignalTypeReject is a SignalType enum value
	SignalTypeReject = "Reject"

	// SignalTypeStartStep is a SignalType enum value
	SignalTypeStartStep = "StartStep"

	// SignalTypeStopStep is a SignalType enum value
	SignalTypeStopStep = "StopStep"

	// SignalTypeResume is a SignalType enum value
	SignalTypeResume = "Resume"
)
View Source
const (
	// StepExecutionFilterKeyStartTimeBefore is a StepExecutionFilterKey enum value
	StepExecutionFilterKeyStartTimeBefore = "StartTimeBefore"

	// StepExecutionFilterKeyStartTimeAfter is a StepExecutionFilterKey enum value
	StepExecutionFilterKeyStartTimeAfter = "StartTimeAfter"

	// StepExecutionFilterKeyStepExecutionStatus is a StepExecutionFilterKey enum value
	StepExecutionFilterKeyStepExecutionStatus = "StepExecutionStatus"

	// StepExecutionFilterKeyStepExecutionId is a StepExecutionFilterKey enum value
	StepExecutionFilterKeyStepExecutionId = "StepExecutionId"

	// StepExecutionFilterKeyStepName is a StepExecutionFilterKey enum value
	StepExecutionFilterKeyStepName = "StepName"

	// StepExecutionFilterKeyAction is a StepExecutionFilterKey enum value
	StepExecutionFilterKeyAction = "Action"
)
View Source
const (
	// StopTypeComplete is a StopType enum value
	StopTypeComplete = "Complete"

	// StopTypeCancel is a StopType enum value
	StopTypeCancel = "Cancel"
)
View Source
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// Error returned if an attempt is made to register a patch group with a patch
	// baseline that is already registered with a different patch baseline.
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeAssociatedInstances for service response error code
	// "AssociatedInstances".
	//
	// You must disassociate a document from all instances before you can delete
	// it.
	ErrCodeAssociatedInstances = "AssociatedInstances"

	// ErrCodeAssociationAlreadyExists for service response error code
	// "AssociationAlreadyExists".
	//
	// The specified association already exists.
	ErrCodeAssociationAlreadyExists = "AssociationAlreadyExists"

	// ErrCodeAssociationDoesNotExist for service response error code
	// "AssociationDoesNotExist".
	//
	// The specified association does not exist.
	ErrCodeAssociationDoesNotExist = "AssociationDoesNotExist"

	// ErrCodeAssociationExecutionDoesNotExist for service response error code
	// "AssociationExecutionDoesNotExist".
	//
	// The specified execution ID does not exist. Verify the ID number and try again.
	ErrCodeAssociationExecutionDoesNotExist = "AssociationExecutionDoesNotExist"

	// ErrCodeAssociationLimitExceeded for service response error code
	// "AssociationLimitExceeded".
	//
	// You can have at most 2,000 active associations.
	ErrCodeAssociationLimitExceeded = "AssociationLimitExceeded"

	// ErrCodeAssociationVersionLimitExceeded for service response error code
	// "AssociationVersionLimitExceeded".
	//
	// You have reached the maximum number versions allowed for an association.
	// Each association has a limit of 1,000 versions.
	ErrCodeAssociationVersionLimitExceeded = "AssociationVersionLimitExceeded"

	// ErrCodeAutomationDefinitionNotFoundException for service response error code
	// "AutomationDefinitionNotFoundException".
	//
	// An Automation document with the specified name could not be found.
	ErrCodeAutomationDefinitionNotFoundException = "AutomationDefinitionNotFoundException"

	// ErrCodeAutomationDefinitionVersionNotFoundException for service response error code
	// "AutomationDefinitionVersionNotFoundException".
	//
	// An Automation document with the specified name and version could not be found.
	ErrCodeAutomationDefinitionVersionNotFoundException = "AutomationDefinitionVersionNotFoundException"

	// ErrCodeAutomationExecutionLimitExceededException for service response error code
	// "AutomationExecutionLimitExceededException".
	//
	// The number of simultaneously running Automation executions exceeded the allowable
	// limit.
	ErrCodeAutomationExecutionLimitExceededException = "AutomationExecutionLimitExceededException"

	// ErrCodeAutomationExecutionNotFoundException for service response error code
	// "AutomationExecutionNotFoundException".
	//
	// There is no automation execution information for the requested automation
	// execution ID.
	ErrCodeAutomationExecutionNotFoundException = "AutomationExecutionNotFoundException"

	// ErrCodeAutomationStepNotFoundException for service response error code
	// "AutomationStepNotFoundException".
	//
	// The specified step name and execution ID don't exist. Verify the information
	// and try again.
	ErrCodeAutomationStepNotFoundException = "AutomationStepNotFoundException"

	// ErrCodeComplianceTypeCountLimitExceededException for service response error code
	// "ComplianceTypeCountLimitExceededException".
	//
	// You specified too many custom compliance types. You can specify a maximum
	// of 10 different types.
	ErrCodeComplianceTypeCountLimitExceededException = "ComplianceTypeCountLimitExceededException"

	// ErrCodeCustomSchemaCountLimitExceededException for service response error code
	// "CustomSchemaCountLimitExceededException".
	//
	// You have exceeded the limit for custom schemas. Delete one or more custom
	// schemas and try again.
	ErrCodeCustomSchemaCountLimitExceededException = "CustomSchemaCountLimitExceededException"

	// ErrCodeDocumentAlreadyExists for service response error code
	// "DocumentAlreadyExists".
	//
	// The specified document already exists.
	ErrCodeDocumentAlreadyExists = "DocumentAlreadyExists"

	// ErrCodeDocumentLimitExceeded for service response error code
	// "DocumentLimitExceeded".
	//
	// You can have at most 500 active Systems Manager documents.
	ErrCodeDocumentLimitExceeded = "DocumentLimitExceeded"

	// ErrCodeDocumentPermissionLimit for service response error code
	// "DocumentPermissionLimit".
	//
	// The document cannot be shared with more AWS user accounts. You can share
	// a document with a maximum of 20 accounts. You can publicly share up to five
	// documents. If you need to increase this limit, contact AWS Support.
	ErrCodeDocumentPermissionLimit = "DocumentPermissionLimit"

	// ErrCodeDocumentVersionLimitExceeded for service response error code
	// "DocumentVersionLimitExceeded".
	//
	// The document has too many versions. Delete one or more document versions
	// and try again.
	ErrCodeDocumentVersionLimitExceeded = "DocumentVersionLimitExceeded"

	// ErrCodeDoesNotExistException for service response error code
	// "DoesNotExistException".
	//
	// Error returned when the ID specified for a resource, such as a maintenance
	// window or Patch baseline, doesn't exist.
	//
	// For information about resource limits in Systems Manager, see AWS Systems
	// Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).
	ErrCodeDoesNotExistException = "DoesNotExistException"

	// ErrCodeDuplicateDocumentContent for service response error code
	// "DuplicateDocumentContent".
	//
	// The content of the association document matches another document. Change
	// the content of the document and try again.
	ErrCodeDuplicateDocumentContent = "DuplicateDocumentContent"

	// ErrCodeDuplicateDocumentVersionName for service response error code
	// "DuplicateDocumentVersionName".
	//
	// The version name has already been used in this document. Specify a different
	// version name, and then try again.
	ErrCodeDuplicateDocumentVersionName = "DuplicateDocumentVersionName"

	// ErrCodeDuplicateInstanceId for service response error code
	// "DuplicateInstanceId".
	//
	// You cannot specify an instance ID in more than one association.
	ErrCodeDuplicateInstanceId = "DuplicateInstanceId"

	// ErrCodeFeatureNotAvailableException for service response error code
	// "FeatureNotAvailableException".
	//
	// You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where
	// the corresponding service is not available.
	ErrCodeFeatureNotAvailableException = "FeatureNotAvailableException"

	// ErrCodeHierarchyLevelLimitExceededException for service response error code
	// "HierarchyLevelLimitExceededException".
	//
	// A hierarchy can have a maximum of 15 levels. For more information, see Requirements
	// and Constraints for Parameter Names (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html)
	// in the AWS Systems Manager User Guide.
	ErrCodeHierarchyLevelLimitExceededException = "HierarchyLevelLimitExceededException"

	// ErrCodeHierarchyTypeMismatchException for service response error code
	// "HierarchyTypeMismatchException".
	//
	// Parameter Store does not support changing a parameter type in a hierarchy.
	// For example, you can't change a parameter from a String type to a SecureString
	// type. You must create a new, unique parameter.
	ErrCodeHierarchyTypeMismatchException = "HierarchyTypeMismatchException"

	// ErrCodeIdempotentParameterMismatch for service response error code
	// "IdempotentParameterMismatch".
	//
	// Error returned when an idempotent operation is retried and the parameters
	// don't match the original call to the API with the same idempotency token.
	ErrCodeIdempotentParameterMismatch = "IdempotentParameterMismatch"

	// ErrCodeIncompatiblePolicyException for service response error code
	// "IncompatiblePolicyException".
	//
	// There is a conflict in the policies specified for this parameter. You can't,
	// for example, specify two Expiration policies for a parameter. Review your
	// policies, and try again.
	ErrCodeIncompatiblePolicyException = "IncompatiblePolicyException"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// An error occurred on the server side.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidActivation for service response error code
	// "InvalidActivation".
	//
	// The activation is not valid. The activation might have been deleted, or the
	// ActivationId and the ActivationCode do not match.
	ErrCodeInvalidActivation = "InvalidActivation"

	// ErrCodeInvalidActivationId for service response error code
	// "InvalidActivationId".
	//
	// The activation ID is not valid. Verify the you entered the correct ActivationId
	// or ActivationCode and try again.
	ErrCodeInvalidActivationId = "InvalidActivationId"

	// ErrCodeInvalidAggregatorException for service response error code
	// "InvalidAggregatorException".
	//
	// The specified aggregator is not valid for inventory groups. Verify that the
	// aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
	ErrCodeInvalidAggregatorException = "InvalidAggregatorException"

	// ErrCodeInvalidAllowedPatternException for service response error code
	// "InvalidAllowedPatternException".
	//
	// The request does not meet the regular expression requirement.
	ErrCodeInvalidAllowedPatternException = "InvalidAllowedPatternException"

	// ErrCodeInvalidAssociation for service response error code
	// "InvalidAssociation".
	//
	// The association is not valid or does not exist.
	ErrCodeInvalidAssociation = "InvalidAssociation"

	// ErrCodeInvalidAssociationVersion for service response error code
	// "InvalidAssociationVersion".
	//
	// The version you specified is not valid. Use ListAssociationVersions to view
	// all versions of an association according to the association ID. Or, use the
	// $LATEST parameter to view the latest version of the association.
	ErrCodeInvalidAssociationVersion = "InvalidAssociationVersion"

	// ErrCodeInvalidAutomationExecutionParametersException for service response error code
	// "InvalidAutomationExecutionParametersException".
	//
	// The supplied parameters for invoking the specified Automation document are
	// incorrect. For example, they may not match the set of parameters permitted
	// for the specified Automation document.
	ErrCodeInvalidAutomationExecutionParametersException = "InvalidAutomationExecutionParametersException"

	// ErrCodeInvalidAutomationSignalException for service response error code
	// "InvalidAutomationSignalException".
	//
	// The signal is not valid for the current Automation execution.
	ErrCodeInvalidAutomationSignalException = "InvalidAutomationSignalException"

	// ErrCodeInvalidAutomationStatusUpdateException for service response error code
	// "InvalidAutomationStatusUpdateException".
	//
	// The specified update status operation is not valid.
	ErrCodeInvalidAutomationStatusUpdateException = "InvalidAutomationStatusUpdateException"

	// ErrCodeInvalidCommandId for service response error code
	// "InvalidCommandId".
	ErrCodeInvalidCommandId = "InvalidCommandId"

	// ErrCodeInvalidDeleteInventoryParametersException for service response error code
	// "InvalidDeleteInventoryParametersException".
	//
	// One or more of the parameters specified for the delete operation is not valid.
	// Verify all parameters and try again.
	ErrCodeInvalidDeleteInventoryParametersException = "InvalidDeleteInventoryParametersException"

	// ErrCodeInvalidDeletionIdException for service response error code
	// "InvalidDeletionIdException".
	//
	// The ID specified for the delete operation does not exist or is not valid.
	// Verify the ID and try again.
	ErrCodeInvalidDeletionIdException = "InvalidDeletionIdException"

	// ErrCodeInvalidDocument for service response error code
	// "InvalidDocument".
	//
	// The specified document does not exist.
	ErrCodeInvalidDocument = "InvalidDocument"

	// ErrCodeInvalidDocumentContent for service response error code
	// "InvalidDocumentContent".
	//
	// The content for the document is not valid.
	ErrCodeInvalidDocumentContent = "InvalidDocumentContent"

	// ErrCodeInvalidDocumentOperation for service response error code
	// "InvalidDocumentOperation".
	//
	// You attempted to delete a document while it is still shared. You must stop
	// sharing the document before you can delete it.
	ErrCodeInvalidDocumentOperation = "InvalidDocumentOperation"

	// ErrCodeInvalidDocumentSchemaVersion for service response error code
	// "InvalidDocumentSchemaVersion".
	//
	// The version of the document schema is not supported.
	ErrCodeInvalidDocumentSchemaVersion = "InvalidDocumentSchemaVersion"

	// ErrCodeInvalidDocumentVersion for service response error code
	// "InvalidDocumentVersion".
	//
	// The document version is not valid or does not exist.
	ErrCodeInvalidDocumentVersion = "InvalidDocumentVersion"

	// ErrCodeInvalidFilter for service response error code
	// "InvalidFilter".
	//
	// The filter name is not valid. Verify the you entered the correct name and
	// try again.
	ErrCodeInvalidFilter = "InvalidFilter"

	// ErrCodeInvalidFilterKey for service response error code
	// "InvalidFilterKey".
	//
	// The specified key is not valid.
	ErrCodeInvalidFilterKey = "InvalidFilterKey"

	// ErrCodeInvalidFilterOption for service response error code
	// "InvalidFilterOption".
	//
	// The specified filter option is not valid. Valid options are Equals and BeginsWith.
	// For Path filter, valid options are Recursive and OneLevel.
	ErrCodeInvalidFilterOption = "InvalidFilterOption"

	// ErrCodeInvalidFilterValue for service response error code
	// "InvalidFilterValue".
	//
	// The filter value is not valid. Verify the value and try again.
	ErrCodeInvalidFilterValue = "InvalidFilterValue"

	// ErrCodeInvalidInstanceId for service response error code
	// "InvalidInstanceId".
	//
	// The following problems can cause this exception:
	//
	// You do not have permission to access the instance.
	//
	// SSM Agent is not running. Verify that SSM Agent is running.
	//
	// SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
	//
	// The instance is not in valid state. Valid states are: Running, Pending, Stopped,
	// Stopping. Invalid states are: Shutting-down and Terminated.
	ErrCodeInvalidInstanceId = "InvalidInstanceId"

	// ErrCodeInvalidInstanceInformationFilterValue for service response error code
	// "InvalidInstanceInformationFilterValue".
	//
	// The specified filter value is not valid.
	ErrCodeInvalidInstanceInformationFilterValue = "InvalidInstanceInformationFilterValue"

	// ErrCodeInvalidInventoryGroupException for service response error code
	// "InvalidInventoryGroupException".
	//
	// The specified inventory group is not valid.
	ErrCodeInvalidInventoryGroupException = "InvalidInventoryGroupException"

	// ErrCodeInvalidInventoryItemContextException for service response error code
	// "InvalidInventoryItemContextException".
	//
	// You specified invalid keys or values in the Context attribute for InventoryItem.
	// Verify the keys and values, and try again.
	ErrCodeInvalidInventoryItemContextException = "InvalidInventoryItemContextException"

	// ErrCodeInvalidInventoryRequestException for service response error code
	// "InvalidInventoryRequestException".
	//
	// The request is not valid.
	ErrCodeInvalidInventoryRequestException = "InvalidInventoryRequestException"

	// ErrCodeInvalidItemContentException for service response error code
	// "InvalidItemContentException".
	//
	// One or more content items is not valid.
	ErrCodeInvalidItemContentException = "InvalidItemContentException"

	// ErrCodeInvalidKeyId for service response error code
	// "InvalidKeyId".
	//
	// The query key ID is not valid.
	ErrCodeInvalidKeyId = "InvalidKeyId"

	// ErrCodeInvalidNextToken for service response error code
	// "InvalidNextToken".
	//
	// The specified token is not valid.
	ErrCodeInvalidNextToken = "InvalidNextToken"

	// ErrCodeInvalidNotificationConfig for service response error code
	// "InvalidNotificationConfig".
	//
	// One or more configuration items is not valid. Verify that a valid Amazon
	// Resource Name (ARN) was provided for an Amazon SNS topic.
	ErrCodeInvalidNotificationConfig = "InvalidNotificationConfig"

	// ErrCodeInvalidOptionException for service response error code
	// "InvalidOptionException".
	//
	// The delete inventory option specified is not valid. Verify the option and
	// try again.
	ErrCodeInvalidOptionException = "InvalidOptionException"

	// ErrCodeInvalidOutputFolder for service response error code
	// "InvalidOutputFolder".
	//
	// The S3 bucket does not exist.
	ErrCodeInvalidOutputFolder = "InvalidOutputFolder"

	// ErrCodeInvalidOutputLocation for service response error code
	// "InvalidOutputLocation".
	//
	// The output location is not valid or does not exist.
	ErrCodeInvalidOutputLocation = "InvalidOutputLocation"

	// ErrCodeInvalidParameters for service response error code
	// "InvalidParameters".
	//
	// You must specify values for all required parameters in the Systems Manager
	// document. You can only supply values to parameters defined in the Systems
	// Manager document.
	ErrCodeInvalidParameters = "InvalidParameters"

	// ErrCodeInvalidPermissionType for service response error code
	// "InvalidPermissionType".
	//
	// The permission type is not supported. Share is the only supported permission
	// type.
	ErrCodeInvalidPermissionType = "InvalidPermissionType"

	// ErrCodeInvalidPluginName for service response error code
	// "InvalidPluginName".
	//
	// The plugin name is not valid.
	ErrCodeInvalidPluginName = "InvalidPluginName"

	// ErrCodeInvalidPolicyAttributeException for service response error code
	// "InvalidPolicyAttributeException".
	//
	// A policy attribute or its value is invalid.
	ErrCodeInvalidPolicyAttributeException = "InvalidPolicyAttributeException"

	// ErrCodeInvalidPolicyTypeException for service response error code
	// "InvalidPolicyTypeException".
	//
	// The policy type is not supported. Parameter Store supports the following
	// policy types: Expiration, ExpirationNotification, and NoChangeNotification.
	ErrCodeInvalidPolicyTypeException = "InvalidPolicyTypeException"

	// ErrCodeInvalidResourceId for service response error code
	// "InvalidResourceId".
	//
	// The resource ID is not valid. Verify that you entered the correct ID and
	// try again.
	ErrCodeInvalidResourceId = "InvalidResourceId"

	// ErrCodeInvalidResourceType for service response error code
	// "InvalidResourceType".
	//
	// The resource type is not valid. For example, if you are attempting to tag
	// an instance, the instance must be a registered, managed instance.
	ErrCodeInvalidResourceType = "InvalidResourceType"

	// ErrCodeInvalidResultAttributeException for service response error code
	// "InvalidResultAttributeException".
	//
	// The specified inventory item result attribute is not valid.
	ErrCodeInvalidResultAttributeException = "InvalidResultAttributeException"

	// ErrCodeInvalidRole for service response error code
	// "InvalidRole".
	//
	// The role name can't contain invalid characters. Also verify that you specified
	// an IAM role for notifications that includes the required trust policy. For
	// information about configuring the IAM role for Run Command notifications,
	// see Configuring Amazon SNS Notifications for Run Command (http://docs.aws.amazon.com/systems-manager/latest/userguide/rc-sns-notifications.html)
	// in the AWS Systems Manager User Guide.
	ErrCodeInvalidRole = "InvalidRole"

	// ErrCodeInvalidSchedule for service response error code
	// "InvalidSchedule".
	//
	// The schedule is invalid. Verify your cron or rate expression and try again.
	ErrCodeInvalidSchedule = "InvalidSchedule"

	// ErrCodeInvalidTarget for service response error code
	// "InvalidTarget".
	//
	// The target is not valid or does not exist. It might not be configured for
	// EC2 Systems Manager or you might not have permission to perform the operation.
	ErrCodeInvalidTarget = "InvalidTarget"

	// ErrCodeInvalidTypeNameException for service response error code
	// "InvalidTypeNameException".
	//
	// The parameter type name is not valid.
	ErrCodeInvalidTypeNameException = "InvalidTypeNameException"

	// ErrCodeInvalidUpdate for service response error code
	// "InvalidUpdate".
	//
	// The update is not valid.
	ErrCodeInvalidUpdate = "InvalidUpdate"

	// ErrCodeInvocationDoesNotExist for service response error code
	// "InvocationDoesNotExist".
	//
	// The command ID and instance ID you specified did not match any invocations.
	// Verify the command ID and the instance ID and try again.
	ErrCodeInvocationDoesNotExist = "InvocationDoesNotExist"

	// ErrCodeItemContentMismatchException for service response error code
	// "ItemContentMismatchException".
	//
	// The inventory item has invalid content.
	ErrCodeItemContentMismatchException = "ItemContentMismatchException"

	// ErrCodeItemSizeLimitExceededException for service response error code
	// "ItemSizeLimitExceededException".
	//
	// The inventory item size has exceeded the size limit.
	ErrCodeItemSizeLimitExceededException = "ItemSizeLimitExceededException"

	// ErrCodeMaxDocumentSizeExceeded for service response error code
	// "MaxDocumentSizeExceeded".
	//
	// The size limit of a document is 64 KB.
	ErrCodeMaxDocumentSizeExceeded = "MaxDocumentSizeExceeded"

	// ErrCodeOpsItemAlreadyExistsException for service response error code
	// "OpsItemAlreadyExistsException".
	//
	// The OpsItem already exists.
	ErrCodeOpsItemAlreadyExistsException = "OpsItemAlreadyExistsException"

	// ErrCodeOpsItemInvalidParameterException for service response error code
	// "OpsItemInvalidParameterException".
	//
	// A specified parameter argument isn't valid. Verify the available arguments
	// and try again.
	ErrCodeOpsItemInvalidParameterException = "OpsItemInvalidParameterException"

	// ErrCodeOpsItemLimitExceededException for service response error code
	// "OpsItemLimitExceededException".
	//
	// The request caused OpsItems to exceed one or more limits. For information
	// about OpsItem limits, see What are the resource limits for OpsCenter? (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits).
	ErrCodeOpsItemLimitExceededException = "OpsItemLimitExceededException"

	// ErrCodeOpsItemNotFoundException for service response error code
	// "OpsItemNotFoundException".
	//
	// The specified OpsItem ID doesn't exist. Verify the ID and try again.
	ErrCodeOpsItemNotFoundException = "OpsItemNotFoundException"

	// ErrCodeParameterAlreadyExists for service response error code
	// "ParameterAlreadyExists".
	//
	// The parameter already exists. You can't create duplicate parameters.
	ErrCodeParameterAlreadyExists = "ParameterAlreadyExists"

	// ErrCodeParameterLimitExceeded for service response error code
	// "ParameterLimitExceeded".
	//
	// You have exceeded the number of parameters for this AWS account. Delete one
	// or more parameters and try again.
	ErrCodeParameterLimitExceeded = "ParameterLimitExceeded"

	// ErrCodeParameterMaxVersionLimitExceeded for service response error code
	// "ParameterMaxVersionLimitExceeded".
	//
	// The parameter exceeded the maximum number of allowed versions.
	ErrCodeParameterMaxVersionLimitExceeded = "ParameterMaxVersionLimitExceeded"

	// ErrCodeParameterNotFound for service response error code
	// "ParameterNotFound".
	//
	// The parameter could not be found. Verify the name and try again.
	ErrCodeParameterNotFound = "ParameterNotFound"

	// ErrCodeParameterPatternMismatchException for service response error code
	// "ParameterPatternMismatchException".
	//
	// The parameter name is not valid.
	ErrCodeParameterPatternMismatchException = "ParameterPatternMismatchException"

	// ErrCodeParameterVersionLabelLimitExceeded for service response error code
	// "ParameterVersionLabelLimitExceeded".
	//
	// A parameter version can have a maximum of ten labels.
	ErrCodeParameterVersionLabelLimitExceeded = "ParameterVersionLabelLimitExceeded"

	// ErrCodeParameterVersionNotFound for service response error code
	// "ParameterVersionNotFound".
	//
	// The specified parameter version was not found. Verify the parameter name
	// and version, and try again.
	ErrCodeParameterVersionNotFound = "ParameterVersionNotFound"

	// ErrCodePoliciesLimitExceededException for service response error code
	// "PoliciesLimitExceededException".
	//
	// You specified more than the maximum number of allowed policies for the parameter.
	// The maximum is 10.
	ErrCodePoliciesLimitExceededException = "PoliciesLimitExceededException"

	// ErrCodeResourceDataSyncAlreadyExistsException for service response error code
	// "ResourceDataSyncAlreadyExistsException".
	//
	// A sync configuration with the same name already exists.
	ErrCodeResourceDataSyncAlreadyExistsException = "ResourceDataSyncAlreadyExistsException"

	// ErrCodeResourceDataSyncCountExceededException for service response error code
	// "ResourceDataSyncCountExceededException".
	//
	// You have exceeded the allowed maximum sync configurations.
	ErrCodeResourceDataSyncCountExceededException = "ResourceDataSyncCountExceededException"

	// ErrCodeResourceDataSyncInvalidConfigurationException for service response error code
	// "ResourceDataSyncInvalidConfigurationException".
	//
	// The specified sync configuration is invalid.
	ErrCodeResourceDataSyncInvalidConfigurationException = "ResourceDataSyncInvalidConfigurationException"

	// ErrCodeResourceDataSyncNotFoundException for service response error code
	// "ResourceDataSyncNotFoundException".
	//
	// The specified sync name was not found.
	ErrCodeResourceDataSyncNotFoundException = "ResourceDataSyncNotFoundException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// Error returned if an attempt is made to delete a patch baseline that is registered
	// for a patch group.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// Error returned when the caller has exceeded the default resource limits.
	// For example, too many maintenance windows or patch baselines have been created.
	//
	// For information about resource limits in Systems Manager, see AWS Systems
	// Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeServiceSettingNotFound for service response error code
	// "ServiceSettingNotFound".
	//
	// The specified service setting was not found. Either the service name or the
	// setting has not been provisioned by the AWS service team.
	ErrCodeServiceSettingNotFound = "ServiceSettingNotFound"

	// ErrCodeStatusUnchanged for service response error code
	// "StatusUnchanged".
	//
	// The updated status is the same as the current status.
	ErrCodeStatusUnchanged = "StatusUnchanged"

	// ErrCodeSubTypeCountLimitExceededException for service response error code
	// "SubTypeCountLimitExceededException".
	//
	// The sub-type count exceeded the limit for the inventory type.
	ErrCodeSubTypeCountLimitExceededException = "SubTypeCountLimitExceededException"

	// ErrCodeTargetInUseException for service response error code
	// "TargetInUseException".
	//
	// You specified the Safe option for the DeregisterTargetFromMaintenanceWindow
	// operation, but the target is still referenced in a task.
	ErrCodeTargetInUseException = "TargetInUseException"

	// ErrCodeTargetNotConnected for service response error code
	// "TargetNotConnected".
	//
	// The specified target instance for the session is not fully configured for
	// use with Session Manager. For more information, see Getting Started with
	// Session Manager (http://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html)
	// in the AWS Systems Manager User Guide.
	ErrCodeTargetNotConnected = "TargetNotConnected"

	// ErrCodeTooManyTagsError for service response error code
	// "TooManyTagsError".
	//
	// The Targets parameter includes too many tags. Remove one or more tags and
	// try the command again.
	ErrCodeTooManyTagsError = "TooManyTagsError"

	// ErrCodeTooManyUpdates for service response error code
	// "TooManyUpdates".
	//
	// There are concurrent updates for a resource that supports one update at a
	// time.
	ErrCodeTooManyUpdates = "TooManyUpdates"

	// ErrCodeTotalSizeLimitExceededException for service response error code
	// "TotalSizeLimitExceededException".
	//
	// The size of inventory data has exceeded the total size limit for the resource.
	ErrCodeTotalSizeLimitExceededException = "TotalSizeLimitExceededException"

	// ErrCodeUnsupportedFeatureRequiredException for service response error code
	// "UnsupportedFeatureRequiredException".
	//
	// Microsoft application patching is only available on EC2 instances and Advanced
	// Instances. To patch Microsoft applications on on-premises servers and VMs,
	// you must enable Advanced Instances. For more information, see Using the Advanced-Instances
	// Tier (http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html)
	// in the AWS Systems Manager User Guide.
	ErrCodeUnsupportedFeatureRequiredException = "UnsupportedFeatureRequiredException"

	// ErrCodeUnsupportedInventoryItemContextException for service response error code
	// "UnsupportedInventoryItemContextException".
	//
	// The Context attribute that you specified for the InventoryItem is not allowed
	// for this inventory type. You can only use the Context attribute with inventory
	// types like AWS:ComplianceItem.
	ErrCodeUnsupportedInventoryItemContextException = "UnsupportedInventoryItemContextException"

	// ErrCodeUnsupportedInventorySchemaVersionException for service response error code
	// "UnsupportedInventorySchemaVersionException".
	//
	// Inventory item type schema version has to match supported versions in the
	// service. Check output of GetInventorySchema to see the available schema version
	// for each type.
	ErrCodeUnsupportedInventorySchemaVersionException = "UnsupportedInventorySchemaVersionException"

	// ErrCodeUnsupportedOperatingSystem for service response error code
	// "UnsupportedOperatingSystem".
	//
	// The operating systems you specified is not supported, or the operation is
	// not supported for the operating system. Valid operating systems include:
	// Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.
	ErrCodeUnsupportedOperatingSystem = "UnsupportedOperatingSystem"

	// ErrCodeUnsupportedParameterType for service response error code
	// "UnsupportedParameterType".
	//
	// The parameter type is not supported.
	ErrCodeUnsupportedParameterType = "UnsupportedParameterType"

	// ErrCodeUnsupportedPlatformType for service response error code
	// "UnsupportedPlatformType".
	//
	// The document does not support the platform type of the given instance ID(s).
	// For example, you sent an document for a Windows instance to a Linux instance.
	ErrCodeUnsupportedPlatformType = "UnsupportedPlatformType"
)
View Source
const (
	ServiceName = "ssm"       // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "SSM"       // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source
const (
	// AttachmentHashTypeSha256 is a AttachmentHashType enum value
	AttachmentHashTypeSha256 = "Sha256"
)
View Source
const (
	// AttachmentsSourceKeySourceUrl is a AttachmentsSourceKey enum value
	AttachmentsSourceKeySourceUrl = "SourceUrl"
)
View Source
const (
	// DocumentPermissionTypeShare is a DocumentPermissionType enum value
	DocumentPermissionTypeShare = "Share"
)
View Source
const (
	// ResourceDataSyncS3FormatJsonSerDe is a ResourceDataSyncS3Format enum value
	ResourceDataSyncS3FormatJsonSerDe = "JsonSerDe"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Activation added in v1.2.2

type Activation struct {

	// The ID created by Systems Manager when you submitted the activation.
	ActivationId *string `type:"string"`

	// The date the activation was created.
	CreatedDate *time.Time `type:"timestamp"`

	// A name for the managed instance when it is created.
	DefaultInstanceName *string `type:"string"`

	// A user defined description of the activation.
	Description *string `type:"string"`

	// The date when this activation can no longer be used to register managed instances.
	ExpirationDate *time.Time `type:"timestamp"`

	// Whether or not the activation is expired.
	Expired *bool `type:"boolean"`

	// The Amazon Identity and Access Management (IAM) role to assign to the managed
	// instance.
	IamRole *string `type:"string"`

	// The maximum number of managed instances that can be registered using this
	// activation.
	RegistrationLimit *int64 `min:"1" type:"integer"`

	// The number of managed instances already registered with this activation.
	RegistrationsCount *int64 `min:"1" type:"integer"`

	// Tags assigned to the activation.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.

func (Activation) GoString added in v1.2.2

func (s Activation) GoString() string

GoString returns the string representation

func (*Activation) SetActivationId added in v1.5.0

func (s *Activation) SetActivationId(v string) *Activation

SetActivationId sets the ActivationId field's value.

func (*Activation) SetCreatedDate added in v1.5.0

func (s *Activation) SetCreatedDate(v time.Time) *Activation

SetCreatedDate sets the CreatedDate field's value.

func (*Activation) SetDefaultInstanceName added in v1.5.0

func (s *Activation) SetDefaultInstanceName(v string) *Activation

SetDefaultInstanceName sets the DefaultInstanceName field's value.

func (*Activation) SetDescription added in v1.5.0

func (s *Activation) SetDescription(v string) *Activation

SetDescription sets the Description field's value.

func (*Activation) SetExpirationDate added in v1.5.0

func (s *Activation) SetExpirationDate(v time.Time) *Activation

SetExpirationDate sets the ExpirationDate field's value.

func (*Activation) SetExpired added in v1.5.0

func (s *Activation) SetExpired(v bool) *Activation

SetExpired sets the Expired field's value.

func (*Activation) SetIamRole added in v1.5.0

func (s *Activation) SetIamRole(v string) *Activation

SetIamRole sets the IamRole field's value.

func (*Activation) SetRegistrationLimit added in v1.5.0

func (s *Activation) SetRegistrationLimit(v int64) *Activation

SetRegistrationLimit sets the RegistrationLimit field's value.

func (*Activation) SetRegistrationsCount added in v1.5.0

func (s *Activation) SetRegistrationsCount(v int64) *Activation

SetRegistrationsCount sets the RegistrationsCount field's value.

func (*Activation) SetTags added in v1.99.0

func (s *Activation) SetTags(v []*Tag) *Activation

SetTags sets the Tags field's value.

func (Activation) String added in v1.2.2

func (s Activation) String() string

String returns the string representation

type AddTagsToResourceInput added in v1.2.2

type AddTagsToResourceInput struct {

	// The resource ID you want to tag.
	//
	// Use the ID of the resource. Here are some examples:
	//
	// ManagedInstance: mi-012345abcde
	//
	// MaintenanceWindow: mw-012345abcde
	//
	// PatchBaseline: pb-012345abcde
	//
	// For the Document and Parameter values, use the name of the resource.
	//
	// The ManagedInstance type for this API action is only for on-premises managed
	// instances. You must specify the name of the managed instance in the following
	// format: mi-ID_number. For example, mi-1a2b3c4d5e6f.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// Specifies the type of resource you are tagging.
	//
	// The ManagedInstance type for this API action is for on-premises managed instances.
	// You must specify the name of the managed instance in the following format:
	// mi-ID_number. For example, mi-1a2b3c4d5e6f.
	//
	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true" enum:"ResourceTypeForTagging"`

	// One or more tags. The value parameter is required, but if you don't want
	// the tag to have a value, specify the parameter with no value, and we set
	// the value to an empty string.
	//
	// Do not enter personally identifiable information in this field.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddTagsToResourceInput) GoString added in v1.2.2

func (s AddTagsToResourceInput) GoString() string

GoString returns the string representation

func (*AddTagsToResourceInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*AddTagsToResourceInput) SetResourceType added in v1.5.0

func (s *AddTagsToResourceInput) SetResourceType(v string) *AddTagsToResourceInput

SetResourceType sets the ResourceType field's value.

func (*AddTagsToResourceInput) SetTags added in v1.5.0

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String added in v1.2.2

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate added in v1.2.2

func (s *AddTagsToResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddTagsToResourceOutput added in v1.2.2

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

func (AddTagsToResourceOutput) GoString added in v1.2.2

func (s AddTagsToResourceOutput) GoString() string

GoString returns the string representation

func (AddTagsToResourceOutput) String added in v1.2.2

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type Association

type Association struct {

	// The ID created by the system when you create an association. An association
	// is a binding between a document and a set of targets with a schedule.
	AssociationId *string `type:"string"`

	// The association name.
	AssociationName *string `type:"string"`

	// The association version.
	AssociationVersion *string `type:"string"`

	// The version of the document used in the association.
	DocumentVersion *string `type:"string"`

	// The ID of the instance.
	InstanceId *string `type:"string"`

	// The date on which the association was last run.
	LastExecutionDate *time.Time `type:"timestamp"`

	// The name of the Systems Manager document.
	Name *string `type:"string"`

	// Information about the association.
	Overview *AssociationOverview `type:"structure"`

	// A cron expression that specifies a schedule when the association runs.
	ScheduleExpression *string `min:"1" type:"string"`

	// The instances targeted by the request to create an association.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

Describes an association of a Systems Manager document and an instance.

func (Association) GoString added in v0.6.5

func (s Association) GoString() string

GoString returns the string representation

func (*Association) SetAssociationId added in v1.5.13

func (s *Association) SetAssociationId(v string) *Association

SetAssociationId sets the AssociationId field's value.

func (*Association) SetAssociationName added in v1.10.30

func (s *Association) SetAssociationName(v string) *Association

SetAssociationName sets the AssociationName field's value.

func (*Association) SetAssociationVersion added in v1.10.30

func (s *Association) SetAssociationVersion(v string) *Association

SetAssociationVersion sets the AssociationVersion field's value.

func (*Association) SetDocumentVersion added in v1.5.13

func (s *Association) SetDocumentVersion(v string) *Association

SetDocumentVersion sets the DocumentVersion field's value.

func (*Association) SetInstanceId added in v1.5.0

func (s *Association) SetInstanceId(v string) *Association

SetInstanceId sets the InstanceId field's value.

func (*Association) SetLastExecutionDate added in v1.5.13

func (s *Association) SetLastExecutionDate(v time.Time) *Association

SetLastExecutionDate sets the LastExecutionDate field's value.

func (*Association) SetName added in v1.5.0

func (s *Association) SetName(v string) *Association

SetName sets the Name field's value.

func (*Association) SetOverview added in v1.5.13

func (s *Association) SetOverview(v *AssociationOverview) *Association

SetOverview sets the Overview field's value.

func (*Association) SetScheduleExpression added in v1.5.13

func (s *Association) SetScheduleExpression(v string) *Association

SetScheduleExpression sets the ScheduleExpression field's value.

func (*Association) SetTargets added in v1.5.13

func (s *Association) SetTargets(v []*Target) *Association

SetTargets sets the Targets field's value.

func (Association) String added in v0.6.5

func (s Association) String() string

String returns the string representation

type AssociationDescription

type AssociationDescription struct {

	// The association ID.
	AssociationId *string `type:"string"`

	// The association name.
	AssociationName *string `type:"string"`

	// The association version.
	AssociationVersion *string `type:"string"`

	// Specify the target for the association. This target is required for associations
	// that use an Automation document and target resources by using rate controls.
	AutomationTargetParameterName *string `min:"1" type:"string"`

	// The severity level that is assigned to the association.
	ComplianceSeverity *string `type:"string" enum:"AssociationComplianceSeverity"`

	// The date when the association was made.
	Date *time.Time `type:"timestamp"`

	// The document version.
	DocumentVersion *string `type:"string"`

	// The ID of the instance.
	InstanceId *string `type:"string"`

	// The date on which the association was last run.
	LastExecutionDate *time.Time `type:"timestamp"`

	// The last date on which the association was successfully run.
	LastSuccessfulExecutionDate *time.Time `type:"timestamp"`

	// The date when the association was last updated.
	LastUpdateAssociationDate *time.Time `type:"timestamp"`

	// The maximum number of targets allowed to run the association at the same
	// time. You can specify a number, for example 10, or a percentage of the target
	// set, for example 10%. The default value is 100%, which means all targets
	// run the association at the same time.
	//
	// If a new instance starts and attempts to run an association while Systems
	// Manager is running MaxConcurrency associations, the association is allowed
	// to run. During the next association interval, the new instance will process
	// its association within the limit specified for MaxConcurrency.
	MaxConcurrency *string `min:"1" type:"string"`

	// The number of errors that are allowed before the system stops sending requests
	// to run the association on additional targets. You can specify either an absolute
	// number of errors, for example 10, or a percentage of the target set, for
	// example 10%. If you specify 3, for example, the system stops sending requests
	// when the fourth error is received. If you specify 0, then the system stops
	// sending requests after the first error is returned. If you run an association
	// on 50 instances and set MaxError to 10%, then the system stops sending the
	// request when the sixth error is received.
	//
	// Executions that are already running an association when MaxErrors is reached
	// are allowed to complete, but some of these executions may fail as well. If
	// you need to ensure that there won't be more than max-errors failed executions,
	// set MaxConcurrency to 1 so that executions proceed one at a time.
	MaxErrors *string `min:"1" type:"string"`

	// The name of the Systems Manager document.
	Name *string `type:"string"`

	// An Amazon S3 bucket where you want to store the output details of the request.
	OutputLocation *InstanceAssociationOutputLocation `type:"structure"`

	// Information about the association.
	Overview *AssociationOverview `type:"structure"`

	// A description of the parameters for a document.
	Parameters map[string][]*string `type:"map"`

	// A cron expression that specifies a schedule when the association runs.
	ScheduleExpression *string `min:"1" type:"string"`

	// The association status.
	Status *AssociationStatus `type:"structure"`

	// The instances targeted by the request.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

Describes the parameters for a document.

func (AssociationDescription) GoString added in v0.6.5

func (s AssociationDescription) GoString() string

GoString returns the string representation

func (*AssociationDescription) SetAssociationId added in v1.5.13

func (s *AssociationDescription) SetAssociationId(v string) *AssociationDescription

SetAssociationId sets the AssociationId field's value.

func (*AssociationDescription) SetAssociationName added in v1.10.30

func (s *AssociationDescription) SetAssociationName(v string) *AssociationDescription

SetAssociationName sets the AssociationName field's value.

func (*AssociationDescription) SetAssociationVersion added in v1.10.30

func (s *AssociationDescription) SetAssociationVersion(v string) *AssociationDescription

SetAssociationVersion sets the AssociationVersion field's value.

func (*AssociationDescription) SetAutomationTargetParameterName added in v1.99.0

func (s *AssociationDescription) SetAutomationTargetParameterName(v string) *AssociationDescription

SetAutomationTargetParameterName sets the AutomationTargetParameterName field's value.

func (*AssociationDescription) SetComplianceSeverity added in v1.99.0

func (s *AssociationDescription) SetComplianceSeverity(v string) *AssociationDescription

SetComplianceSeverity sets the ComplianceSeverity field's value.

func (*AssociationDescription) SetDate added in v1.5.0

SetDate sets the Date field's value.

func (*AssociationDescription) SetDocumentVersion added in v1.5.13

func (s *AssociationDescription) SetDocumentVersion(v string) *AssociationDescription

SetDocumentVersion sets the DocumentVersion field's value.

func (*AssociationDescription) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*AssociationDescription) SetLastExecutionDate added in v1.5.13

func (s *AssociationDescription) SetLastExecutionDate(v time.Time) *AssociationDescription

SetLastExecutionDate sets the LastExecutionDate field's value.

func (*AssociationDescription) SetLastSuccessfulExecutionDate added in v1.5.13

func (s *AssociationDescription) SetLastSuccessfulExecutionDate(v time.Time) *AssociationDescription

SetLastSuccessfulExecutionDate sets the LastSuccessfulExecutionDate field's value.

func (*AssociationDescription) SetLastUpdateAssociationDate added in v1.5.13

func (s *AssociationDescription) SetLastUpdateAssociationDate(v time.Time) *AssociationDescription

SetLastUpdateAssociationDate sets the LastUpdateAssociationDate field's value.

func (*AssociationDescription) SetMaxConcurrency added in v1.99.0

func (s *AssociationDescription) SetMaxConcurrency(v string) *AssociationDescription

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*AssociationDescription) SetMaxErrors added in v1.99.0

SetMaxErrors sets the MaxErrors field's value.

func (*AssociationDescription) SetName added in v1.5.0

SetName sets the Name field's value.

func (*AssociationDescription) SetOutputLocation added in v1.5.13

SetOutputLocation sets the OutputLocation field's value.

func (*AssociationDescription) SetOverview added in v1.5.13

SetOverview sets the Overview field's value.

func (*AssociationDescription) SetParameters added in v1.5.0

func (s *AssociationDescription) SetParameters(v map[string][]*string) *AssociationDescription

SetParameters sets the Parameters field's value.

func (*AssociationDescription) SetScheduleExpression added in v1.5.13

func (s *AssociationDescription) SetScheduleExpression(v string) *AssociationDescription

SetScheduleExpression sets the ScheduleExpression field's value.

func (*AssociationDescription) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*AssociationDescription) SetTargets added in v1.5.13

SetTargets sets the Targets field's value.

func (AssociationDescription) String added in v0.6.5

func (s AssociationDescription) String() string

String returns the string representation

type AssociationExecution added in v1.14.18

type AssociationExecution struct {

	// The association ID.
	AssociationId *string `type:"string"`

	// The association version.
	AssociationVersion *string `type:"string"`

	// The time the execution started.
	CreatedTime *time.Time `type:"timestamp"`

	// Detailed status information about the execution.
	DetailedStatus *string `type:"string"`

	// The execution ID for the association.
	ExecutionId *string `type:"string"`

	// The date of the last execution.
	LastExecutionDate *time.Time `type:"timestamp"`

	// An aggregate status of the resources in the execution based on the status
	// type.
	ResourceCountByStatus *string `type:"string"`

	// The status of the association execution.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Includes information about the specified association.

func (AssociationExecution) GoString added in v1.14.18

func (s AssociationExecution) GoString() string

GoString returns the string representation

func (*AssociationExecution) SetAssociationId added in v1.14.18

func (s *AssociationExecution) SetAssociationId(v string) *AssociationExecution

SetAssociationId sets the AssociationId field's value.

func (*AssociationExecution) SetAssociationVersion added in v1.14.18

func (s *AssociationExecution) SetAssociationVersion(v string) *AssociationExecution

SetAssociationVersion sets the AssociationVersion field's value.

func (*AssociationExecution) SetCreatedTime added in v1.14.18

func (s *AssociationExecution) SetCreatedTime(v time.Time) *AssociationExecution

SetCreatedTime sets the CreatedTime field's value.

func (*AssociationExecution) SetDetailedStatus added in v1.14.18

func (s *AssociationExecution) SetDetailedStatus(v string) *AssociationExecution

SetDetailedStatus sets the DetailedStatus field's value.

func (*AssociationExecution) SetExecutionId added in v1.14.18

func (s *AssociationExecution) SetExecutionId(v string) *AssociationExecution

SetExecutionId sets the ExecutionId field's value.

func (*AssociationExecution) SetLastExecutionDate added in v1.14.18

func (s *AssociationExecution) SetLastExecutionDate(v time.Time) *AssociationExecution

SetLastExecutionDate sets the LastExecutionDate field's value.

func (*AssociationExecution) SetResourceCountByStatus added in v1.14.18

func (s *AssociationExecution) SetResourceCountByStatus(v string) *AssociationExecution

SetResourceCountByStatus sets the ResourceCountByStatus field's value.

func (*AssociationExecution) SetStatus added in v1.14.18

SetStatus sets the Status field's value.

func (AssociationExecution) String added in v1.14.18

func (s AssociationExecution) String() string

String returns the string representation

type AssociationExecutionFilter added in v1.14.18

type AssociationExecutionFilter struct {

	// The key value used in the request.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"AssociationExecutionFilterKey"`

	// The filter type specified in the request.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"AssociationFilterOperatorType"`

	// The value specified for the key.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Filters used in the request.

func (AssociationExecutionFilter) GoString added in v1.14.18

func (s AssociationExecutionFilter) GoString() string

GoString returns the string representation

func (*AssociationExecutionFilter) SetKey added in v1.14.18

SetKey sets the Key field's value.

func (*AssociationExecutionFilter) SetType added in v1.14.18

SetType sets the Type field's value.

func (*AssociationExecutionFilter) SetValue added in v1.14.18

SetValue sets the Value field's value.

func (AssociationExecutionFilter) String added in v1.14.18

String returns the string representation

func (*AssociationExecutionFilter) Validate added in v1.14.18

func (s *AssociationExecutionFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociationExecutionTarget added in v1.14.18

type AssociationExecutionTarget struct {

	// The association ID.
	AssociationId *string `type:"string"`

	// The association version.
	AssociationVersion *string `type:"string"`

	// Detailed information about the execution status.
	DetailedStatus *string `type:"string"`

	// The execution ID.
	ExecutionId *string `type:"string"`

	// The date of the last execution.
	LastExecutionDate *time.Time `type:"timestamp"`

	// The location where the association details are saved.
	OutputSource *OutputSource `type:"structure"`

	// The resource ID, for example, the instance ID where the association ran.
	ResourceId *string `min:"1" type:"string"`

	// The resource type, for example, instance.
	ResourceType *string `min:"1" type:"string"`

	// The association execution status.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Includes information about the specified association execution.

func (AssociationExecutionTarget) GoString added in v1.14.18

func (s AssociationExecutionTarget) GoString() string

GoString returns the string representation

func (*AssociationExecutionTarget) SetAssociationId added in v1.14.18

SetAssociationId sets the AssociationId field's value.

func (*AssociationExecutionTarget) SetAssociationVersion added in v1.14.18

func (s *AssociationExecutionTarget) SetAssociationVersion(v string) *AssociationExecutionTarget

SetAssociationVersion sets the AssociationVersion field's value.

func (*AssociationExecutionTarget) SetDetailedStatus added in v1.14.18

SetDetailedStatus sets the DetailedStatus field's value.

func (*AssociationExecutionTarget) SetExecutionId added in v1.14.18

SetExecutionId sets the ExecutionId field's value.

func (*AssociationExecutionTarget) SetLastExecutionDate added in v1.14.18

func (s *AssociationExecutionTarget) SetLastExecutionDate(v time.Time) *AssociationExecutionTarget

SetLastExecutionDate sets the LastExecutionDate field's value.

func (*AssociationExecutionTarget) SetOutputSource added in v1.14.18

SetOutputSource sets the OutputSource field's value.

func (*AssociationExecutionTarget) SetResourceId added in v1.14.18

SetResourceId sets the ResourceId field's value.

func (*AssociationExecutionTarget) SetResourceType added in v1.14.18

SetResourceType sets the ResourceType field's value.

func (*AssociationExecutionTarget) SetStatus added in v1.14.18

SetStatus sets the Status field's value.

func (AssociationExecutionTarget) String added in v1.14.18

String returns the string representation

type AssociationExecutionTargetsFilter added in v1.14.18

type AssociationExecutionTargetsFilter struct {

	// The key value used in the request.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"AssociationExecutionTargetsFilterKey"`

	// The value specified for the key.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Filters for the association execution.

func (AssociationExecutionTargetsFilter) GoString added in v1.14.18

GoString returns the string representation

func (*AssociationExecutionTargetsFilter) SetKey added in v1.14.18

SetKey sets the Key field's value.

func (*AssociationExecutionTargetsFilter) SetValue added in v1.14.18

SetValue sets the Value field's value.

func (AssociationExecutionTargetsFilter) String added in v1.14.18

String returns the string representation

func (*AssociationExecutionTargetsFilter) Validate added in v1.14.18

Validate inspects the fields of the type to determine if they are valid.

type AssociationFilter

type AssociationFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true" enum:"AssociationFilterKey"`

	// The filter value.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a filter.

func (AssociationFilter) GoString added in v0.6.5

func (s AssociationFilter) GoString() string

GoString returns the string representation

func (*AssociationFilter) SetKey added in v1.5.0

SetKey sets the Key field's value.

func (*AssociationFilter) SetValue added in v1.5.0

func (s *AssociationFilter) SetValue(v string) *AssociationFilter

SetValue sets the Value field's value.

func (AssociationFilter) String added in v0.6.5

func (s AssociationFilter) String() string

String returns the string representation

func (*AssociationFilter) Validate added in v1.1.21

func (s *AssociationFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociationOverview added in v1.5.13

type AssociationOverview struct {

	// Returns the number of targets for the association status. For example, if
	// you created an association with two instances, and one of them was successful,
	// this would return the count of instances by status.
	AssociationStatusAggregatedCount map[string]*int64 `type:"map"`

	// A detailed status of the association.
	DetailedStatus *string `type:"string"`

	// The status of the association. Status can be: Pending, Success, or Failed.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the association.

func (AssociationOverview) GoString added in v1.5.13

func (s AssociationOverview) GoString() string

GoString returns the string representation

func (*AssociationOverview) SetAssociationStatusAggregatedCount added in v1.5.13

func (s *AssociationOverview) SetAssociationStatusAggregatedCount(v map[string]*int64) *AssociationOverview

SetAssociationStatusAggregatedCount sets the AssociationStatusAggregatedCount field's value.

func (*AssociationOverview) SetDetailedStatus added in v1.5.13

func (s *AssociationOverview) SetDetailedStatus(v string) *AssociationOverview

SetDetailedStatus sets the DetailedStatus field's value.

func (*AssociationOverview) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (AssociationOverview) String added in v1.5.13

func (s AssociationOverview) String() string

String returns the string representation

type AssociationStatus

type AssociationStatus struct {

	// A user-defined string.
	AdditionalInfo *string `type:"string"`

	// The date when the status changed.
	//
	// Date is a required field
	Date *time.Time `type:"timestamp" required:"true"`

	// The reason for the status.
	//
	// Message is a required field
	Message *string `min:"1" type:"string" required:"true"`

	// The status.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"AssociationStatusName"`
	// contains filtered or unexported fields
}

Describes an association status.

func (AssociationStatus) GoString added in v0.6.5

func (s AssociationStatus) GoString() string

GoString returns the string representation

func (*AssociationStatus) SetAdditionalInfo added in v1.5.0

func (s *AssociationStatus) SetAdditionalInfo(v string) *AssociationStatus

SetAdditionalInfo sets the AdditionalInfo field's value.

func (*AssociationStatus) SetDate added in v1.5.0

SetDate sets the Date field's value.

func (*AssociationStatus) SetMessage added in v1.5.0

func (s *AssociationStatus) SetMessage(v string) *AssociationStatus

SetMessage sets the Message field's value.

func (*AssociationStatus) SetName added in v1.5.0

SetName sets the Name field's value.

func (AssociationStatus) String added in v0.6.5

func (s AssociationStatus) String() string

String returns the string representation

func (*AssociationStatus) Validate added in v1.1.21

func (s *AssociationStatus) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociationVersionInfo added in v1.10.30

type AssociationVersionInfo struct {

	// The ID created by the system when the association was created.
	AssociationId *string `type:"string"`

	// The name specified for the association version when the association version
	// was created.
	AssociationName *string `type:"string"`

	// The association version.
	AssociationVersion *string `type:"string"`

	// The severity level that is assigned to the association.
	ComplianceSeverity *string `type:"string" enum:"AssociationComplianceSeverity"`

	// The date the association version was created.
	CreatedDate *time.Time `type:"timestamp"`

	// The version of a Systems Manager document used when the association version
	// was created.
	DocumentVersion *string `type:"string"`

	// The maximum number of targets allowed to run the association at the same
	// time. You can specify a number, for example 10, or a percentage of the target
	// set, for example 10%. The default value is 100%, which means all targets
	// run the association at the same time.
	//
	// If a new instance starts and attempts to run an association while Systems
	// Manager is running MaxConcurrency associations, the association is allowed
	// to run. During the next association interval, the new instance will process
	// its association within the limit specified for MaxConcurrency.
	MaxConcurrency *string `min:"1" type:"string"`

	// The number of errors that are allowed before the system stops sending requests
	// to run the association on additional targets. You can specify either an absolute
	// number of errors, for example 10, or a percentage of the target set, for
	// example 10%. If you specify 3, for example, the system stops sending requests
	// when the fourth error is received. If you specify 0, then the system stops
	// sending requests after the first error is returned. If you run an association
	// on 50 instances and set MaxError to 10%, then the system stops sending the
	// request when the sixth error is received.
	//
	// Executions that are already running an association when MaxErrors is reached
	// are allowed to complete, but some of these executions may fail as well. If
	// you need to ensure that there won't be more than max-errors failed executions,
	// set MaxConcurrency to 1 so that executions proceed one at a time.
	MaxErrors *string `min:"1" type:"string"`

	// The name specified when the association was created.
	Name *string `type:"string"`

	// The location in Amazon S3 specified for the association when the association
	// version was created.
	OutputLocation *InstanceAssociationOutputLocation `type:"structure"`

	// Parameters specified when the association version was created.
	Parameters map[string][]*string `type:"map"`

	// The cron or rate schedule specified for the association when the association
	// version was created.
	ScheduleExpression *string `min:"1" type:"string"`

	// The targets specified for the association when the association version was
	// created.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

Information about the association version.

func (AssociationVersionInfo) GoString added in v1.10.30

func (s AssociationVersionInfo) GoString() string

GoString returns the string representation

func (*AssociationVersionInfo) SetAssociationId added in v1.10.30

func (s *AssociationVersionInfo) SetAssociationId(v string) *AssociationVersionInfo

SetAssociationId sets the AssociationId field's value.

func (*AssociationVersionInfo) SetAssociationName added in v1.10.30

func (s *AssociationVersionInfo) SetAssociationName(v string) *AssociationVersionInfo

SetAssociationName sets the AssociationName field's value.

func (*AssociationVersionInfo) SetAssociationVersion added in v1.10.30

func (s *AssociationVersionInfo) SetAssociationVersion(v string) *AssociationVersionInfo

SetAssociationVersion sets the AssociationVersion field's value.

func (*AssociationVersionInfo) SetComplianceSeverity added in v1.99.0

func (s *AssociationVersionInfo) SetComplianceSeverity(v string) *AssociationVersionInfo

SetComplianceSeverity sets the ComplianceSeverity field's value.

func (*AssociationVersionInfo) SetCreatedDate added in v1.10.30

SetCreatedDate sets the CreatedDate field's value.

func (*AssociationVersionInfo) SetDocumentVersion added in v1.10.30

func (s *AssociationVersionInfo) SetDocumentVersion(v string) *AssociationVersionInfo

SetDocumentVersion sets the DocumentVersion field's value.

func (*AssociationVersionInfo) SetMaxConcurrency added in v1.99.0

func (s *AssociationVersionInfo) SetMaxConcurrency(v string) *AssociationVersionInfo

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*AssociationVersionInfo) SetMaxErrors added in v1.99.0

SetMaxErrors sets the MaxErrors field's value.

func (*AssociationVersionInfo) SetName added in v1.10.30

SetName sets the Name field's value.

func (*AssociationVersionInfo) SetOutputLocation added in v1.10.30

SetOutputLocation sets the OutputLocation field's value.

func (*AssociationVersionInfo) SetParameters added in v1.10.30

func (s *AssociationVersionInfo) SetParameters(v map[string][]*string) *AssociationVersionInfo

SetParameters sets the Parameters field's value.

func (*AssociationVersionInfo) SetScheduleExpression added in v1.10.30

func (s *AssociationVersionInfo) SetScheduleExpression(v string) *AssociationVersionInfo

SetScheduleExpression sets the ScheduleExpression field's value.

func (*AssociationVersionInfo) SetTargets added in v1.10.30

SetTargets sets the Targets field's value.

func (AssociationVersionInfo) String added in v1.10.30

func (s AssociationVersionInfo) String() string

String returns the string representation

type AttachmentContent added in v1.99.0

type AttachmentContent struct {

	// The cryptographic hash value of the document content.
	Hash *string `type:"string"`

	// The hash algorithm used to calculate the hash value.
	HashType *string `type:"string" enum:"AttachmentHashType"`

	// The name of an attachment.
	Name *string `type:"string"`

	// The size of an attachment in bytes.
	Size *int64 `type:"long"`

	// The URL location of the attachment content.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that includes attributes that describe a document attachment.

func (AttachmentContent) GoString added in v1.99.0

func (s AttachmentContent) GoString() string

GoString returns the string representation

func (*AttachmentContent) SetHash added in v1.99.0

SetHash sets the Hash field's value.

func (*AttachmentContent) SetHashType added in v1.99.0

func (s *AttachmentContent) SetHashType(v string) *AttachmentContent

SetHashType sets the HashType field's value.

func (*AttachmentContent) SetName added in v1.99.0

SetName sets the Name field's value.

func (*AttachmentContent) SetSize added in v1.99.0

func (s *AttachmentContent) SetSize(v int64) *AttachmentContent

SetSize sets the Size field's value.

func (*AttachmentContent) SetUrl added in v1.99.0

SetUrl sets the Url field's value.

func (AttachmentContent) String added in v1.99.0

func (s AttachmentContent) String() string

String returns the string representation

type AttachmentInformation added in v1.99.0

type AttachmentInformation struct {

	// The name of the attachment.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

An attribute of an attachment, such as the attachment name.

func (AttachmentInformation) GoString added in v1.99.0

func (s AttachmentInformation) GoString() string

GoString returns the string representation

func (*AttachmentInformation) SetName added in v1.99.0

SetName sets the Name field's value.

func (AttachmentInformation) String added in v1.99.0

func (s AttachmentInformation) String() string

String returns the string representation

type AttachmentsSource added in v1.99.0

type AttachmentsSource struct {

	// The key of a key and value pair that identifies the location of an attachment
	// to a document.
	Key *string `type:"string" enum:"AttachmentsSourceKey"`

	// The URL of the location of a document attachment, such as the URL of an Amazon
	// S3 bucket.
	Values []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

A key and value pair that identifies the location of an attachment to a document.

func (AttachmentsSource) GoString added in v1.99.0

func (s AttachmentsSource) GoString() string

GoString returns the string representation

func (*AttachmentsSource) SetKey added in v1.99.0

SetKey sets the Key field's value.

func (*AttachmentsSource) SetValues added in v1.99.0

func (s *AttachmentsSource) SetValues(v []*string) *AttachmentsSource

SetValues sets the Values field's value.

func (AttachmentsSource) String added in v1.99.0

func (s AttachmentsSource) String() string

String returns the string representation

func (*AttachmentsSource) Validate added in v1.99.0

func (s *AttachmentsSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AutomationExecution added in v1.5.13

type AutomationExecution struct {

	// The execution ID.
	AutomationExecutionId *string `min:"36" type:"string"`

	// The execution status of the Automation.
	AutomationExecutionStatus *string `type:"string" enum:"AutomationExecutionStatus"`

	// The action of the step that is currently running.
	CurrentAction *string `type:"string"`

	// The name of the step that is currently running.
	CurrentStepName *string `type:"string"`

	// The name of the Automation document used during the execution.
	DocumentName *string `type:"string"`

	// The version of the document to use during execution.
	DocumentVersion *string `type:"string"`

	// The Amazon Resource Name (ARN) of the user who ran the automation.
	ExecutedBy *string `type:"string"`

	// The time the execution finished.
	ExecutionEndTime *time.Time `type:"timestamp"`

	// The time the execution started.
	ExecutionStartTime *time.Time `type:"timestamp"`

	// A message describing why an execution has failed, if the status is set to
	// Failed.
	FailureMessage *string `type:"string"`

	// The MaxConcurrency value specified by the user when the execution started.
	MaxConcurrency *string `min:"1" type:"string"`

	// The MaxErrors value specified by the user when the execution started.
	MaxErrors *string `min:"1" type:"string"`

	// The automation execution mode.
	Mode *string `type:"string" enum:"ExecutionMode"`

	// The list of execution outputs as defined in the automation document.
	Outputs map[string][]*string `min:"1" type:"map"`

	// The key-value map of execution parameters, which were supplied when calling
	// StartAutomationExecution.
	Parameters map[string][]*string `min:"1" type:"map"`

	// The AutomationExecutionId of the parent automation.
	ParentAutomationExecutionId *string `min:"36" type:"string"`

	// An aggregate of step execution statuses displayed in the AWS Console for
	// a multi-Region and multi-account Automation execution.
	ProgressCounters *ProgressCounters `type:"structure"`

	// A list of resolved targets in the rate control execution.
	ResolvedTargets *ResolvedTargets `type:"structure"`

	// A list of details about the current state of all steps that comprise an execution.
	// An Automation document contains a list of steps that are run in order.
	StepExecutions []*StepExecution `type:"list"`

	// A boolean value that indicates if the response contains the full list of
	// the Automation step executions. If true, use the DescribeAutomationStepExecutions
	// API action to get the full list of step executions.
	StepExecutionsTruncated *bool `type:"boolean"`

	// The target of the execution.
	Target *string `type:"string"`

	// The combination of AWS Regions and/or AWS accounts where you want to run
	// the Automation.
	TargetLocations []*TargetLocation `min:"1" type:"list"`

	// The specified key-value mapping of document parameters to target resources.
	TargetMaps []map[string][]*string `type:"list"`

	// The parameter name.
	TargetParameterName *string `min:"1" type:"string"`

	// The specified targets.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

Detailed information about the current state of an individual Automation execution.

func (AutomationExecution) GoString added in v1.5.13

func (s AutomationExecution) GoString() string

GoString returns the string representation

func (*AutomationExecution) SetAutomationExecutionId added in v1.5.13

func (s *AutomationExecution) SetAutomationExecutionId(v string) *AutomationExecution

SetAutomationExecutionId sets the AutomationExecutionId field's value.

func (*AutomationExecution) SetAutomationExecutionStatus added in v1.5.13

func (s *AutomationExecution) SetAutomationExecutionStatus(v string) *AutomationExecution

SetAutomationExecutionStatus sets the AutomationExecutionStatus field's value.

func (*AutomationExecution) SetCurrentAction added in v1.12.37

func (s *AutomationExecution) SetCurrentAction(v string) *AutomationExecution

SetCurrentAction sets the CurrentAction field's value.

func (*AutomationExecution) SetCurrentStepName added in v1.12.37

func (s *AutomationExecution) SetCurrentStepName(v string) *AutomationExecution

SetCurrentStepName sets the CurrentStepName field's value.

func (*AutomationExecution) SetDocumentName added in v1.5.13

func (s *AutomationExecution) SetDocumentName(v string) *AutomationExecution

SetDocumentName sets the DocumentName field's value.

func (*AutomationExecution) SetDocumentVersion added in v1.5.13

func (s *AutomationExecution) SetDocumentVersion(v string) *AutomationExecution

SetDocumentVersion sets the DocumentVersion field's value.

func (*AutomationExecution) SetExecutedBy added in v1.12.37

func (s *AutomationExecution) SetExecutedBy(v string) *AutomationExecution

SetExecutedBy sets the ExecutedBy field's value.

func (*AutomationExecution) SetExecutionEndTime added in v1.5.13

func (s *AutomationExecution) SetExecutionEndTime(v time.Time) *AutomationExecution

SetExecutionEndTime sets the ExecutionEndTime field's value.

func (*AutomationExecution) SetExecutionStartTime added in v1.5.13

func (s *AutomationExecution) SetExecutionStartTime(v time.Time) *AutomationExecution

SetExecutionStartTime sets the ExecutionStartTime field's value.

func (*AutomationExecution) SetFailureMessage added in v1.5.13

func (s *AutomationExecution) SetFailureMessage(v string) *AutomationExecution

SetFailureMessage sets the FailureMessage field's value.

func (*AutomationExecution) SetMaxConcurrency added in v1.12.37

func (s *AutomationExecution) SetMaxConcurrency(v string) *AutomationExecution

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*AutomationExecution) SetMaxErrors added in v1.12.37

func (s *AutomationExecution) SetMaxErrors(v string) *AutomationExecution

SetMaxErrors sets the MaxErrors field's value.

func (*AutomationExecution) SetMode added in v1.12.37

SetMode sets the Mode field's value.

func (*AutomationExecution) SetOutputs added in v1.5.13

func (s *AutomationExecution) SetOutputs(v map[string][]*string) *AutomationExecution

SetOutputs sets the Outputs field's value.

func (*AutomationExecution) SetParameters added in v1.5.13

func (s *AutomationExecution) SetParameters(v map[string][]*string) *AutomationExecution

SetParameters sets the Parameters field's value.

func (*AutomationExecution) SetParentAutomationExecutionId added in v1.12.37

func (s *AutomationExecution) SetParentAutomationExecutionId(v string) *AutomationExecution

SetParentAutomationExecutionId sets the ParentAutomationExecutionId field's value.

func (*AutomationExecution) SetProgressCounters added in v1.99.0

func (s *AutomationExecution) SetProgressCounters(v *ProgressCounters) *AutomationExecution

SetProgressCounters sets the ProgressCounters field's value.

func (*AutomationExecution) SetResolvedTargets added in v1.12.37

func (s *AutomationExecution) SetResolvedTargets(v *ResolvedTargets) *AutomationExecution

SetResolvedTargets sets the ResolvedTargets field's value.

func (*AutomationExecution) SetStepExecutions added in v1.5.13

func (s *AutomationExecution) SetStepExecutions(v []*StepExecution) *AutomationExecution

SetStepExecutions sets the StepExecutions field's value.

func (*AutomationExecution) SetStepExecutionsTruncated added in v1.12.37

func (s *AutomationExecution) SetStepExecutionsTruncated(v bool) *AutomationExecution

SetStepExecutionsTruncated sets the StepExecutionsTruncated field's value.

func (*AutomationExecution) SetTarget added in v1.12.37

SetTarget sets the Target field's value.

func (*AutomationExecution) SetTargetLocations added in v1.99.0

func (s *AutomationExecution) SetTargetLocations(v []*TargetLocation) *AutomationExecution

SetTargetLocations sets the TargetLocations field's value.

func (*AutomationExecution) SetTargetMaps added in v1.99.0

func (s *AutomationExecution) SetTargetMaps(v []map[string][]*string) *AutomationExecution

SetTargetMaps sets the TargetMaps field's value.

func (*AutomationExecution) SetTargetParameterName added in v1.12.37

func (s *AutomationExecution) SetTargetParameterName(v string) *AutomationExecution

SetTargetParameterName sets the TargetParameterName field's value.

func (*AutomationExecution) SetTargets added in v1.12.37

func (s *AutomationExecution) SetTargets(v []*Target) *AutomationExecution

SetTargets sets the Targets field's value.

func (AutomationExecution) String added in v1.5.13

func (s AutomationExecution) String() string

String returns the string representation

type AutomationExecutionFilter added in v1.5.13

type AutomationExecutionFilter struct {

	// One or more keys to limit the results. Valid filter keys include the following:
	// DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction,
	// StartTimeBefore, StartTimeAfter.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"AutomationExecutionFilterKey"`

	// The values used to limit the execution information associated with the filter's
	// key.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.

func (AutomationExecutionFilter) GoString added in v1.5.13

func (s AutomationExecutionFilter) GoString() string

GoString returns the string representation

func (*AutomationExecutionFilter) SetKey added in v1.5.13

SetKey sets the Key field's value.

func (*AutomationExecutionFilter) SetValues added in v1.5.13

SetValues sets the Values field's value.

func (AutomationExecutionFilter) String added in v1.5.13

func (s AutomationExecutionFilter) String() string

String returns the string representation

func (*AutomationExecutionFilter) Validate added in v1.5.13

func (s *AutomationExecutionFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AutomationExecutionMetadata added in v1.5.13

type AutomationExecutionMetadata struct {

	// The execution ID.
	AutomationExecutionId *string `min:"36" type:"string"`

	// The status of the execution. Valid values include: Running, Succeeded, Failed,
	// Timed out, or Cancelled.
	AutomationExecutionStatus *string `type:"string" enum:"AutomationExecutionStatus"`

	// Use this filter with DescribeAutomationExecutions. Specify either Local or
	// CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions
	// and accounts. For more information, see Executing Automations in Multiple
	// AWS Regions and Accounts (http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html)
	// in the AWS Systems Manager User Guide.
	AutomationType *string `type:"string" enum:"AutomationType"`

	// The action of the step that is currently running.
	CurrentAction *string `type:"string"`

	// The name of the step that is currently running.
	CurrentStepName *string `type:"string"`

	// The name of the Automation document used during execution.
	DocumentName *string `type:"string"`

	// The document version used during the execution.
	DocumentVersion *string `type:"string"`

	// The IAM role ARN of the user who ran the Automation.
	ExecutedBy *string `type:"string"`

	// The time the execution finished. This is not populated if the execution is
	// still in progress.
	ExecutionEndTime *time.Time `type:"timestamp"`

	// The time the execution started.>
	ExecutionStartTime *time.Time `type:"timestamp"`

	// The list of execution outputs as defined in the Automation document.
	FailureMessage *string `type:"string"`

	// An Amazon S3 bucket where execution information is stored.
	LogFile *string `type:"string"`

	// The MaxConcurrency value specified by the user when starting the Automation.
	MaxConcurrency *string `min:"1" type:"string"`

	// The MaxErrors value specified by the user when starting the Automation.
	MaxErrors *string `min:"1" type:"string"`

	// The Automation execution mode.
	Mode *string `type:"string" enum:"ExecutionMode"`

	// The list of execution outputs as defined in the Automation document.
	Outputs map[string][]*string `min:"1" type:"map"`

	// The ExecutionId of the parent Automation.
	ParentAutomationExecutionId *string `min:"36" type:"string"`

	// A list of targets that resolved during the execution.
	ResolvedTargets *ResolvedTargets `type:"structure"`

	// The list of execution outputs as defined in the Automation document.
	Target *string `type:"string"`

	// The specified key-value mapping of document parameters to target resources.
	TargetMaps []map[string][]*string `type:"list"`

	// The list of execution outputs as defined in the Automation document.
	TargetParameterName *string `min:"1" type:"string"`

	// The targets defined by the user when starting the Automation.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

Details about a specific Automation execution.

func (AutomationExecutionMetadata) GoString added in v1.5.13

func (s AutomationExecutionMetadata) GoString() string

GoString returns the string representation

func (*AutomationExecutionMetadata) SetAutomationExecutionId added in v1.5.13

func (s *AutomationExecutionMetadata) SetAutomationExecutionId(v string) *AutomationExecutionMetadata

SetAutomationExecutionId sets the AutomationExecutionId field's value.

func (*AutomationExecutionMetadata) SetAutomationExecutionStatus added in v1.5.13

func (s *AutomationExecutionMetadata) SetAutomationExecutionStatus(v string) *AutomationExecutionMetadata

SetAutomationExecutionStatus sets the AutomationExecutionStatus field's value.

func (*AutomationExecutionMetadata) SetAutomationType added in v1.99.0

SetAutomationType sets the AutomationType field's value.

func (*AutomationExecutionMetadata) SetCurrentAction added in v1.12.37

SetCurrentAction sets the CurrentAction field's value.

func (*AutomationExecutionMetadata) SetCurrentStepName added in v1.12.37

SetCurrentStepName sets the CurrentStepName field's value.

func (*AutomationExecutionMetadata) SetDocumentName added in v1.5.13

SetDocumentName sets the DocumentName field's value.

func (*AutomationExecutionMetadata) SetDocumentVersion added in v1.5.13

SetDocumentVersion sets the DocumentVersion field's value.

func (*AutomationExecutionMetadata) SetExecutedBy added in v1.5.13

SetExecutedBy sets the ExecutedBy field's value.

func (*AutomationExecutionMetadata) SetExecutionEndTime added in v1.5.13

SetExecutionEndTime sets the ExecutionEndTime field's value.

func (*AutomationExecutionMetadata) SetExecutionStartTime added in v1.5.13

SetExecutionStartTime sets the ExecutionStartTime field's value.

func (*AutomationExecutionMetadata) SetFailureMessage added in v1.12.37

SetFailureMessage sets the FailureMessage field's value.

func (*AutomationExecutionMetadata) SetLogFile added in v1.5.13

SetLogFile sets the LogFile field's value.

func (*AutomationExecutionMetadata) SetMaxConcurrency added in v1.12.37

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*AutomationExecutionMetadata) SetMaxErrors added in v1.12.37

SetMaxErrors sets the MaxErrors field's value.

func (*AutomationExecutionMetadata) SetMode added in v1.12.37

SetMode sets the Mode field's value.

func (*AutomationExecutionMetadata) SetOutputs added in v1.5.13

SetOutputs sets the Outputs field's value.

func (*AutomationExecutionMetadata) SetParentAutomationExecutionId added in v1.12.37

func (s *AutomationExecutionMetadata) SetParentAutomationExecutionId(v string) *AutomationExecutionMetadata

SetParentAutomationExecutionId sets the ParentAutomationExecutionId field's value.

func (*AutomationExecutionMetadata) SetResolvedTargets added in v1.12.37

SetResolvedTargets sets the ResolvedTargets field's value.

func (*AutomationExecutionMetadata) SetTarget added in v1.12.37

SetTarget sets the Target field's value.

func (*AutomationExecutionMetadata) SetTargetMaps added in v1.99.0

SetTargetMaps sets the TargetMaps field's value.

func (*AutomationExecutionMetadata) SetTargetParameterName added in v1.12.37

func (s *AutomationExecutionMetadata) SetTargetParameterName(v string) *AutomationExecutionMetadata

SetTargetParameterName sets the TargetParameterName field's value.

func (*AutomationExecutionMetadata) SetTargets added in v1.12.37

SetTargets sets the Targets field's value.

func (AutomationExecutionMetadata) String added in v1.5.13

String returns the string representation

type CancelCommandInput added in v0.9.17

type CancelCommandInput struct {

	// The ID of the command you want to cancel.
	//
	// CommandId is a required field
	CommandId *string `min:"36" type:"string" required:"true"`

	// (Optional) A list of instance IDs on which you want to cancel the command.
	// If not provided, the command is canceled on every instance on which it was
	// requested.
	InstanceIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (CancelCommandInput) GoString added in v0.9.17

func (s CancelCommandInput) GoString() string

GoString returns the string representation

func (*CancelCommandInput) SetCommandId added in v1.5.0

func (s *CancelCommandInput) SetCommandId(v string) *CancelCommandInput

SetCommandId sets the CommandId field's value.

func (*CancelCommandInput) SetInstanceIds added in v1.5.0

func (s *CancelCommandInput) SetInstanceIds(v []*string) *CancelCommandInput

SetInstanceIds sets the InstanceIds field's value.

func (CancelCommandInput) String added in v0.9.17

func (s CancelCommandInput) String() string

String returns the string representation

func (*CancelCommandInput) Validate added in v1.1.21

func (s *CancelCommandInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelCommandOutput added in v0.9.17

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

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

func (CancelCommandOutput) GoString added in v0.9.17

func (s CancelCommandOutput) GoString() string

GoString returns the string representation

func (CancelCommandOutput) String added in v0.9.17

func (s CancelCommandOutput) String() string

String returns the string representation

type CancelMaintenanceWindowExecutionInput added in v1.99.0

type CancelMaintenanceWindowExecutionInput struct {

	// The ID of the maintenance window execution to stop.
	//
	// WindowExecutionId is a required field
	WindowExecutionId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelMaintenanceWindowExecutionInput) GoString added in v1.99.0

GoString returns the string representation

func (*CancelMaintenanceWindowExecutionInput) SetWindowExecutionId added in v1.99.0

SetWindowExecutionId sets the WindowExecutionId field's value.

func (CancelMaintenanceWindowExecutionInput) String added in v1.99.0

String returns the string representation

func (*CancelMaintenanceWindowExecutionInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type CancelMaintenanceWindowExecutionOutput added in v1.99.0

type CancelMaintenanceWindowExecutionOutput struct {

	// The ID of the maintenance window execution that has been stopped.
	WindowExecutionId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CancelMaintenanceWindowExecutionOutput) GoString added in v1.99.0

GoString returns the string representation

func (*CancelMaintenanceWindowExecutionOutput) SetWindowExecutionId added in v1.99.0

SetWindowExecutionId sets the WindowExecutionId field's value.

func (CancelMaintenanceWindowExecutionOutput) String added in v1.99.0

String returns the string representation

type CloudWatchOutputConfig added in v1.14.6

type CloudWatchOutputConfig struct {

	// The name of the CloudWatch log group where you want to send command output.
	// If you don't specify a group name, Systems Manager automatically creates
	// a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.
	CloudWatchLogGroupName *string `min:"1" type:"string"`

	// Enables Systems Manager to send command output to CloudWatch Logs.
	CloudWatchOutputEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Configuration options for sending command output to CloudWatch Logs.

func (CloudWatchOutputConfig) GoString added in v1.14.6

func (s CloudWatchOutputConfig) GoString() string

GoString returns the string representation

func (*CloudWatchOutputConfig) SetCloudWatchLogGroupName added in v1.14.6

func (s *CloudWatchOutputConfig) SetCloudWatchLogGroupName(v string) *CloudWatchOutputConfig

SetCloudWatchLogGroupName sets the CloudWatchLogGroupName field's value.

func (*CloudWatchOutputConfig) SetCloudWatchOutputEnabled added in v1.14.6

func (s *CloudWatchOutputConfig) SetCloudWatchOutputEnabled(v bool) *CloudWatchOutputConfig

SetCloudWatchOutputEnabled sets the CloudWatchOutputEnabled field's value.

func (CloudWatchOutputConfig) String added in v1.14.6

func (s CloudWatchOutputConfig) String() string

String returns the string representation

func (*CloudWatchOutputConfig) Validate added in v1.14.6

func (s *CloudWatchOutputConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Command added in v0.9.17

type Command struct {

	// CloudWatch Logs information where you want Systems Manager to send the command
	// output.
	CloudWatchOutputConfig *CloudWatchOutputConfig `type:"structure"`

	// A unique identifier for this command.
	CommandId *string `min:"36" type:"string"`

	// User-specified information about the command, such as a brief description
	// of what the command should do.
	Comment *string `type:"string"`

	// The number of targets for which the command invocation reached a terminal
	// state. Terminal states include the following: Success, Failed, Execution
	// Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
	CompletedCount *int64 `type:"integer"`

	// The number of targets for which the status is Delivery Timed Out.
	DeliveryTimedOutCount *int64 `type:"integer"`

	// The name of the document requested for execution.
	DocumentName *string `type:"string"`

	// The SSM document version.
	DocumentVersion *string `type:"string"`

	// The number of targets for which the status is Failed or Execution Timed Out.
	ErrorCount *int64 `type:"integer"`

	// If this time is reached and the command has not already started running,
	// it will not run. Calculated based on the ExpiresAfter user input provided
	// as part of the SendCommand API.
	ExpiresAfter *time.Time `type:"timestamp"`

	// The instance IDs against which this command was requested.
	InstanceIds []*string `type:"list"`

	// The maximum number of instances that are allowed to run the command at the
	// same time. You can specify a number of instances, such as 10, or a percentage
	// of instances, such as 10%. The default value is 50. For more information
	// about how to use MaxConcurrency, see Running Commands Using Systems Manager
	// Run Command (http://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)
	// in the AWS Systems Manager User Guide.
	MaxConcurrency *string `min:"1" type:"string"`

	// The maximum number of errors allowed before the system stops sending the
	// command to additional targets. You can specify a number of errors, such as
	// 10, or a percentage or errors, such as 10%. The default value is 0. For more
	// information about how to use MaxErrors, see Running Commands Using Systems
	// Manager Run Command (http://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html)
	// in the AWS Systems Manager User Guide.
	MaxErrors *string `min:"1" type:"string"`

	// Configurations for sending notifications about command status changes.
	NotificationConfig *NotificationConfig `type:"structure"`

	// The S3 bucket where the responses to the command executions should be stored.
	// This was requested when issuing the command.
	OutputS3BucketName *string `min:"3" type:"string"`

	// The S3 directory path inside the bucket where the responses to the command
	// executions should be stored. This was requested when issuing the command.
	OutputS3KeyPrefix *string `type:"string"`

	// (Deprecated) You can no longer specify this parameter. The system ignores
	// it. Instead, Systems Manager automatically determines the Amazon S3 bucket
	// region.
	OutputS3Region *string `min:"3" type:"string"`

	// The parameter values to be inserted in the document when running the command.
	Parameters map[string][]*string `type:"map"`

	// The date and time the command was requested.
	RequestedDateTime *time.Time `type:"timestamp"`

	// The IAM service role that Run Command uses to act on your behalf when sending
	// notifications about command status changes.
	ServiceRole *string `type:"string"`

	// The status of the command.
	Status *string `type:"string" enum:"CommandStatus"`

	// A detailed status of the command execution. 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
	// (http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
	// in the AWS Systems Manager User Guide. StatusDetails can be one of the following
	// values:
	//
	//    * Pending: The command has not been sent to any instances.
	//
	//    * In Progress: The command has been sent to at least one instance but
	//    has not reached a final state on all instances.
	//
	//    * Success: The command successfully ran on all invocations. This is a
	//    terminal state.
	//
	//    * Delivery Timed Out: The value of MaxErrors or more command invocations
	//    shows a status of Delivery Timed Out. This is a terminal state.
	//
	//    * Execution Timed Out: The value of MaxErrors or more command invocations
	//    shows a status of Execution Timed Out. This is a terminal state.
	//
	//    * Failed: The value of MaxErrors or more command invocations shows a status
	//    of Failed. This is a terminal state.
	//
	//    * Incomplete: The command was attempted on all instances and one or more
	//    invocations does not have a value of Success but not enough invocations
	//    failed for the status to be Failed. This is a terminal state.
	//
	//    * Canceled: The command was terminated before it was completed. This is
	//    a terminal state.
	//
	//    * Rate Exceeded: The number of instances targeted by the command exceeded
	//    the account limit for pending invocations. The system has canceled the
	//    command before running it on any instance. This is a terminal state.
	StatusDetails *string `type:"string"`

	// The number of targets for the command.
	TargetCount *int64 `type:"integer"`

	// An array of search criteria that targets instances using a Key,Value combination
	// that you specify. Targets is required if you don't provide one or more instance
	// IDs in the call.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

Describes a command request.

func (Command) GoString added in v0.9.17

func (s Command) GoString() string

GoString returns the string representation

func (*Command) SetCloudWatchOutputConfig added in v1.14.6

func (s *Command) SetCloudWatchOutputConfig(v *CloudWatchOutputConfig) *Command

SetCloudWatchOutputConfig sets the CloudWatchOutputConfig field's value.

func (*Command) SetCommandId added in v1.5.0

func (s *Command) SetCommandId(v string) *Command

SetCommandId sets the CommandId field's value.

func (*Command) SetComment added in v1.5.0

func (s *Command) SetComment(v string) *Command

SetComment sets the Comment field's value.

func (*Command) SetCompletedCount added in v1.5.13

func (s *Command) SetCompletedCount(v int64) *Command

SetCompletedCount sets the CompletedCount field's value.

func (*Command) SetDeliveryTimedOutCount added in v1.14.6

func (s *Command) SetDeliveryTimedOutCount(v int64) *Command

SetDeliveryTimedOutCount sets the DeliveryTimedOutCount field's value.

func (*Command) SetDocumentName added in v1.5.0

func (s *Command) SetDocumentName(v string) *Command

SetDocumentName sets the DocumentName field's value.

func (*Command) SetDocumentVersion added in v1.13.40

func (s *Command) SetDocumentVersion(v string) *Command

SetDocumentVersion sets the DocumentVersion field's value.

func (*Command) SetErrorCount added in v1.5.13

func (s *Command) SetErrorCount(v int64) *Command

SetErrorCount sets the ErrorCount field's value.

func (*Command) SetExpiresAfter added in v1.5.0

func (s *Command) SetExpiresAfter(v time.Time) *Command

SetExpiresAfter sets the ExpiresAfter field's value.

func (*Command) SetInstanceIds added in v1.5.0

func (s *Command) SetInstanceIds(v []*string) *Command

SetInstanceIds sets the InstanceIds field's value.

func (*Command) SetMaxConcurrency added in v1.5.13

func (s *Command) SetMaxConcurrency(v string) *Command

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*Command) SetMaxErrors added in v1.5.13

func (s *Command) SetMaxErrors(v string) *Command

SetMaxErrors sets the MaxErrors field's value.

func (*Command) SetNotificationConfig added in v1.5.0

func (s *Command) SetNotificationConfig(v *NotificationConfig) *Command

SetNotificationConfig sets the NotificationConfig field's value.

func (*Command) SetOutputS3BucketName added in v1.5.0

func (s *Command) SetOutputS3BucketName(v string) *Command

SetOutputS3BucketName sets the OutputS3BucketName field's value.

func (*Command) SetOutputS3KeyPrefix added in v1.5.0

func (s *Command) SetOutputS3KeyPrefix(v string) *Command

SetOutputS3KeyPrefix sets the OutputS3KeyPrefix field's value.

func (*Command) SetOutputS3Region added in v1.5.13

func (s *Command) SetOutputS3Region(v string) *Command

SetOutputS3Region sets the OutputS3Region field's value.

func (*Command) SetParameters added in v1.5.0

func (s *Command) SetParameters(v map[string][]*string) *Command

SetParameters sets the Parameters field's value.

func (*Command) SetRequestedDateTime added in v1.5.0

func (s *Command) SetRequestedDateTime(v time.Time) *Command

SetRequestedDateTime sets the RequestedDateTime field's value.

func (*Command) SetServiceRole added in v1.5.0

func (s *Command) SetServiceRole(v string) *Command

SetServiceRole sets the ServiceRole field's value.

func (*Command) SetStatus added in v1.5.0

func (s *Command) SetStatus(v string) *Command

SetStatus sets the Status field's value.

func (*Command) SetStatusDetails added in v1.5.13

func (s *Command) SetStatusDetails(v string) *Command

SetStatusDetails sets the StatusDetails field's value.

func (*Command) SetTargetCount added in v1.5.13

func (s *Command) SetTargetCount(v int64) *Command

SetTargetCount sets the TargetCount field's value.

func (*Command) SetTargets added in v1.5.13

func (s *Command) SetTargets(v []*Target) *Command

SetTargets sets the Targets field's value.

func (Command) String added in v0.9.17

func (s Command) String() string

String returns the string representation

type CommandFilter added in v0.9.17

type CommandFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true" enum:"CommandFilterKey"`

	// The filter value. Valid values for each filter key are as follows:
	//
	//    * InvokedAfter: Specify a timestamp to limit your results. For example,
	//    specify 2018-07-07T00:00:00Z to see a list of command executions occurring
	//    July 7, 2018, and later.
	//
	//    * InvokedBefore: Specify a timestamp to limit your results. For example,
	//    specify 2018-07-07T00:00:00Z to see a list of command executions from
	//    before July 7, 2018.
	//
	//    * Status: Specify a valid command status to see a list of all command
	//    executions with that status. Status values you can specify include: Pending
	//    InProgress Success Cancelled Failed TimedOut Cancelling
	//
	//    * DocumentName: Specify name of the SSM document for which you want to
	//    see command execution results. For example, specify AWS-RunPatchBaseline
	//    to see command executions that used this SSM document to perform security
	//    patching operations on instances.
	//
	//    * ExecutionStage: Specify one of the following values: Executing: Returns
	//    a list of command executions that are currently still running. Complete:
	//    Returns a list of command executions that have already completed.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a command filter.

func (CommandFilter) GoString added in v0.9.17

func (s CommandFilter) GoString() string

GoString returns the string representation

func (*CommandFilter) SetKey added in v1.5.0

func (s *CommandFilter) SetKey(v string) *CommandFilter

SetKey sets the Key field's value.

func (*CommandFilter) SetValue added in v1.5.0

func (s *CommandFilter) SetValue(v string) *CommandFilter

SetValue sets the Value field's value.

func (CommandFilter) String added in v0.9.17

func (s CommandFilter) String() string

String returns the string representation

func (*CommandFilter) Validate added in v1.1.21

func (s *CommandFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CommandInvocation added in v0.9.17

type CommandInvocation struct {

	// CloudWatch Logs information where you want Systems Manager to send the command
	// output.
	CloudWatchOutputConfig *CloudWatchOutputConfig `type:"structure"`

	// The command against which this invocation was requested.
	CommandId *string `min:"36" type:"string"`

	CommandPlugins []*CommandPlugin `type:"list"`

	// User-specified information about the command, such as a brief description
	// of what the command should do.
	Comment *string `type:"string"`

	// The document name that was requested for execution.
	DocumentName *string `type:"string"`

	// The SSM document version.
	DocumentVersion *string `type:"string"`

	// The instance ID in which this invocation was requested.
	InstanceId *string `type:"string"`

	// The name of the invocation target. For Amazon EC2 instances this is the value
	// for the aws:Name tag. For on-premises instances, this is the name of the
	// instance.
	InstanceName *string `type:"string"`

	// Configurations for sending notifications about command status changes on
	// a per instance basis.
	NotificationConfig *NotificationConfig `type:"structure"`

	// The time and date the request was sent to this instance.
	RequestedDateTime *time.Time `type:"timestamp"`

	// The IAM service role that Run Command uses to act on your behalf when sending
	// notifications about command status changes on a per instance basis.
	ServiceRole *string `type:"string"`

	// The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket
	// was defined for the parent command. For an invocation, StandardErrorUrl is
	// populated if there is just one plugin defined for the command, and the Amazon
	// S3 bucket was defined for the command.
	StandardErrorUrl *string `type:"string"`

	// The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket
	// was defined for the parent command. For an invocation, StandardOutputUrl
	// is populated if there is just one plugin defined for the command, and the
	// Amazon S3 bucket was defined for the command.
	StandardOutputUrl *string `type:"string"`

	// Whether or not the invocation succeeded, failed, or is pending.
	Status *string `type:"string" enum:"CommandInvocationStatus"`

	// A detailed status of the command execution for each invocation (each instance
	// targeted by the command). 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 (http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
	// in the AWS Systems Manager User Guide. StatusDetails can be one of the following
	// values:
	//
	//    * Pending: The command has not been sent to the instance.
	//
	//    * In Progress: The command has been sent to the instance but has not reached
	//    a terminal state.
	//
	//    * Success: The execution of the command or plugin was successfully completed.
	//    This is a terminal state.
	//
	//    * Delivery Timed Out: The command was not delivered to the instance before
	//    the delivery timeout expired. Delivery timeouts do not count against the
	//    parent command's MaxErrors limit, but they do contribute to whether the
	//    parent command status is Success or Incomplete. This is a terminal state.
	//
	//    * Execution Timed Out: Command execution started on the instance, but
	//    the execution was not complete before the execution timeout expired. Execution
	//    timeouts count against the MaxErrors limit of the parent command. This
	//    is a terminal state.
	//
	//    * Failed: The command was not successful on the instance. For a plugin,
	//    this indicates that the result code was not zero. For a command invocation,
	//    this indicates that the result code for one or more plugins was not zero.
	//    Invocation failures count against the MaxErrors limit of the parent command.
	//    This is a terminal state.
	//
	//    * Canceled: The command was terminated before it was completed. This is
	//    a terminal state.
	//
	//    * Undeliverable: The command can't be delivered to the instance. The instance
	//    might not exist or might not be responding. Undeliverable invocations
	//    don't count against the parent command's MaxErrors limit and don't contribute
	//    to whether the parent command status is Success or Incomplete. This is
	//    a terminal state.
	//
	//    * Terminated: The parent command exceeded its MaxErrors limit and subsequent
	//    command invocations were canceled by the system. This is a terminal state.
	StatusDetails *string `type:"string"`

	// Gets the trace output sent by the agent.
	TraceOutput *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (CommandInvocation) GoString added in v0.9.17

func (s CommandInvocation) GoString() string

GoString returns the string representation

func (*CommandInvocation) SetCloudWatchOutputConfig added in v1.14.6

func (s *CommandInvocation) SetCloudWatchOutputConfig(v *CloudWatchOutputConfig) *CommandInvocation

SetCloudWatchOutputConfig sets the CloudWatchOutputConfig field's value.

func (*CommandInvocation) SetCommandId added in v1.5.0

func (s *CommandInvocation) SetCommandId(v string) *CommandInvocation

SetCommandId sets the CommandId field's value.

func (*CommandInvocation) SetCommandPlugins added in v1.5.0

func (s *CommandInvocation) SetCommandPlugins(v []*CommandPlugin) *CommandInvocation

SetCommandPlugins sets the CommandPlugins field's value.

func (*CommandInvocation) SetComment added in v1.5.0

func (s *CommandInvocation) SetComment(v string) *CommandInvocation

SetComment sets the Comment field's value.

func (*CommandInvocation) SetDocumentName added in v1.5.0

func (s *CommandInvocation) SetDocumentName(v string) *CommandInvocation

SetDocumentName sets the DocumentName field's value.

func (*CommandInvocation) SetDocumentVersion added in v1.13.40

func (s *CommandInvocation) SetDocumentVersion(v string) *CommandInvocation

SetDocumentVersion sets the DocumentVersion field's value.

func (*CommandInvocation) SetInstanceId added in v1.5.0

func (s *CommandInvocation) SetInstanceId(v string) *CommandInvocation

SetInstanceId sets the InstanceId field's value.

func (*CommandInvocation) SetInstanceName added in v1.5.13

func (s *CommandInvocation) SetInstanceName(v string) *CommandInvocation

SetInstanceName sets the InstanceName field's value.

func (*CommandInvocation) SetNotificationConfig added in v1.5.0

func (s *CommandInvocation) SetNotificationConfig(v *NotificationConfig) *CommandInvocation

SetNotificationConfig sets the NotificationConfig field's value.

func (*CommandInvocation) SetRequestedDateTime added in v1.5.0

func (s *CommandInvocation) SetRequestedDateTime(v time.Time) *CommandInvocation

SetRequestedDateTime sets the RequestedDateTime field's value.

func (*CommandInvocation) SetServiceRole added in v1.5.0

func (s *CommandInvocation) SetServiceRole(v string) *CommandInvocation

SetServiceRole sets the ServiceRole field's value.

func (*CommandInvocation) SetStandardErrorUrl added in v1.5.13

func (s *CommandInvocation) SetStandardErrorUrl(v string) *CommandInvocation

SetStandardErrorUrl sets the StandardErrorUrl field's value.

func (*CommandInvocation) SetStandardOutputUrl added in v1.5.13

func (s *CommandInvocation) SetStandardOutputUrl(v string) *CommandInvocation

SetStandardOutputUrl sets the StandardOutputUrl field's value.

func (*CommandInvocation) SetStatus added in v1.5.0

func (s *CommandInvocation) SetStatus(v string) *CommandInvocation

SetStatus sets the Status field's value.

func (*CommandInvocation) SetStatusDetails added in v1.5.13

func (s *CommandInvocation) SetStatusDetails(v string) *CommandInvocation

SetStatusDetails sets the StatusDetails field's value.

func (*CommandInvocation) SetTraceOutput added in v1.5.0

func (s *CommandInvocation) SetTraceOutput(v string) *CommandInvocation

SetTraceOutput sets the TraceOutput field's value.

func (CommandInvocation) String added in v0.9.17

func (s CommandInvocation) String() string

String returns the string representation

type CommandPlugin added in v0.9.17

type CommandPlugin struct {

	// The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin,
	// aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch,
	// aws:runShellScript, or aws:updateSSMAgent.
	Name *string `min:"4" type:"string"`

	// Output of the plugin execution.
	Output *string `type:"string"`

	// The S3 bucket where the responses to the command executions should be stored.
	// This was requested when issuing the command. For example, in the following
	// response:
	//
	// test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
	//
	// test_folder is the name of the Amazon S3 bucket;
	//
	// ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
	//
	// i-1234567876543 is the instance ID;
	//
	// awsrunShellScript is the name of the plugin.
	OutputS3BucketName *string `min:"3" type:"string"`

	// The S3 directory path inside the bucket where the responses to the command
	// executions should be stored. This was requested when issuing the command.
	// For example, in the following response:
	//
	// test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript
	//
	// test_folder is the name of the Amazon S3 bucket;
	//
	// ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;
	//
	// i-1234567876543 is the instance ID;
	//
	// awsrunShellScript is the name of the plugin.
	OutputS3KeyPrefix *string `type:"string"`

	// (Deprecated) You can no longer specify this parameter. The system ignores
	// it. Instead, Systems Manager automatically determines the Amazon S3 bucket
	// region.
	OutputS3Region *string `min:"3" type:"string"`

	// A numeric response code generated after running the plugin.
	ResponseCode *int64 `type:"integer"`

	// The time the plugin stopped running. Could stop prematurely if, for example,
	// a cancel command was sent.
	ResponseFinishDateTime *time.Time `type:"timestamp"`

	// The time the plugin started running.
	ResponseStartDateTime *time.Time `type:"timestamp"`

	// The URL for the complete text written by the plugin to stderr. If execution
	// is not yet complete, then this string is empty.
	StandardErrorUrl *string `type:"string"`

	// The URL for the complete text written by the plugin to stdout in Amazon S3.
	// If the Amazon S3 bucket for the command was not specified, then this string
	// is empty.
	StandardOutputUrl *string `type:"string"`

	// The status of this plugin. You can run a document with multiple plugins.
	Status *string `type:"string" enum:"CommandPluginStatus"`

	// A detailed status of the plugin execution. 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
	// (http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
	// in the AWS Systems Manager User Guide. StatusDetails can be one of the following
	// values:
	//
	//    * Pending: The command has not been sent to the instance.
	//
	//    * In Progress: The command has been sent to the instance but has not reached
	//    a terminal state.
	//
	//    * Success: The execution of the command or plugin was successfully completed.
	//    This is a terminal state.
	//
	//    * Delivery Timed Out: The command was not delivered to the instance before
	//    the delivery timeout expired. Delivery timeouts do not count against the
	//    parent command's MaxErrors limit, but they do contribute to whether the
	//    parent command status is Success or Incomplete. This is a terminal state.
	//
	//    * Execution Timed Out: Command execution started on the instance, but
	//    the execution was not complete before the execution timeout expired. Execution
	//    timeouts count against the MaxErrors limit of the parent command. This
	//    is a terminal state.
	//
	//    * Failed: The command was not successful on the instance. For a plugin,
	//    this indicates that the result code was not zero. For a command invocation,
	//    this indicates that the result code for one or more plugins was not zero.
	//    Invocation failures count against the MaxErrors limit of the parent command.
	//    This is a terminal state.
	//
	//    * Canceled: The command was terminated before it was completed. This is
	//    a terminal state.
	//
	//    * Undeliverable: The command can't be delivered to the instance. The instance
	//    might not exist, or it might not be responding. Undeliverable invocations
	//    don't count against the parent command's MaxErrors limit, and they 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 `type:"string"`
	// contains filtered or unexported fields
}

Describes plugin details.

func (CommandPlugin) GoString added in v0.9.17

func (s CommandPlugin) GoString() string

GoString returns the string representation

func (*CommandPlugin) SetName added in v1.5.0

func (s *CommandPlugin) SetName(v string) *CommandPlugin

SetName sets the Name field's value.

func (*CommandPlugin) SetOutput added in v1.5.0

func (s *CommandPlugin) SetOutput(v string) *CommandPlugin

SetOutput sets the Output field's value.

func (*CommandPlugin) SetOutputS3BucketName added in v1.5.0

func (s *CommandPlugin) SetOutputS3BucketName(v string) *CommandPlugin

SetOutputS3BucketName sets the OutputS3BucketName field's value.

func (*CommandPlugin) SetOutputS3KeyPrefix added in v1.5.0

func (s *CommandPlugin) SetOutputS3KeyPrefix(v string) *CommandPlugin

SetOutputS3KeyPrefix sets the OutputS3KeyPrefix field's value.

func (*CommandPlugin) SetOutputS3Region added in v1.5.13

func (s *CommandPlugin) SetOutputS3Region(v string) *CommandPlugin

SetOutputS3Region sets the OutputS3Region field's value.

func (*CommandPlugin) SetResponseCode added in v1.5.0

func (s *CommandPlugin) SetResponseCode(v int64) *CommandPlugin

SetResponseCode sets the ResponseCode field's value.

func (*CommandPlugin) SetResponseFinishDateTime added in v1.5.0

func (s *CommandPlugin) SetResponseFinishDateTime(v time.Time) *CommandPlugin

SetResponseFinishDateTime sets the ResponseFinishDateTime field's value.

func (*CommandPlugin) SetResponseStartDateTime added in v1.5.0

func (s *CommandPlugin) SetResponseStartDateTime(v time.Time) *CommandPlugin

SetResponseStartDateTime sets the ResponseStartDateTime field's value.

func (*CommandPlugin) SetStandardErrorUrl added in v1.5.13

func (s *CommandPlugin) SetStandardErrorUrl(v string) *CommandPlugin

SetStandardErrorUrl sets the StandardErrorUrl field's value.

func (*CommandPlugin) SetStandardOutputUrl added in v1.5.13

func (s *CommandPlugin) SetStandardOutputUrl(v string) *CommandPlugin

SetStandardOutputUrl sets the StandardOutputUrl field's value.

func (*CommandPlugin) SetStatus added in v1.5.0

func (s *CommandPlugin) SetStatus(v string) *CommandPlugin

SetStatus sets the Status field's value.

func (*CommandPlugin) SetStatusDetails added in v1.5.13

func (s *CommandPlugin) SetStatusDetails(v string) *CommandPlugin

SetStatusDetails sets the StatusDetails field's value.

func (CommandPlugin) String added in v0.9.17

func (s CommandPlugin) String() string

String returns the string representation

type ComplianceExecutionSummary added in v1.10.25

type ComplianceExecutionSummary struct {

	// An ID created by the system when PutComplianceItems was called. For example,
	// CommandID is a valid execution ID. You can use this ID in subsequent calls.
	ExecutionId *string `type:"string"`

	// The time the execution ran as a datetime object that is saved in the following
	// format: yyyy-MM-dd'T'HH:mm:ss'Z'.
	//
	// ExecutionTime is a required field
	ExecutionTime *time.Time `type:"timestamp" required:"true"`

	// The type of execution. For example, Command is a valid execution type.
	ExecutionType *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (ComplianceExecutionSummary) GoString added in v1.10.25

func (s ComplianceExecutionSummary) GoString() string

GoString returns the string representation

func (*ComplianceExecutionSummary) SetExecutionId added in v1.10.25

SetExecutionId sets the ExecutionId field's value.

func (*ComplianceExecutionSummary) SetExecutionTime added in v1.10.25

SetExecutionTime sets the ExecutionTime field's value.

func (*ComplianceExecutionSummary) SetExecutionType added in v1.10.25

SetExecutionType sets the ExecutionType field's value.

func (ComplianceExecutionSummary) String added in v1.10.25

String returns the string representation

func (*ComplianceExecutionSummary) Validate added in v1.10.25

func (s *ComplianceExecutionSummary) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComplianceItem added in v1.10.25

type ComplianceItem struct {

	// The compliance type. For example, Association (for a State Manager association),
	// Patch, or Custom:string are all valid compliance types.
	ComplianceType *string `min:"1" type:"string"`

	// A "Key": "Value" tag combination for the compliance item.
	Details map[string]*string `type:"map"`

	// A summary for the compliance item. The summary includes an execution ID,
	// the execution type (for example, command), and the execution time.
	ExecutionSummary *ComplianceExecutionSummary `type:"structure"`

	// An ID for the compliance item. For example, if the compliance item is a Windows
	// patch, the ID could be the number of the KB article; for example: KB4010320.
	Id *string `min:"1" type:"string"`

	// An ID for the resource. For a managed instance, this is the instance ID.
	ResourceId *string `min:"1" type:"string"`

	// The type of resource. ManagedInstance is currently the only supported resource
	// type.
	ResourceType *string `min:"1" type:"string"`

	// The severity of the compliance status. Severity can be one of the following:
	// Critical, High, Medium, Low, Informational, Unspecified.
	Severity *string `type:"string" enum:"ComplianceSeverity"`

	// The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
	Status *string `type:"string" enum:"ComplianceStatus"`

	// A title for the compliance item. For example, if the compliance item is a
	// Windows patch, the title could be the title of the KB article for the patch;
	// for example: Security Update for Active Directory Federation Services.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, etc.

func (ComplianceItem) GoString added in v1.10.25

func (s ComplianceItem) GoString() string

GoString returns the string representation

func (*ComplianceItem) SetComplianceType added in v1.10.25

func (s *ComplianceItem) SetComplianceType(v string) *ComplianceItem

SetComplianceType sets the ComplianceType field's value.

func (*ComplianceItem) SetDetails added in v1.10.25

func (s *ComplianceItem) SetDetails(v map[string]*string) *ComplianceItem

SetDetails sets the Details field's value.

func (*ComplianceItem) SetExecutionSummary added in v1.10.25

func (s *ComplianceItem) SetExecutionSummary(v *ComplianceExecutionSummary) *ComplianceItem

SetExecutionSummary sets the ExecutionSummary field's value.

func (*ComplianceItem) SetId added in v1.10.25

func (s *ComplianceItem) SetId(v string) *ComplianceItem

SetId sets the Id field's value.

func (*ComplianceItem) SetResourceId added in v1.10.25

func (s *ComplianceItem) SetResourceId(v string) *ComplianceItem

SetResourceId sets the ResourceId field's value.

func (*ComplianceItem) SetResourceType added in v1.10.25

func (s *ComplianceItem) SetResourceType(v string) *ComplianceItem

SetResourceType sets the ResourceType field's value.

func (*ComplianceItem) SetSeverity added in v1.10.25

func (s *ComplianceItem) SetSeverity(v string) *ComplianceItem

SetSeverity sets the Severity field's value.

func (*ComplianceItem) SetStatus added in v1.10.25

func (s *ComplianceItem) SetStatus(v string) *ComplianceItem

SetStatus sets the Status field's value.

func (*ComplianceItem) SetTitle added in v1.10.25

func (s *ComplianceItem) SetTitle(v string) *ComplianceItem

SetTitle sets the Title field's value.

func (ComplianceItem) String added in v1.10.25

func (s ComplianceItem) String() string

String returns the string representation

type ComplianceItemEntry added in v1.10.25

type ComplianceItemEntry struct {

	// A "Key": "Value" tag combination for the compliance item.
	Details map[string]*string `type:"map"`

	// The compliance item ID. For example, if the compliance item is a Windows
	// patch, the ID could be the number of the KB article.
	Id *string `min:"1" type:"string"`

	// The severity of the compliance status. Severity can be one of the following:
	// Critical, High, Medium, Low, Informational, Unspecified.
	//
	// Severity is a required field
	Severity *string `type:"string" required:"true" enum:"ComplianceSeverity"`

	// The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ComplianceStatus"`

	// The title of the compliance item. For example, if the compliance item is
	// a Windows patch, the title could be the title of the KB article for the patch;
	// for example: Security Update for Active Directory Federation Services.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a compliance item.

func (ComplianceItemEntry) GoString added in v1.10.25

func (s ComplianceItemEntry) GoString() string

GoString returns the string representation

func (*ComplianceItemEntry) SetDetails added in v1.10.25

func (s *ComplianceItemEntry) SetDetails(v map[string]*string) *ComplianceItemEntry

SetDetails sets the Details field's value.

func (*ComplianceItemEntry) SetId added in v1.10.25

SetId sets the Id field's value.

func (*ComplianceItemEntry) SetSeverity added in v1.10.25

func (s *ComplianceItemEntry) SetSeverity(v string) *ComplianceItemEntry

SetSeverity sets the Severity field's value.

func (*ComplianceItemEntry) SetStatus added in v1.10.25

SetStatus sets the Status field's value.

func (*ComplianceItemEntry) SetTitle added in v1.10.25

SetTitle sets the Title field's value.

func (ComplianceItemEntry) String added in v1.10.25

func (s ComplianceItemEntry) String() string

String returns the string representation

func (*ComplianceItemEntry) Validate added in v1.10.25

func (s *ComplianceItemEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComplianceStringFilter added in v1.10.25

type ComplianceStringFilter struct {

	// The name of the filter.
	Key *string `min:"1" type:"string"`

	// The type of comparison that should be performed for the value: Equal, NotEqual,
	// BeginWith, LessThan, or GreaterThan.
	Type *string `type:"string" enum:"ComplianceQueryOperatorType"`

	// The value for which to search.
	Values []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

One or more filters. Use a filter to return a more specific list of results.

func (ComplianceStringFilter) GoString added in v1.10.25

func (s ComplianceStringFilter) GoString() string

GoString returns the string representation

func (*ComplianceStringFilter) SetKey added in v1.10.25

SetKey sets the Key field's value.

func (*ComplianceStringFilter) SetType added in v1.10.25

SetType sets the Type field's value.

func (*ComplianceStringFilter) SetValues added in v1.10.25

SetValues sets the Values field's value.

func (ComplianceStringFilter) String added in v1.10.25

func (s ComplianceStringFilter) String() string

String returns the string representation

func (*ComplianceStringFilter) Validate added in v1.10.25

func (s *ComplianceStringFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComplianceSummaryItem added in v1.10.25

type ComplianceSummaryItem struct {

	// The type of compliance item. For example, the compliance type can be Association,
	// Patch, or Custom:string.
	ComplianceType *string `min:"1" type:"string"`

	// A list of COMPLIANT items for the specified compliance type.
	CompliantSummary *CompliantSummary `type:"structure"`

	// A list of NON_COMPLIANT items for the specified compliance type.
	NonCompliantSummary *NonCompliantSummary `type:"structure"`
	// contains filtered or unexported fields
}

A summary of compliance information by compliance type.

func (ComplianceSummaryItem) GoString added in v1.10.25

func (s ComplianceSummaryItem) GoString() string

GoString returns the string representation

func (*ComplianceSummaryItem) SetComplianceType added in v1.10.25

func (s *ComplianceSummaryItem) SetComplianceType(v string) *ComplianceSummaryItem

SetComplianceType sets the ComplianceType field's value.

func (*ComplianceSummaryItem) SetCompliantSummary added in v1.10.25

func (s *ComplianceSummaryItem) SetCompliantSummary(v *CompliantSummary) *ComplianceSummaryItem

SetCompliantSummary sets the CompliantSummary field's value.

func (*ComplianceSummaryItem) SetNonCompliantSummary added in v1.10.25

func (s *ComplianceSummaryItem) SetNonCompliantSummary(v *NonCompliantSummary) *ComplianceSummaryItem

SetNonCompliantSummary sets the NonCompliantSummary field's value.

func (ComplianceSummaryItem) String added in v1.10.25

func (s ComplianceSummaryItem) String() string

String returns the string representation

type CompliantSummary added in v1.10.25

type CompliantSummary struct {

	// The total number of resources that are compliant.
	CompliantCount *int64 `type:"integer"`

	// A summary of the compliance severity by compliance type.
	SeveritySummary *SeveritySummary `type:"structure"`
	// contains filtered or unexported fields
}

A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.

func (CompliantSummary) GoString added in v1.10.25

func (s CompliantSummary) GoString() string

GoString returns the string representation

func (*CompliantSummary) SetCompliantCount added in v1.10.25

func (s *CompliantSummary) SetCompliantCount(v int64) *CompliantSummary

SetCompliantCount sets the CompliantCount field's value.

func (*CompliantSummary) SetSeveritySummary added in v1.10.25

func (s *CompliantSummary) SetSeveritySummary(v *SeveritySummary) *CompliantSummary

SetSeveritySummary sets the SeveritySummary field's value.

func (CompliantSummary) String added in v1.10.25

func (s CompliantSummary) String() string

String returns the string representation

type CreateActivationInput added in v1.2.2

type CreateActivationInput struct {

	// The name of the registered, managed instance as it will appear in the Amazon
	// EC2 console or when you use the AWS command line tools to list EC2 resources.
	//
	// Do not enter personally identifiable information in this field.
	DefaultInstanceName *string `type:"string"`

	// A user-defined description of the resource that you want to register with
	// Amazon EC2.
	//
	// Do not enter personally identifiable information in this field.
	Description *string `type:"string"`

	// The date by which this activation request should expire. The default value
	// is 24 hours.
	ExpirationDate *time.Time `type:"timestamp"`

	// The Amazon Identity and Access Management (IAM) role that you want to assign
	// to the managed instance.
	//
	// IamRole is a required field
	IamRole *string `type:"string" required:"true"`

	// Specify the maximum number of managed instances you want to register. The
	// default value is 1 instance.
	RegistrationLimit *int64 `min:"1" type:"integer"`

	// Optional metadata that you assign to a resource. Tags enable you to categorize
	// a resource in different ways, such as by purpose, owner, or environment.
	// For example, you might want to tag an activation to identify which servers
	// or virtual machines (VMs) in your on-premises environment you intend to activate.
	// In this case, you could specify the following key name/value pairs:
	//
	//    * Key=OS,Value=Windows
	//
	//    * Key=Environment,Value=Production
	//
	// When you install SSM Agent on your on-premises servers and VMs, you specify
	// an activation ID and code. When you specify the activation ID and code, tags
	// assigned to the activation are automatically applied to the on-premises servers
	// or VMs.
	//
	// You can't add tags to or delete tags from an existing activation. You can
	// tag your on-premises servers and VMs after they connect to Systems Manager
	// for the first time and are assigned a managed instance ID. This means they
	// are listed in the AWS Systems Manager console with an ID that is prefixed
	// with "mi-". For information about how to add tags to your managed instances,
	// see AddTagsToResource. For information about how to remove tags from your
	// managed instances, see RemoveTagsFromResource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateActivationInput) GoString added in v1.2.2

func (s CreateActivationInput) GoString() string

GoString returns the string representation

func (*CreateActivationInput) SetDefaultInstanceName added in v1.5.0

func (s *CreateActivationInput) SetDefaultInstanceName(v string) *CreateActivationInput

SetDefaultInstanceName sets the DefaultInstanceName field's value.

func (*CreateActivationInput) SetDescription added in v1.5.0

func (s *CreateActivationInput) SetDescription(v string) *CreateActivationInput

SetDescription sets the Description field's value.

func (*CreateActivationInput) SetExpirationDate added in v1.5.0

func (s *CreateActivationInput) SetExpirationDate(v time.Time) *CreateActivationInput

SetExpirationDate sets the ExpirationDate field's value.

func (*CreateActivationInput) SetIamRole added in v1.5.0

SetIamRole sets the IamRole field's value.

func (*CreateActivationInput) SetRegistrationLimit added in v1.5.0

func (s *CreateActivationInput) SetRegistrationLimit(v int64) *CreateActivationInput

SetRegistrationLimit sets the RegistrationLimit field's value.

func (*CreateActivationInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateActivationInput) String added in v1.2.2

func (s CreateActivationInput) String() string

String returns the string representation

func (*CreateActivationInput) Validate added in v1.2.2

func (s *CreateActivationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateActivationOutput added in v1.2.2

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 `min:"20" type:"string"`

	// The ID number generated by the system when it processed the activation. The
	// activation ID functions like a user name.
	ActivationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateActivationOutput) GoString added in v1.2.2

func (s CreateActivationOutput) GoString() string

GoString returns the string representation

func (*CreateActivationOutput) SetActivationCode added in v1.5.0

func (s *CreateActivationOutput) SetActivationCode(v string) *CreateActivationOutput

SetActivationCode sets the ActivationCode field's value.

func (*CreateActivationOutput) SetActivationId added in v1.5.0

func (s *CreateActivationOutput) SetActivationId(v string) *CreateActivationOutput

SetActivationId sets the ActivationId field's value.

func (CreateActivationOutput) String added in v1.2.2

func (s CreateActivationOutput) String() string

String returns the string representation

type CreateAssociationBatchInput

type CreateAssociationBatchInput struct {

	// One or more associations.
	//
	// Entries is a required field
	Entries []*CreateAssociationBatchRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAssociationBatchInput) GoString added in v0.6.5

func (s CreateAssociationBatchInput) GoString() string

GoString returns the string representation

func (*CreateAssociationBatchInput) SetEntries added in v1.5.0

SetEntries sets the Entries field's value.

func (CreateAssociationBatchInput) String added in v0.6.5

String returns the string representation

func (*CreateAssociationBatchInput) Validate added in v1.1.21

func (s *CreateAssociationBatchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAssociationBatchOutput

type CreateAssociationBatchOutput struct {

	// Information about the associations that failed.
	Failed []*FailedCreateAssociation `type:"list"`

	// Information about the associations that succeeded.
	Successful []*AssociationDescription `type:"list"`
	// contains filtered or unexported fields
}

func (CreateAssociationBatchOutput) GoString added in v0.6.5

func (s CreateAssociationBatchOutput) GoString() string

GoString returns the string representation

func (*CreateAssociationBatchOutput) SetFailed added in v1.5.0

SetFailed sets the Failed field's value.

func (*CreateAssociationBatchOutput) SetSuccessful added in v1.5.0

SetSuccessful sets the Successful field's value.

func (CreateAssociationBatchOutput) String added in v0.6.5

String returns the string representation

type CreateAssociationBatchRequestEntry

type CreateAssociationBatchRequestEntry struct {

	// Specify a descriptive name for the association.
	AssociationName *string `type:"string"`

	// Specify the target for the association. This target is required for associations
	// that use an Automation document and target resources by using rate controls.
	AutomationTargetParameterName *string `min:"1" type:"string"`

	// The severity level to assign to the association.
	ComplianceSeverity *string `type:"string" enum:"AssociationComplianceSeverity"`

	// The document version.
	DocumentVersion *string `type:"string"`

	// The ID of the instance.
	InstanceId *string `type:"string"`

	// The maximum number of targets allowed to run the association at the same
	// time. You can specify a number, for example 10, or a percentage of the target
	// set, for example 10%. The default value is 100%, which means all targets
	// run the association at the same time.
	//
	// If a new instance starts and attempts to run an association while Systems
	// Manager is running MaxConcurrency associations, the association is allowed
	// to run. During the next association interval, the new instance will process
	// its association within the limit specified for MaxConcurrency.
	MaxConcurrency *string `min:"1" type:"string"`

	// The number of errors that are allowed before the system stops sending requests
	// to run the association on additional targets. You can specify either an absolute
	// number of errors, for example 10, or a percentage of the target set, for
	// example 10%. If you specify 3, for example, the system stops sending requests
	// when the fourth error is received. If you specify 0, then the system stops
	// sending requests after the first error is returned. If you run an association
	// on 50 instances and set MaxError to 10%, then the system stops sending the
	// request when the sixth error is received.
	//
	// Executions that are already running an association when MaxErrors is reached
	// are allowed to complete, but some of these executions may fail as well. If
	// you need to ensure that there won't be more than max-errors failed executions,
	// set MaxConcurrency to 1 so that executions proceed one at a time.
	MaxErrors *string `min:"1" type:"string"`

	// The name of the SSM document that contains the configuration information
	// for the instance. You can specify Command or Automation documents.
	//
	// You can specify AWS-predefined documents, documents you created, or a document
	// that is shared with you from another account.
	//
	// For SSM documents that are shared with you from other AWS accounts, you must
	// specify the complete SSM document ARN, in the following format:
	//
	// arn:aws:ssm:region:account-id:document/document-name
	//
	// For example:
	//
	// arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
	//
	// For AWS-predefined documents and SSM documents you created in your account,
	// you only need to specify the document name. For example, AWS-ApplyPatchBaseline
	// or My-Document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// An Amazon S3 bucket where you want to store the results of this request.
	OutputLocation *InstanceAssociationOutputLocation `type:"structure"`

	// A description of the parameters for a document.
	Parameters map[string][]*string `type:"map"`

	// A cron expression that specifies a schedule when the association runs.
	ScheduleExpression *string `min:"1" type:"string"`

	// The instances targeted by the request.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

Describes the association of a Systems Manager SSM document and an instance.

func (CreateAssociationBatchRequestEntry) GoString added in v0.6.5

GoString returns the string representation

func (*CreateAssociationBatchRequestEntry) SetAssociationName added in v1.10.30

SetAssociationName sets the AssociationName field's value.

func (*CreateAssociationBatchRequestEntry) SetAutomationTargetParameterName added in v1.99.0

func (s *CreateAssociationBatchRequestEntry) SetAutomationTargetParameterName(v string) *CreateAssociationBatchRequestEntry

SetAutomationTargetParameterName sets the AutomationTargetParameterName field's value.

func (*CreateAssociationBatchRequestEntry) SetComplianceSeverity added in v1.99.0

SetComplianceSeverity sets the ComplianceSeverity field's value.

func (*CreateAssociationBatchRequestEntry) SetDocumentVersion added in v1.5.13

SetDocumentVersion sets the DocumentVersion field's value.

func (*CreateAssociationBatchRequestEntry) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*CreateAssociationBatchRequestEntry) SetMaxConcurrency added in v1.99.0

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*CreateAssociationBatchRequestEntry) SetMaxErrors added in v1.99.0

SetMaxErrors sets the MaxErrors field's value.

func (*CreateAssociationBatchRequestEntry) SetName added in v1.5.0

SetName sets the Name field's value.

func (*CreateAssociationBatchRequestEntry) SetOutputLocation added in v1.5.13

SetOutputLocation sets the OutputLocation field's value.

func (*CreateAssociationBatchRequestEntry) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (*CreateAssociationBatchRequestEntry) SetScheduleExpression added in v1.5.13

SetScheduleExpression sets the ScheduleExpression field's value.

func (*CreateAssociationBatchRequestEntry) SetTargets added in v1.5.13

SetTargets sets the Targets field's value.

func (CreateAssociationBatchRequestEntry) String added in v0.6.5

String returns the string representation

func (*CreateAssociationBatchRequestEntry) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type CreateAssociationInput

type CreateAssociationInput struct {

	// Specify a descriptive name for the association.
	AssociationName *string `type:"string"`

	// Specify the target for the association. This target is required for associations
	// that use an Automation document and target resources by using rate controls.
	AutomationTargetParameterName *string `min:"1" type:"string"`

	// The severity level to assign to the association.
	ComplianceSeverity *string `type:"string" enum:"AssociationComplianceSeverity"`

	// The document version you want to associate with the target(s). Can be a specific
	// version or the default version.
	DocumentVersion *string `type:"string"`

	// The instance ID.
	InstanceId *string `type:"string"`

	// The maximum number of targets allowed to run the association at the same
	// time. You can specify a number, for example 10, or a percentage of the target
	// set, for example 10%. The default value is 100%, which means all targets
	// run the association at the same time.
	//
	// If a new instance starts and attempts to run an association while Systems
	// Manager is running MaxConcurrency associations, the association is allowed
	// to run. During the next association interval, the new instance will process
	// its association within the limit specified for MaxConcurrency.
	MaxConcurrency *string `min:"1" type:"string"`

	// The number of errors that are allowed before the system stops sending requests
	// to run the association on additional targets. You can specify either an absolute
	// number of errors, for example 10, or a percentage of the target set, for
	// example 10%. If you specify 3, for example, the system stops sending requests
	// when the fourth error is received. If you specify 0, then the system stops
	// sending requests after the first error is returned. If you run an association
	// on 50 instances and set MaxError to 10%, then the system stops sending the
	// request when the sixth error is received.
	//
	// Executions that are already running an association when MaxErrors is reached
	// are allowed to complete, but some of these executions may fail as well. If
	// you need to ensure that there won't be more than max-errors failed executions,
	// set MaxConcurrency to 1 so that executions proceed one at a time.
	MaxErrors *string `min:"1" type:"string"`

	// The name of the SSM document that contains the configuration information
	// for the instance. You can specify Command or Automation documents.
	//
	// You can specify AWS-predefined documents, documents you created, or a document
	// that is shared with you from another account.
	//
	// For SSM documents that are shared with you from other AWS accounts, you must
	// specify the complete SSM document ARN, in the following format:
	//
	// arn:partition:ssm:region:account-id:document/document-name
	//
	// For example:
	//
	// arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
	//
	// For AWS-predefined documents and SSM documents you created in your account,
	// you only need to specify the document name. For example, AWS-ApplyPatchBaseline
	// or My-Document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// An Amazon S3 bucket where you want to store the output details of the request.
	OutputLocation *InstanceAssociationOutputLocation `type:"structure"`

	// The parameters for the runtime configuration of the document.
	Parameters map[string][]*string `type:"map"`

	// A cron expression when the association will be applied to the target(s).
	ScheduleExpression *string `min:"1" type:"string"`

	// The targets (either instances or tags) for the association.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

func (CreateAssociationInput) GoString added in v0.6.5

func (s CreateAssociationInput) GoString() string

GoString returns the string representation

func (*CreateAssociationInput) SetAssociationName added in v1.10.30

func (s *CreateAssociationInput) SetAssociationName(v string) *CreateAssociationInput

SetAssociationName sets the AssociationName field's value.

func (*CreateAssociationInput) SetAutomationTargetParameterName added in v1.99.0

func (s *CreateAssociationInput) SetAutomationTargetParameterName(v string) *CreateAssociationInput

SetAutomationTargetParameterName sets the AutomationTargetParameterName field's value.

func (*CreateAssociationInput) SetComplianceSeverity added in v1.99.0

func (s *CreateAssociationInput) SetComplianceSeverity(v string) *CreateAssociationInput

SetComplianceSeverity sets the ComplianceSeverity field's value.

func (*CreateAssociationInput) SetDocumentVersion added in v1.5.13

func (s *CreateAssociationInput) SetDocumentVersion(v string) *CreateAssociationInput

SetDocumentVersion sets the DocumentVersion field's value.

func (*CreateAssociationInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*CreateAssociationInput) SetMaxConcurrency added in v1.99.0

func (s *CreateAssociationInput) SetMaxConcurrency(v string) *CreateAssociationInput

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*CreateAssociationInput) SetMaxErrors added in v1.99.0

SetMaxErrors sets the MaxErrors field's value.

func (*CreateAssociationInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*CreateAssociationInput) SetOutputLocation added in v1.5.13

SetOutputLocation sets the OutputLocation field's value.

func (*CreateAssociationInput) SetParameters added in v1.5.0

func (s *CreateAssociationInput) SetParameters(v map[string][]*string) *CreateAssociationInput

SetParameters sets the Parameters field's value.

func (*CreateAssociationInput) SetScheduleExpression added in v1.5.13

func (s *CreateAssociationInput) SetScheduleExpression(v string) *CreateAssociationInput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*CreateAssociationInput) SetTargets added in v1.5.13

SetTargets sets the Targets field's value.

func (CreateAssociationInput) String added in v0.6.5

func (s CreateAssociationInput) String() string

String returns the string representation

func (*CreateAssociationInput) Validate added in v1.1.21

func (s *CreateAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAssociationOutput

type CreateAssociationOutput struct {

	// Information about the association.
	AssociationDescription *AssociationDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAssociationOutput) GoString added in v0.6.5

func (s CreateAssociationOutput) GoString() string

GoString returns the string representation

func (*CreateAssociationOutput) SetAssociationDescription added in v1.5.0

SetAssociationDescription sets the AssociationDescription field's value.

func (CreateAssociationOutput) String added in v0.6.5

func (s CreateAssociationOutput) String() string

String returns the string representation

type CreateDocumentInput

type CreateDocumentInput struct {

	// A list of key and value pairs that describe attachments to a version of a
	// document.
	Attachments []*AttachmentsSource `type:"list"`

	// A valid JSON or YAML string.
	//
	// Content is a required field
	Content *string `min:"1" type:"string" required:"true"`

	// Specify the document format for the request. The document format can be either
	// JSON or YAML. JSON is the default format.
	DocumentFormat *string `type:"string" enum:"DocumentFormat"`

	// The type of document to create. Valid document types include: Command, Policy,
	// Automation, Session, and Package.
	DocumentType *string `type:"string" enum:"DocumentType"`

	// A name for the Systems Manager document.
	//
	// Do not use the following to begin the names of documents you create. They
	// are reserved by AWS for use as document prefixes:
	//
	//    * aws
	//
	//    * amazon
	//
	//    * amzn
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Optional metadata that you assign to a resource. Tags enable you to categorize
	// a resource in different ways, such as by purpose, owner, or environment.
	// For example, you might want to tag an SSM document to identify the types
	// of targets or the environment where it will run. In this case, you could
	// specify the following key name/value pairs:
	//
	//    * Key=OS,Value=Windows
	//
	//    * Key=Environment,Value=Production
	//
	// To add tags to an existing SSM document, use the AddTagsToResource action.
	Tags []*Tag `type:"list"`

	// Specify a target type to define the kinds of resources the document can run
	// on. For example, to run a document on EC2 instances, specify the following
	// value: /AWS::EC2::Instance. If you specify a value of '/' the document can
	// run on all types of resources. If you don't specify a value, the document
	// can't run on any resources. For a list of valid resource types, see AWS Resource
	// Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.
	TargetType *string `type:"string"`

	// An optional field specifying the version of the artifact you are creating
	// with the document. For example, "Release 12, Update 6". This value is unique
	// across all versions of a document, and cannot be changed.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDocumentInput) GoString added in v0.6.5

func (s CreateDocumentInput) GoString() string

GoString returns the string representation

func (*CreateDocumentInput) SetAttachments added in v1.99.0

SetAttachments sets the Attachments field's value.

func (*CreateDocumentInput) SetContent added in v1.5.0

SetContent sets the Content field's value.

func (*CreateDocumentInput) SetDocumentFormat added in v1.12.37

func (s *CreateDocumentInput) SetDocumentFormat(v string) *CreateDocumentInput

SetDocumentFormat sets the DocumentFormat field's value.

func (*CreateDocumentInput) SetDocumentType added in v1.5.13

func (s *CreateDocumentInput) SetDocumentType(v string) *CreateDocumentInput

SetDocumentType sets the DocumentType field's value.

func (*CreateDocumentInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*CreateDocumentInput) SetTags added in v1.99.0

func (s *CreateDocumentInput) SetTags(v []*Tag) *CreateDocumentInput

SetTags sets the Tags field's value.

func (*CreateDocumentInput) SetTargetType added in v1.12.37

func (s *CreateDocumentInput) SetTargetType(v string) *CreateDocumentInput

SetTargetType sets the TargetType field's value.

func (*CreateDocumentInput) SetVersionName added in v1.99.0

func (s *CreateDocumentInput) SetVersionName(v string) *CreateDocumentInput

SetVersionName sets the VersionName field's value.

func (CreateDocumentInput) String added in v0.6.5

func (s CreateDocumentInput) String() string

String returns the string representation

func (*CreateDocumentInput) Validate added in v1.1.21

func (s *CreateDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDocumentOutput

type CreateDocumentOutput struct {

	// Information about the Systems Manager document.
	DocumentDescription *DocumentDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDocumentOutput) GoString added in v0.6.5

func (s CreateDocumentOutput) GoString() string

GoString returns the string representation

func (*CreateDocumentOutput) SetDocumentDescription added in v1.5.0

func (s *CreateDocumentOutput) SetDocumentDescription(v *DocumentDescription) *CreateDocumentOutput

SetDocumentDescription sets the DocumentDescription field's value.

func (CreateDocumentOutput) String added in v0.6.5

func (s CreateDocumentOutput) String() string

String returns the string representation

type CreateMaintenanceWindowInput added in v1.5.13

type CreateMaintenanceWindowInput struct {

	// Enables a maintenance window task to run on managed instances, even if you
	// have not registered those instances as targets. If enabled, then you must
	// specify the unregistered instances (by instance ID) when you register a task
	// with the maintenance window.
	//
	// If you don't enable this option, then you must specify previously-registered
	// targets when you register a task with the maintenance window.
	//
	// AllowUnassociatedTargets is a required field
	AllowUnassociatedTargets *bool `type:"boolean" required:"true"`

	// User-provided idempotency token.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	//
	// Cutoff is a required field
	Cutoff *int64 `type:"integer" required:"true"`

	// An optional description for the maintenance window. We recommend specifying
	// a description to help you organize your maintenance windows.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The duration of the maintenance window in hours.
	//
	// Duration is a required field
	Duration *int64 `min:"1" type:"integer" required:"true"`

	// 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 `type:"string"`

	// The name of the maintenance window.
	//
	// Name is a required field
	Name *string `min:"3" type:"string" required:"true"`

	// The schedule of the maintenance window in the form of a cron or rate expression.
	//
	// Schedule is a required field
	Schedule *string `min:"1" type:"string" required:"true"`

	// The time zone that the scheduled maintenance window executions are based
	// on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles",
	// "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database
	// (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string `type:"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 `type:"string"`

	// Optional metadata that you assign to a resource. Tags enable you to categorize
	// a resource in different ways, such as by purpose, owner, or environment.
	// For example, you might want to tag a maintenance window to identify the type
	// of tasks it will run, the types of targets, and the environment it will run
	// in. In this case, you could specify the following key name/value pairs:
	//
	//    * Key=TaskType,Value=AgentUpdate
	//
	//    * Key=OS,Value=Windows
	//
	//    * Key=Environment,Value=Production
	//
	// To add tags to an existing maintenance window, use the AddTagsToResource
	// action.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateMaintenanceWindowInput) GoString added in v1.5.13

func (s CreateMaintenanceWindowInput) GoString() string

GoString returns the string representation

func (*CreateMaintenanceWindowInput) SetAllowUnassociatedTargets added in v1.5.13

func (s *CreateMaintenanceWindowInput) SetAllowUnassociatedTargets(v bool) *CreateMaintenanceWindowInput

SetAllowUnassociatedTargets sets the AllowUnassociatedTargets field's value.

func (*CreateMaintenanceWindowInput) SetClientToken added in v1.5.13

SetClientToken sets the ClientToken field's value.

func (*CreateMaintenanceWindowInput) SetCutoff added in v1.5.13

SetCutoff sets the Cutoff field's value.

func (*CreateMaintenanceWindowInput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*CreateMaintenanceWindowInput) SetDuration added in v1.5.13

SetDuration sets the Duration field's value.

func (*CreateMaintenanceWindowInput) SetEndDate added in v1.99.0

SetEndDate sets the EndDate field's value.

func (*CreateMaintenanceWindowInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*CreateMaintenanceWindowInput) SetSchedule added in v1.5.13

SetSchedule sets the Schedule field's value.

func (*CreateMaintenanceWindowInput) SetScheduleTimezone added in v1.99.0

SetScheduleTimezone sets the ScheduleTimezone field's value.

func (*CreateMaintenanceWindowInput) SetStartDate added in v1.99.0

SetStartDate sets the StartDate field's value.

func (*CreateMaintenanceWindowInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreateMaintenanceWindowInput) String added in v1.5.13

String returns the string representation

func (*CreateMaintenanceWindowInput) Validate added in v1.5.13

func (s *CreateMaintenanceWindowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMaintenanceWindowOutput added in v1.5.13

type CreateMaintenanceWindowOutput struct {

	// The ID of the created maintenance window.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (CreateMaintenanceWindowOutput) GoString added in v1.5.13

GoString returns the string representation

func (*CreateMaintenanceWindowOutput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (CreateMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type CreateOpsItemInput added in v1.99.0

type CreateOpsItemInput struct {

	// Information about the OpsItem.
	//
	// Description is a required field
	Description *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an SNS topic where notifications are sent
	// when this OpsItem is edited or changed.
	Notifications []*OpsItemNotification `type:"list"`

	// Operational data is custom data that provides useful reference details about
	// the OpsItem. For example, you can specify log files, error strings, license
	// keys, troubleshooting tips, or other relevant data. You enter operational
	// data as key-value pairs. The key has a maximum length of 128 characters.
	// The value has a maximum size of 20 KB.
	//
	// Operational data keys can't begin with the following: amazon, aws, amzn,
	// ssm, /amazon, /aws, /amzn, /ssm.
	//
	// You can choose to make the data searchable by other users in the account
	// or you can restrict search access. Searchable data means that all users with
	// access to the OpsItem Overview page (as provided by the DescribeOpsItems
	// API action) can view and search on the specified data. Operational data that
	// is not searchable is only viewable by users who have access to the OpsItem
	// (as provided by the GetOpsItem API action).
	//
	// Use the /aws/resources key in OperationalData to specify a related resource
	// in the request. Use the /aws/automations key in OperationalData to associate
	// an Automation runbook with the OpsItem. To view AWS CLI example commands
	// that use these keys, see Creating OpsItems Manually (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems)
	// in the AWS Systems Manager User Guide.
	OperationalData map[string]*OpsItemDataValue `type:"map"`

	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int64 `min:"1" type:"integer"`

	// 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 []*RelatedOpsItem `type:"list"`

	// The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.
	//
	// Source is a required field
	Source *string `min:"1" type:"string" required:"true"`

	// Optional metadata that you assign to a resource. You can restrict access
	// to OpsItems by using an inline IAM policy that specifies tags. For more information,
	// see Getting Started with OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions)
	// in the AWS Systems Manager User Guide.
	//
	// Tags use a key-value pair. For example:
	//
	// Key=Department,Value=Finance
	//
	// To add tags to an existing OpsItem, use the AddTagsToResource action.
	Tags []*Tag `type:"list"`

	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	//
	// Title is a required field
	Title *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateOpsItemInput) GoString added in v1.99.0

func (s CreateOpsItemInput) GoString() string

GoString returns the string representation

func (*CreateOpsItemInput) SetDescription added in v1.99.0

func (s *CreateOpsItemInput) SetDescription(v string) *CreateOpsItemInput

SetDescription sets the Description field's value.

func (*CreateOpsItemInput) SetNotifications added in v1.99.0

func (s *CreateOpsItemInput) SetNotifications(v []*OpsItemNotification) *CreateOpsItemInput

SetNotifications sets the Notifications field's value.

func (*CreateOpsItemInput) SetOperationalData added in v1.99.0

func (s *CreateOpsItemInput) SetOperationalData(v map[string]*OpsItemDataValue) *CreateOpsItemInput

SetOperationalData sets the OperationalData field's value.

func (*CreateOpsItemInput) SetPriority added in v1.99.0

func (s *CreateOpsItemInput) SetPriority(v int64) *CreateOpsItemInput

SetPriority sets the Priority field's value.

func (*CreateOpsItemInput) SetRelatedOpsItems added in v1.99.0

func (s *CreateOpsItemInput) SetRelatedOpsItems(v []*RelatedOpsItem) *CreateOpsItemInput

SetRelatedOpsItems sets the RelatedOpsItems field's value.

func (*CreateOpsItemInput) SetSource added in v1.99.0

func (s *CreateOpsItemInput) SetSource(v string) *CreateOpsItemInput

SetSource sets the Source field's value.

func (*CreateOpsItemInput) SetTags added in v1.99.0

func (s *CreateOpsItemInput) SetTags(v []*Tag) *CreateOpsItemInput

SetTags sets the Tags field's value.

func (*CreateOpsItemInput) SetTitle added in v1.99.0

SetTitle sets the Title field's value.

func (CreateOpsItemInput) String added in v1.99.0

func (s CreateOpsItemInput) String() string

String returns the string representation

func (*CreateOpsItemInput) Validate added in v1.99.0

func (s *CreateOpsItemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateOpsItemOutput added in v1.99.0

type CreateOpsItemOutput struct {

	// The ID of the OpsItem.
	OpsItemId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateOpsItemOutput) GoString added in v1.99.0

func (s CreateOpsItemOutput) GoString() string

GoString returns the string representation

func (*CreateOpsItemOutput) SetOpsItemId added in v1.99.0

func (s *CreateOpsItemOutput) SetOpsItemId(v string) *CreateOpsItemOutput

SetOpsItemId sets the OpsItemId field's value.

func (CreateOpsItemOutput) String added in v1.99.0

func (s CreateOpsItemOutput) String() string

String returns the string representation

type CreatePatchBaselineInput added in v1.6.4

type CreatePatchBaselineInput struct {

	// A set of rules used to include patches in the baseline.
	ApprovalRules *PatchRuleGroup `type:"structure"`

	// A list of explicitly approved patches for the baseline.
	//
	// For information about accepted formats for lists of approved patches and
	// rejected patches, see Package Name Formats for Approved and Rejected Patch
	// Lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	ApprovedPatches []*string `type:"list"`

	// Defines the compliance level for approved patches. This means that if an
	// approved patch is reported as missing, this is the severity of the compliance
	// violation. The default value is UNSPECIFIED.
	ApprovedPatchesComplianceLevel *string `type:"string" enum:"PatchComplianceLevel"`

	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool `type:"boolean"`

	// User-provided idempotency token.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description of the patch baseline.
	Description *string `min:"1" type:"string"`

	// A set of global filters used to include patches in the baseline.
	GlobalFilters *PatchFilterGroup `type:"structure"`

	// The name of the patch baseline.
	//
	// Name is a required field
	Name *string `min:"3" type:"string" required:"true"`

	// Defines the operating system the patch baseline applies to. The Default value
	// is WINDOWS.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// A list of explicitly rejected patches for the baseline.
	//
	// For information about accepted formats for lists of approved patches and
	// rejected patches, see Package Name Formats for Approved and Rejected Patch
	// Lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	RejectedPatches []*string `type:"list"`

	// The action for Patch Manager to take on patches included in the RejectedPackages
	// list.
	//
	//    * ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed
	//    only if it is a dependency of another package. It is considered compliant
	//    with the patch baseline, and its status is reported as InstalledOther.
	//    This is the default action if no option is specified.
	//
	//    * BLOCK: Packages in the RejectedPatches list, and packages that include
	//    them as dependencies, are not installed under any circumstances. If a
	//    package was installed before it was added to the Rejected patches list,
	//    it is considered non-compliant with the patch baseline, and its status
	//    is reported as InstalledRejected.
	RejectedPatchesAction *string `type:"string" enum:"PatchAction"`

	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*PatchSource `type:"list"`

	// Optional metadata that you assign to a resource. Tags enable you to categorize
	// a resource in different ways, such as by purpose, owner, or environment.
	// For example, you might want to tag a patch baseline to identify the severity
	// level of patches it specifies and the operating system family it applies
	// to. In this case, you could specify the following key name/value pairs:
	//
	//    * Key=PatchSeverity,Value=Critical
	//
	//    * Key=OS,Value=Windows
	//
	// To add tags to an existing patch baseline, use the AddTagsToResource action.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreatePatchBaselineInput) GoString added in v1.6.4

func (s CreatePatchBaselineInput) GoString() string

GoString returns the string representation

func (*CreatePatchBaselineInput) SetApprovalRules added in v1.6.4

SetApprovalRules sets the ApprovalRules field's value.

func (*CreatePatchBaselineInput) SetApprovedPatches added in v1.6.4

func (s *CreatePatchBaselineInput) SetApprovedPatches(v []*string) *CreatePatchBaselineInput

SetApprovedPatches sets the ApprovedPatches field's value.

func (*CreatePatchBaselineInput) SetApprovedPatchesComplianceLevel added in v1.10.8

func (s *CreatePatchBaselineInput) SetApprovedPatchesComplianceLevel(v string) *CreatePatchBaselineInput

SetApprovedPatchesComplianceLevel sets the ApprovedPatchesComplianceLevel field's value.

func (*CreatePatchBaselineInput) SetApprovedPatchesEnableNonSecurity added in v1.12.72

func (s *CreatePatchBaselineInput) SetApprovedPatchesEnableNonSecurity(v bool) *CreatePatchBaselineInput

SetApprovedPatchesEnableNonSecurity sets the ApprovedPatchesEnableNonSecurity field's value.

func (*CreatePatchBaselineInput) SetClientToken added in v1.6.4

SetClientToken sets the ClientToken field's value.

func (*CreatePatchBaselineInput) SetDescription added in v1.6.4

SetDescription sets the Description field's value.

func (*CreatePatchBaselineInput) SetGlobalFilters added in v1.6.4

SetGlobalFilters sets the GlobalFilters field's value.

func (*CreatePatchBaselineInput) SetName added in v1.6.4

SetName sets the Name field's value.

func (*CreatePatchBaselineInput) SetOperatingSystem added in v1.10.8

func (s *CreatePatchBaselineInput) SetOperatingSystem(v string) *CreatePatchBaselineInput

SetOperatingSystem sets the OperatingSystem field's value.

func (*CreatePatchBaselineInput) SetRejectedPatches added in v1.6.4

func (s *CreatePatchBaselineInput) SetRejectedPatches(v []*string) *CreatePatchBaselineInput

SetRejectedPatches sets the RejectedPatches field's value.

func (*CreatePatchBaselineInput) SetRejectedPatchesAction added in v1.99.0

func (s *CreatePatchBaselineInput) SetRejectedPatchesAction(v string) *CreatePatchBaselineInput

SetRejectedPatchesAction sets the RejectedPatchesAction field's value.

func (*CreatePatchBaselineInput) SetSources added in v1.12.72

SetSources sets the Sources field's value.

func (*CreatePatchBaselineInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (CreatePatchBaselineInput) String added in v1.6.4

func (s CreatePatchBaselineInput) String() string

String returns the string representation

func (*CreatePatchBaselineInput) Validate added in v1.6.4

func (s *CreatePatchBaselineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePatchBaselineOutput added in v1.6.4

type CreatePatchBaselineOutput struct {

	// The ID of the created patch baseline.
	BaselineId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (CreatePatchBaselineOutput) GoString added in v1.6.4

func (s CreatePatchBaselineOutput) GoString() string

GoString returns the string representation

func (*CreatePatchBaselineOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (CreatePatchBaselineOutput) String added in v1.6.4

func (s CreatePatchBaselineOutput) String() string

String returns the string representation

type CreateResourceDataSyncInput added in v1.10.5

type CreateResourceDataSyncInput struct {

	// Amazon S3 configuration details for the sync.
	//
	// S3Destination is a required field
	S3Destination *ResourceDataSyncS3Destination `type:"structure" required:"true"`

	// A name for the configuration.
	//
	// SyncName is a required field
	SyncName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateResourceDataSyncInput) GoString added in v1.10.5

func (s CreateResourceDataSyncInput) GoString() string

GoString returns the string representation

func (*CreateResourceDataSyncInput) SetS3Destination added in v1.10.5

SetS3Destination sets the S3Destination field's value.

func (*CreateResourceDataSyncInput) SetSyncName added in v1.10.5

SetSyncName sets the SyncName field's value.

func (CreateResourceDataSyncInput) String added in v1.10.5

String returns the string representation

func (*CreateResourceDataSyncInput) Validate added in v1.10.5

func (s *CreateResourceDataSyncInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateResourceDataSyncOutput added in v1.10.5

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

func (CreateResourceDataSyncOutput) GoString added in v1.10.5

func (s CreateResourceDataSyncOutput) GoString() string

GoString returns the string representation

func (CreateResourceDataSyncOutput) String added in v1.10.5

String returns the string representation

type DeleteActivationInput added in v1.2.2

type DeleteActivationInput struct {

	// The ID of the activation that you want to delete.
	//
	// ActivationId is a required field
	ActivationId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteActivationInput) GoString added in v1.2.2

func (s DeleteActivationInput) GoString() string

GoString returns the string representation

func (*DeleteActivationInput) SetActivationId added in v1.5.0

func (s *DeleteActivationInput) SetActivationId(v string) *DeleteActivationInput

SetActivationId sets the ActivationId field's value.

func (DeleteActivationInput) String added in v1.2.2

func (s DeleteActivationInput) String() string

String returns the string representation

func (*DeleteActivationInput) Validate added in v1.2.2

func (s *DeleteActivationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteActivationOutput added in v1.2.2

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

func (DeleteActivationOutput) GoString added in v1.2.2

func (s DeleteActivationOutput) GoString() string

GoString returns the string representation

func (DeleteActivationOutput) String added in v1.2.2

func (s DeleteActivationOutput) String() string

String returns the string representation

type DeleteAssociationInput

type DeleteAssociationInput struct {

	// The association ID that you want to delete.
	AssociationId *string `type:"string"`

	// The ID of the instance.
	InstanceId *string `type:"string"`

	// The name of the Systems Manager document.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteAssociationInput) GoString added in v0.6.5

func (s DeleteAssociationInput) GoString() string

GoString returns the string representation

func (*DeleteAssociationInput) SetAssociationId added in v1.5.13

func (s *DeleteAssociationInput) SetAssociationId(v string) *DeleteAssociationInput

SetAssociationId sets the AssociationId field's value.

func (*DeleteAssociationInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*DeleteAssociationInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (DeleteAssociationInput) String added in v0.6.5

func (s DeleteAssociationInput) String() string

String returns the string representation

type DeleteAssociationOutput

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

func (DeleteAssociationOutput) GoString added in v0.6.5

func (s DeleteAssociationOutput) GoString() string

GoString returns the string representation

func (DeleteAssociationOutput) String added in v0.6.5

func (s DeleteAssociationOutput) String() string

String returns the string representation

type DeleteDocumentInput

type DeleteDocumentInput struct {

	// The version of the document that you want to delete. If not provided, all
	// versions of the document are deleted.
	DocumentVersion *string `type:"string"`

	// The name of the document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The version name of the document that you want to delete. If not provided,
	// all versions of the document are deleted.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteDocumentInput) GoString added in v0.6.5

func (s DeleteDocumentInput) GoString() string

GoString returns the string representation

func (*DeleteDocumentInput) SetDocumentVersion added in v1.99.0

func (s *DeleteDocumentInput) SetDocumentVersion(v string) *DeleteDocumentInput

SetDocumentVersion sets the DocumentVersion field's value.

func (*DeleteDocumentInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*DeleteDocumentInput) SetVersionName added in v1.99.0

func (s *DeleteDocumentInput) SetVersionName(v string) *DeleteDocumentInput

SetVersionName sets the VersionName field's value.

func (DeleteDocumentInput) String added in v0.6.5

func (s DeleteDocumentInput) String() string

String returns the string representation

func (*DeleteDocumentInput) Validate added in v1.1.21

func (s *DeleteDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDocumentOutput

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

func (DeleteDocumentOutput) GoString added in v0.6.5

func (s DeleteDocumentOutput) GoString() string

GoString returns the string representation

func (DeleteDocumentOutput) String added in v0.6.5

func (s DeleteDocumentOutput) String() string

String returns the string representation

type DeleteInventoryInput added in v1.13.33

type DeleteInventoryInput struct {

	// User-provided idempotency token.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 `type:"boolean"`

	// Use the SchemaDeleteOption to delete a custom inventory type (schema). If
	// you don't choose this option, the system only deletes existing inventory
	// data associated with the custom inventory type. Choose one of the following
	// options:
	//
	// DisableSchema: If you choose this option, the system ignores all inventory
	// data for the specified version, and any earlier versions. To enable this
	// schema again, you must call the PutInventory action for a version greater
	// than the disabled version.
	//
	// DeleteSchema: This option deletes the specified custom type from the Inventory
	// service. You can recreate the schema later, if you want.
	SchemaDeleteOption *string `type:"string" enum:"InventorySchemaDeleteOption"`

	// The name of the custom inventory type for which you want to delete either
	// all previously collected data, or the inventory type itself.
	//
	// TypeName is a required field
	TypeName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInventoryInput) GoString added in v1.13.33

func (s DeleteInventoryInput) GoString() string

GoString returns the string representation

func (*DeleteInventoryInput) SetClientToken added in v1.13.33

func (s *DeleteInventoryInput) SetClientToken(v string) *DeleteInventoryInput

SetClientToken sets the ClientToken field's value.

func (*DeleteInventoryInput) SetDryRun added in v1.13.33

SetDryRun sets the DryRun field's value.

func (*DeleteInventoryInput) SetSchemaDeleteOption added in v1.13.33

func (s *DeleteInventoryInput) SetSchemaDeleteOption(v string) *DeleteInventoryInput

SetSchemaDeleteOption sets the SchemaDeleteOption field's value.

func (*DeleteInventoryInput) SetTypeName added in v1.13.33

SetTypeName sets the TypeName field's value.

func (DeleteInventoryInput) String added in v1.13.33

func (s DeleteInventoryInput) String() string

String returns the string representation

func (*DeleteInventoryInput) Validate added in v1.13.33

func (s *DeleteInventoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteInventoryOutput added in v1.13.33

type DeleteInventoryOutput struct {

	// Every DeleteInventory action is assigned a unique ID. This option returns
	// a unique ID. You can use this ID to query the status of a delete operation.
	// This option is useful for ensuring that a delete operation has completed
	// before you begin other actions.
	DeletionId *string `type:"string"`

	// A summary of the delete operation. For more information about this summary,
	// see Understanding the Delete Inventory Summary (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-delete.html#sysman-inventory-delete-summary)
	// in the AWS Systems Manager User Guide.
	DeletionSummary *InventoryDeletionSummary `type:"structure"`

	// The name of the inventory data type specified in the request.
	TypeName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteInventoryOutput) GoString added in v1.13.33

func (s DeleteInventoryOutput) GoString() string

GoString returns the string representation

func (*DeleteInventoryOutput) SetDeletionId added in v1.13.33

func (s *DeleteInventoryOutput) SetDeletionId(v string) *DeleteInventoryOutput

SetDeletionId sets the DeletionId field's value.

func (*DeleteInventoryOutput) SetDeletionSummary added in v1.13.33

SetDeletionSummary sets the DeletionSummary field's value.

func (*DeleteInventoryOutput) SetTypeName added in v1.13.33

SetTypeName sets the TypeName field's value.

func (DeleteInventoryOutput) String added in v1.13.33

func (s DeleteInventoryOutput) String() string

String returns the string representation

type DeleteMaintenanceWindowInput added in v1.5.13

type DeleteMaintenanceWindowInput struct {

	// The ID of the maintenance window to delete.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMaintenanceWindowInput) GoString added in v1.5.13

func (s DeleteMaintenanceWindowInput) GoString() string

GoString returns the string representation

func (*DeleteMaintenanceWindowInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (DeleteMaintenanceWindowInput) String added in v1.5.13

String returns the string representation

func (*DeleteMaintenanceWindowInput) Validate added in v1.5.13

func (s *DeleteMaintenanceWindowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMaintenanceWindowOutput added in v1.5.13

type DeleteMaintenanceWindowOutput struct {

	// The ID of the deleted maintenance window.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteMaintenanceWindowOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DeleteMaintenanceWindowOutput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (DeleteMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type DeleteParameterInput added in v1.5.13

type DeleteParameterInput struct {

	// The name of the parameter to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteParameterInput) GoString added in v1.5.13

func (s DeleteParameterInput) GoString() string

GoString returns the string representation

func (*DeleteParameterInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (DeleteParameterInput) String added in v1.5.13

func (s DeleteParameterInput) String() string

String returns the string representation

func (*DeleteParameterInput) Validate added in v1.5.13

func (s *DeleteParameterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteParameterOutput added in v1.5.13

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

func (DeleteParameterOutput) GoString added in v1.5.13

func (s DeleteParameterOutput) GoString() string

GoString returns the string representation

func (DeleteParameterOutput) String added in v1.5.13

func (s DeleteParameterOutput) String() string

String returns the string representation

type DeleteParametersInput added in v1.10.1

type DeleteParametersInput struct {

	// The names of the parameters to delete.
	//
	// Names is a required field
	Names []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteParametersInput) GoString added in v1.10.1

func (s DeleteParametersInput) GoString() string

GoString returns the string representation

func (*DeleteParametersInput) SetNames added in v1.10.1

SetNames sets the Names field's value.

func (DeleteParametersInput) String added in v1.10.1

func (s DeleteParametersInput) String() string

String returns the string representation

func (*DeleteParametersInput) Validate added in v1.10.1

func (s *DeleteParametersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteParametersOutput added in v1.10.1

type DeleteParametersOutput struct {

	// The names of the deleted parameters.
	DeletedParameters []*string `min:"1" type:"list"`

	// The names of parameters that weren't deleted because the parameters are not
	// valid.
	InvalidParameters []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DeleteParametersOutput) GoString added in v1.10.1

func (s DeleteParametersOutput) GoString() string

GoString returns the string representation

func (*DeleteParametersOutput) SetDeletedParameters added in v1.10.1

func (s *DeleteParametersOutput) SetDeletedParameters(v []*string) *DeleteParametersOutput

SetDeletedParameters sets the DeletedParameters field's value.

func (*DeleteParametersOutput) SetInvalidParameters added in v1.10.1

func (s *DeleteParametersOutput) SetInvalidParameters(v []*string) *DeleteParametersOutput

SetInvalidParameters sets the InvalidParameters field's value.

func (DeleteParametersOutput) String added in v1.10.1

func (s DeleteParametersOutput) String() string

String returns the string representation

type DeletePatchBaselineInput added in v1.6.4

type DeletePatchBaselineInput struct {

	// The ID of the patch baseline to delete.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePatchBaselineInput) GoString added in v1.6.4

func (s DeletePatchBaselineInput) GoString() string

GoString returns the string representation

func (*DeletePatchBaselineInput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (DeletePatchBaselineInput) String added in v1.6.4

func (s DeletePatchBaselineInput) String() string

String returns the string representation

func (*DeletePatchBaselineInput) Validate added in v1.6.4

func (s *DeletePatchBaselineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePatchBaselineOutput added in v1.6.4

type DeletePatchBaselineOutput struct {

	// The ID of the deleted patch baseline.
	BaselineId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (DeletePatchBaselineOutput) GoString added in v1.6.4

func (s DeletePatchBaselineOutput) GoString() string

GoString returns the string representation

func (*DeletePatchBaselineOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (DeletePatchBaselineOutput) String added in v1.6.4

func (s DeletePatchBaselineOutput) String() string

String returns the string representation

type DeleteResourceDataSyncInput added in v1.10.5

type DeleteResourceDataSyncInput struct {

	// The name of the configuration to delete.
	//
	// SyncName is a required field
	SyncName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteResourceDataSyncInput) GoString added in v1.10.5

func (s DeleteResourceDataSyncInput) GoString() string

GoString returns the string representation

func (*DeleteResourceDataSyncInput) SetSyncName added in v1.10.5

SetSyncName sets the SyncName field's value.

func (DeleteResourceDataSyncInput) String added in v1.10.5

String returns the string representation

func (*DeleteResourceDataSyncInput) Validate added in v1.10.5

func (s *DeleteResourceDataSyncInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteResourceDataSyncOutput added in v1.10.5

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

func (DeleteResourceDataSyncOutput) GoString added in v1.10.5

func (s DeleteResourceDataSyncOutput) GoString() string

GoString returns the string representation

func (DeleteResourceDataSyncOutput) String added in v1.10.5

String returns the string representation

type DeregisterManagedInstanceInput added in v1.2.2

type DeregisterManagedInstanceInput struct {

	// The ID assigned to the managed instance when you registered it using the
	// activation process.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterManagedInstanceInput) GoString added in v1.2.2

GoString returns the string representation

func (*DeregisterManagedInstanceInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (DeregisterManagedInstanceInput) String added in v1.2.2

String returns the string representation

func (*DeregisterManagedInstanceInput) Validate added in v1.2.2

func (s *DeregisterManagedInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterManagedInstanceOutput added in v1.2.2

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

func (DeregisterManagedInstanceOutput) GoString added in v1.2.2

GoString returns the string representation

func (DeregisterManagedInstanceOutput) String added in v1.2.2

String returns the string representation

type DeregisterPatchBaselineForPatchGroupInput added in v1.6.4

type DeregisterPatchBaselineForPatchGroupInput struct {

	// The ID of the patch baseline to deregister the patch group from.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`

	// The name of the patch group that should be deregistered from the patch baseline.
	//
	// PatchGroup is a required field
	PatchGroup *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterPatchBaselineForPatchGroupInput) GoString added in v1.6.4

GoString returns the string representation

func (*DeregisterPatchBaselineForPatchGroupInput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*DeregisterPatchBaselineForPatchGroupInput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (DeregisterPatchBaselineForPatchGroupInput) String added in v1.6.4

String returns the string representation

func (*DeregisterPatchBaselineForPatchGroupInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type DeregisterPatchBaselineForPatchGroupOutput added in v1.6.4

type DeregisterPatchBaselineForPatchGroupOutput struct {

	// The ID of the patch baseline the patch group was deregistered from.
	BaselineId *string `min:"20" type:"string"`

	// The name of the patch group deregistered from the patch baseline.
	PatchGroup *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeregisterPatchBaselineForPatchGroupOutput) GoString added in v1.6.4

GoString returns the string representation

func (*DeregisterPatchBaselineForPatchGroupOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*DeregisterPatchBaselineForPatchGroupOutput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (DeregisterPatchBaselineForPatchGroupOutput) String added in v1.6.4

String returns the string representation

type DeregisterTargetFromMaintenanceWindowInput added in v1.5.13

type DeregisterTargetFromMaintenanceWindowInput struct {

	// The system checks if the target is being referenced by a task. If the target
	// is being referenced, the system returns an error and does not deregister
	// the target from the maintenance window.
	Safe *bool `type:"boolean"`

	// The ID of the maintenance window the target should be removed from.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`

	// The ID of the target definition to remove.
	//
	// WindowTargetId is a required field
	WindowTargetId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterTargetFromMaintenanceWindowInput) GoString added in v1.5.13

GoString returns the string representation

func (*DeregisterTargetFromMaintenanceWindowInput) SetSafe added in v1.10.25

SetSafe sets the Safe field's value.

func (*DeregisterTargetFromMaintenanceWindowInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (*DeregisterTargetFromMaintenanceWindowInput) SetWindowTargetId added in v1.5.13

SetWindowTargetId sets the WindowTargetId field's value.

func (DeregisterTargetFromMaintenanceWindowInput) String added in v1.5.13

String returns the string representation

func (*DeregisterTargetFromMaintenanceWindowInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DeregisterTargetFromMaintenanceWindowOutput added in v1.5.13

type DeregisterTargetFromMaintenanceWindowOutput struct {

	// The ID of the maintenance window the target was removed from.
	WindowId *string `min:"20" type:"string"`

	// The ID of the removed target definition.
	WindowTargetId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (DeregisterTargetFromMaintenanceWindowOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DeregisterTargetFromMaintenanceWindowOutput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (*DeregisterTargetFromMaintenanceWindowOutput) SetWindowTargetId added in v1.5.13

SetWindowTargetId sets the WindowTargetId field's value.

func (DeregisterTargetFromMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type DeregisterTaskFromMaintenanceWindowInput added in v1.5.13

type DeregisterTaskFromMaintenanceWindowInput struct {

	// The ID of the maintenance window the task should be removed from.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`

	// The ID of the task to remove from the maintenance window.
	//
	// WindowTaskId is a required field
	WindowTaskId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterTaskFromMaintenanceWindowInput) GoString added in v1.5.13

GoString returns the string representation

func (*DeregisterTaskFromMaintenanceWindowInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (*DeregisterTaskFromMaintenanceWindowInput) SetWindowTaskId added in v1.5.13

SetWindowTaskId sets the WindowTaskId field's value.

func (DeregisterTaskFromMaintenanceWindowInput) String added in v1.5.13

String returns the string representation

func (*DeregisterTaskFromMaintenanceWindowInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DeregisterTaskFromMaintenanceWindowOutput added in v1.5.13

type DeregisterTaskFromMaintenanceWindowOutput struct {

	// The ID of the maintenance window the task was removed from.
	WindowId *string `min:"20" type:"string"`

	// The ID of the task removed from the maintenance window.
	WindowTaskId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (DeregisterTaskFromMaintenanceWindowOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DeregisterTaskFromMaintenanceWindowOutput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (*DeregisterTaskFromMaintenanceWindowOutput) SetWindowTaskId added in v1.5.13

SetWindowTaskId sets the WindowTaskId field's value.

func (DeregisterTaskFromMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type DescribeActivationsFilter added in v1.2.2

type DescribeActivationsFilter struct {

	// The name of the filter.
	FilterKey *string `type:"string" enum:"DescribeActivationsFilterKeys"`

	// The filter values.
	FilterValues []*string `type:"list"`
	// contains filtered or unexported fields
}

Filter for the DescribeActivation API.

func (DescribeActivationsFilter) GoString added in v1.2.2

func (s DescribeActivationsFilter) GoString() string

GoString returns the string representation

func (*DescribeActivationsFilter) SetFilterKey added in v1.5.0

SetFilterKey sets the FilterKey field's value.

func (*DescribeActivationsFilter) SetFilterValues added in v1.5.0

SetFilterValues sets the FilterValues field's value.

func (DescribeActivationsFilter) String added in v1.2.2

func (s DescribeActivationsFilter) String() string

String returns the string representation

type DescribeActivationsInput added in v1.2.2

type DescribeActivationsInput struct {

	// A filter to view information about your activations.
	Filters []*DescribeActivationsFilter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeActivationsInput) GoString added in v1.2.2

func (s DescribeActivationsInput) GoString() string

GoString returns the string representation

func (*DescribeActivationsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*DescribeActivationsInput) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeActivationsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeActivationsInput) String added in v1.2.2

func (s DescribeActivationsInput) String() string

String returns the string representation

func (*DescribeActivationsInput) Validate added in v1.2.2

func (s *DescribeActivationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeActivationsOutput added in v1.2.2

type DescribeActivationsOutput struct {

	// A list of activations for your AWS account.
	ActivationList []*Activation `type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeActivationsOutput) GoString added in v1.2.2

func (s DescribeActivationsOutput) GoString() string

GoString returns the string representation

func (*DescribeActivationsOutput) SetActivationList added in v1.5.0

SetActivationList sets the ActivationList field's value.

func (*DescribeActivationsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeActivationsOutput) String added in v1.2.2

func (s DescribeActivationsOutput) String() string

String returns the string representation

type DescribeAssociationExecutionTargetsInput added in v1.14.18

type DescribeAssociationExecutionTargetsInput struct {

	// The association ID that includes the execution for which you want to view
	// details.
	//
	// AssociationId is a required field
	AssociationId *string `type:"string" required:"true"`

	// The execution ID for which you want to view details.
	//
	// ExecutionId is a required field
	ExecutionId *string `type:"string" required:"true"`

	// Filters for the request. You can specify the following filters and values.
	//
	// Status (EQUAL)
	//
	// ResourceId (EQUAL)
	//
	// ResourceType (EQUAL)
	Filters []*AssociationExecutionTargetsFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAssociationExecutionTargetsInput) GoString added in v1.14.18

GoString returns the string representation

func (*DescribeAssociationExecutionTargetsInput) SetAssociationId added in v1.14.18

SetAssociationId sets the AssociationId field's value.

func (*DescribeAssociationExecutionTargetsInput) SetExecutionId added in v1.14.18

SetExecutionId sets the ExecutionId field's value.

func (*DescribeAssociationExecutionTargetsInput) SetFilters added in v1.14.18

SetFilters sets the Filters field's value.

func (*DescribeAssociationExecutionTargetsInput) SetMaxResults added in v1.14.18

SetMaxResults sets the MaxResults field's value.

func (*DescribeAssociationExecutionTargetsInput) SetNextToken added in v1.14.18

SetNextToken sets the NextToken field's value.

func (DescribeAssociationExecutionTargetsInput) String added in v1.14.18

String returns the string representation

func (*DescribeAssociationExecutionTargetsInput) Validate added in v1.14.18

Validate inspects the fields of the type to determine if they are valid.

type DescribeAssociationExecutionTargetsOutput added in v1.14.18

type DescribeAssociationExecutionTargetsOutput struct {

	// Information about the execution.
	AssociationExecutionTargets []*AssociationExecutionTarget `type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAssociationExecutionTargetsOutput) GoString added in v1.14.18

GoString returns the string representation

func (*DescribeAssociationExecutionTargetsOutput) SetAssociationExecutionTargets added in v1.14.18

SetAssociationExecutionTargets sets the AssociationExecutionTargets field's value.

func (*DescribeAssociationExecutionTargetsOutput) SetNextToken added in v1.14.18

SetNextToken sets the NextToken field's value.

func (DescribeAssociationExecutionTargetsOutput) String added in v1.14.18

String returns the string representation

type DescribeAssociationExecutionsInput added in v1.14.18

type DescribeAssociationExecutionsInput struct {

	// The association ID for which you want to view execution history details.
	//
	// AssociationId is a required field
	AssociationId *string `type:"string" required:"true"`

	// Filters for the request. You can specify the following filters and values.
	//
	// ExecutionId (EQUAL)
	//
	// Status (EQUAL)
	//
	// CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)
	Filters []*AssociationExecutionFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAssociationExecutionsInput) GoString added in v1.14.18

GoString returns the string representation

func (*DescribeAssociationExecutionsInput) SetAssociationId added in v1.14.18

SetAssociationId sets the AssociationId field's value.

func (*DescribeAssociationExecutionsInput) SetFilters added in v1.14.18

SetFilters sets the Filters field's value.

func (*DescribeAssociationExecutionsInput) SetMaxResults added in v1.14.18

SetMaxResults sets the MaxResults field's value.

func (*DescribeAssociationExecutionsInput) SetNextToken added in v1.14.18

SetNextToken sets the NextToken field's value.

func (DescribeAssociationExecutionsInput) String added in v1.14.18

String returns the string representation

func (*DescribeAssociationExecutionsInput) Validate added in v1.14.18

Validate inspects the fields of the type to determine if they are valid.

type DescribeAssociationExecutionsOutput added in v1.14.18

type DescribeAssociationExecutionsOutput struct {

	// A list of the executions for the specified association ID.
	AssociationExecutions []*AssociationExecution `type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAssociationExecutionsOutput) GoString added in v1.14.18

GoString returns the string representation

func (*DescribeAssociationExecutionsOutput) SetAssociationExecutions added in v1.14.18

SetAssociationExecutions sets the AssociationExecutions field's value.

func (*DescribeAssociationExecutionsOutput) SetNextToken added in v1.14.18

SetNextToken sets the NextToken field's value.

func (DescribeAssociationExecutionsOutput) String added in v1.14.18

String returns the string representation

type DescribeAssociationInput

type DescribeAssociationInput struct {

	// The association ID for which you want information.
	AssociationId *string `type:"string"`

	// Specify the association version to retrieve. To view the latest version,
	// either specify $LATEST for this parameter, or omit this parameter. To view
	// a list of all associations for an instance, use ListAssociations. To get
	// a list of versions for a specific association, use ListAssociationVersions.
	AssociationVersion *string `type:"string"`

	// The instance ID.
	InstanceId *string `type:"string"`

	// The name of the Systems Manager document.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAssociationInput) GoString added in v0.6.5

func (s DescribeAssociationInput) GoString() string

GoString returns the string representation

func (*DescribeAssociationInput) SetAssociationId added in v1.5.13

SetAssociationId sets the AssociationId field's value.

func (*DescribeAssociationInput) SetAssociationVersion added in v1.10.30

func (s *DescribeAssociationInput) SetAssociationVersion(v string) *DescribeAssociationInput

SetAssociationVersion sets the AssociationVersion field's value.

func (*DescribeAssociationInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*DescribeAssociationInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (DescribeAssociationInput) String added in v0.6.5

func (s DescribeAssociationInput) String() string

String returns the string representation

type DescribeAssociationOutput

type DescribeAssociationOutput struct {

	// Information about the association.
	AssociationDescription *AssociationDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAssociationOutput) GoString added in v0.6.5

func (s DescribeAssociationOutput) GoString() string

GoString returns the string representation

func (*DescribeAssociationOutput) SetAssociationDescription added in v1.5.0

SetAssociationDescription sets the AssociationDescription field's value.

func (DescribeAssociationOutput) String added in v0.6.5

func (s DescribeAssociationOutput) String() string

String returns the string representation

type DescribeAutomationExecutionsInput added in v1.5.13

type DescribeAutomationExecutionsInput struct {

	// Filters used to limit the scope of executions that are requested.
	Filters []*AutomationExecutionFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAutomationExecutionsInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeAutomationExecutionsInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeAutomationExecutionsInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeAutomationExecutionsInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (DescribeAutomationExecutionsInput) String added in v1.5.13

String returns the string representation

func (*DescribeAutomationExecutionsInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeAutomationExecutionsOutput added in v1.5.13

type DescribeAutomationExecutionsOutput struct {

	// The list of details about each automation execution which has occurred which
	// matches the filter specification, if any.
	AutomationExecutionMetadataList []*AutomationExecutionMetadata `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAutomationExecutionsOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeAutomationExecutionsOutput) SetAutomationExecutionMetadataList added in v1.5.13

SetAutomationExecutionMetadataList sets the AutomationExecutionMetadataList field's value.

func (*DescribeAutomationExecutionsOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (DescribeAutomationExecutionsOutput) String added in v1.5.13

String returns the string representation

type DescribeAutomationStepExecutionsInput added in v1.12.37

type DescribeAutomationStepExecutionsInput struct {

	// The Automation execution ID for which you want step execution descriptions.
	//
	// AutomationExecutionId is a required field
	AutomationExecutionId *string `min:"36" type:"string" required:"true"`

	// One or more filters to limit the number of step executions returned by the
	// request.
	Filters []*StepExecutionFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// A boolean that indicates whether to list step executions in reverse order
	// by start time. The default value is false.
	ReverseOrder *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeAutomationStepExecutionsInput) GoString added in v1.12.37

GoString returns the string representation

func (*DescribeAutomationStepExecutionsInput) SetAutomationExecutionId added in v1.12.37

SetAutomationExecutionId sets the AutomationExecutionId field's value.

func (*DescribeAutomationStepExecutionsInput) SetFilters added in v1.12.37

SetFilters sets the Filters field's value.

func (*DescribeAutomationStepExecutionsInput) SetMaxResults added in v1.12.37

SetMaxResults sets the MaxResults field's value.

func (*DescribeAutomationStepExecutionsInput) SetNextToken added in v1.12.37

SetNextToken sets the NextToken field's value.

func (*DescribeAutomationStepExecutionsInput) SetReverseOrder added in v1.12.37

SetReverseOrder sets the ReverseOrder field's value.

func (DescribeAutomationStepExecutionsInput) String added in v1.12.37

String returns the string representation

func (*DescribeAutomationStepExecutionsInput) Validate added in v1.12.37

Validate inspects the fields of the type to determine if they are valid.

type DescribeAutomationStepExecutionsOutput added in v1.12.37

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 `type:"string"`

	// A list of details about the current state of all steps that make up an execution.
	StepExecutions []*StepExecution `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAutomationStepExecutionsOutput) GoString added in v1.12.37

GoString returns the string representation

func (*DescribeAutomationStepExecutionsOutput) SetNextToken added in v1.12.37

SetNextToken sets the NextToken field's value.

func (*DescribeAutomationStepExecutionsOutput) SetStepExecutions added in v1.12.37

SetStepExecutions sets the StepExecutions field's value.

func (DescribeAutomationStepExecutionsOutput) String added in v1.12.37

String returns the string representation

type DescribeAvailablePatchesInput added in v1.6.4

type DescribeAvailablePatchesInput struct {

	// Filters used to scope down the returned patches.
	Filters []*PatchOrchestratorFilter `type:"list"`

	// The maximum number of patches to return (per page).
	MaxResults *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAvailablePatchesInput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeAvailablePatchesInput) SetFilters added in v1.6.4

SetFilters sets the Filters field's value.

func (*DescribeAvailablePatchesInput) SetMaxResults added in v1.6.4

SetMaxResults sets the MaxResults field's value.

func (*DescribeAvailablePatchesInput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribeAvailablePatchesInput) String added in v1.6.4

String returns the string representation

func (*DescribeAvailablePatchesInput) Validate added in v1.6.4

func (s *DescribeAvailablePatchesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAvailablePatchesOutput added in v1.6.4

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 `type:"string"`

	// An array of patches. Each entry in the array is a patch structure.
	Patches []*Patch `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAvailablePatchesOutput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeAvailablePatchesOutput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (*DescribeAvailablePatchesOutput) SetPatches added in v1.6.4

SetPatches sets the Patches field's value.

func (DescribeAvailablePatchesOutput) String added in v1.6.4

String returns the string representation

type DescribeDocumentInput

type DescribeDocumentInput struct {

	// The document version for which you want information. Can be a specific version
	// or the default version.
	DocumentVersion *string `type:"string"`

	// The name of the Systems Manager document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// An optional field specifying the version of the artifact associated with
	// the document. For example, "Release 12, Update 6". This value is unique across
	// all versions of a document, and cannot be changed.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDocumentInput) GoString added in v0.6.5

func (s DescribeDocumentInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentInput) SetDocumentVersion added in v1.5.13

func (s *DescribeDocumentInput) SetDocumentVersion(v string) *DescribeDocumentInput

SetDocumentVersion sets the DocumentVersion field's value.

func (*DescribeDocumentInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*DescribeDocumentInput) SetVersionName added in v1.99.0

func (s *DescribeDocumentInput) SetVersionName(v string) *DescribeDocumentInput

SetVersionName sets the VersionName field's value.

func (DescribeDocumentInput) String added in v0.6.5

func (s DescribeDocumentInput) String() string

String returns the string representation

func (*DescribeDocumentInput) Validate added in v1.1.21

func (s *DescribeDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDocumentOutput

type DescribeDocumentOutput struct {

	// Information about the Systems Manager document.
	Document *DocumentDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDocumentOutput) GoString added in v0.6.5

func (s DescribeDocumentOutput) GoString() string

GoString returns the string representation

func (*DescribeDocumentOutput) SetDocument added in v1.5.0

SetDocument sets the Document field's value.

func (DescribeDocumentOutput) String added in v0.6.5

func (s DescribeDocumentOutput) String() string

String returns the string representation

type DescribeDocumentPermissionInput added in v1.1.26

type DescribeDocumentPermissionInput struct {

	// The name of the document for which you are the owner.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The permission type for the document. The permission type can be Share.
	//
	// PermissionType is a required field
	PermissionType *string `type:"string" required:"true" enum:"DocumentPermissionType"`
	// contains filtered or unexported fields
}

func (DescribeDocumentPermissionInput) GoString added in v1.1.26

GoString returns the string representation

func (*DescribeDocumentPermissionInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*DescribeDocumentPermissionInput) SetPermissionType added in v1.5.0

SetPermissionType sets the PermissionType field's value.

func (DescribeDocumentPermissionInput) String added in v1.1.26

String returns the string representation

func (*DescribeDocumentPermissionInput) Validate added in v1.1.26

func (s *DescribeDocumentPermissionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDocumentPermissionOutput added in v1.1.26

type DescribeDocumentPermissionOutput struct {

	// The account IDs that have permission to use this document. The ID can be
	// either an AWS account or All.
	AccountIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeDocumentPermissionOutput) GoString added in v1.1.26

GoString returns the string representation

func (*DescribeDocumentPermissionOutput) SetAccountIds added in v1.5.0

SetAccountIds sets the AccountIds field's value.

func (DescribeDocumentPermissionOutput) String added in v1.1.26

String returns the string representation

type DescribeEffectiveInstanceAssociationsInput added in v1.5.13

type DescribeEffectiveInstanceAssociationsInput struct {

	// The instance ID for which you want to view all associations.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEffectiveInstanceAssociationsInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeEffectiveInstanceAssociationsInput) SetInstanceId added in v1.5.13

SetInstanceId sets the InstanceId field's value.

func (*DescribeEffectiveInstanceAssociationsInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeEffectiveInstanceAssociationsInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (DescribeEffectiveInstanceAssociationsInput) String added in v1.5.13

String returns the string representation

func (*DescribeEffectiveInstanceAssociationsInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeEffectiveInstanceAssociationsOutput added in v1.5.13

type DescribeEffectiveInstanceAssociationsOutput struct {

	// The associations for the requested instance.
	Associations []*InstanceAssociation `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEffectiveInstanceAssociationsOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeEffectiveInstanceAssociationsOutput) SetAssociations added in v1.5.13

SetAssociations sets the Associations field's value.

func (*DescribeEffectiveInstanceAssociationsOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (DescribeEffectiveInstanceAssociationsOutput) String added in v1.5.13

String returns the string representation

type DescribeEffectivePatchesForPatchBaselineInput added in v1.6.4

type DescribeEffectivePatchesForPatchBaselineInput struct {

	// The ID of the patch baseline to retrieve the effective patches for.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`

	// The maximum number of patches to return (per page).
	MaxResults *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEffectivePatchesForPatchBaselineInput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeEffectivePatchesForPatchBaselineInput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*DescribeEffectivePatchesForPatchBaselineInput) SetMaxResults added in v1.6.4

SetMaxResults sets the MaxResults field's value.

func (*DescribeEffectivePatchesForPatchBaselineInput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribeEffectivePatchesForPatchBaselineInput) String added in v1.6.4

String returns the string representation

func (*DescribeEffectivePatchesForPatchBaselineInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type DescribeEffectivePatchesForPatchBaselineOutput added in v1.6.4

type DescribeEffectivePatchesForPatchBaselineOutput struct {

	// An array of patches and patch status.
	EffectivePatches []*EffectivePatch `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEffectivePatchesForPatchBaselineOutput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeEffectivePatchesForPatchBaselineOutput) SetEffectivePatches added in v1.6.4

SetEffectivePatches sets the EffectivePatches field's value.

func (*DescribeEffectivePatchesForPatchBaselineOutput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribeEffectivePatchesForPatchBaselineOutput) String added in v1.6.4

String returns the string representation

type DescribeInstanceAssociationsStatusInput added in v1.5.13

type DescribeInstanceAssociationsStatusInput struct {

	// The instance IDs for which you want association status information.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstanceAssociationsStatusInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeInstanceAssociationsStatusInput) SetInstanceId added in v1.5.13

SetInstanceId sets the InstanceId field's value.

func (*DescribeInstanceAssociationsStatusInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeInstanceAssociationsStatusInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (DescribeInstanceAssociationsStatusInput) String added in v1.5.13

String returns the string representation

func (*DescribeInstanceAssociationsStatusInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeInstanceAssociationsStatusOutput added in v1.5.13

type DescribeInstanceAssociationsStatusOutput struct {

	// Status information about the association.
	InstanceAssociationStatusInfos []*InstanceAssociationStatusInfo `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstanceAssociationsStatusOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeInstanceAssociationsStatusOutput) SetInstanceAssociationStatusInfos added in v1.5.13

SetInstanceAssociationStatusInfos sets the InstanceAssociationStatusInfos field's value.

func (*DescribeInstanceAssociationsStatusOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (DescribeInstanceAssociationsStatusOutput) String added in v1.5.13

String returns the string representation

type DescribeInstanceInformationInput added in v0.9.17

type DescribeInstanceInformationInput struct {

	// One or more filters. Use a filter to return a more specific list of instances.
	// You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.
	Filters []*InstanceInformationStringFilter `type:"list"`

	// This is a legacy method. We recommend that you don't use this method. Instead,
	// use the InstanceInformationFilter action. The InstanceInformationFilter action
	// enables you to return instance information by using tags that are specified
	// as a key-value mapping.
	//
	// If you do use this method, then you can't use the InstanceInformationFilter
	// action. Using this method and the InstanceInformationFilter action causes
	// an exception error.
	InstanceInformationFilterList []*InstanceInformationFilter `type:"list"`

	// 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 *int64 `min:"5" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstanceInformationInput) GoString added in v0.9.17

GoString returns the string representation

func (*DescribeInstanceInformationInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeInstanceInformationInput) SetInstanceInformationFilterList added in v1.5.0

SetInstanceInformationFilterList sets the InstanceInformationFilterList field's value.

func (*DescribeInstanceInformationInput) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeInstanceInformationInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeInstanceInformationInput) String added in v0.9.17

String returns the string representation

func (*DescribeInstanceInformationInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type DescribeInstanceInformationOutput added in v0.9.17

type DescribeInstanceInformationOutput struct {

	// The instance information list.
	InstanceInformationList []*InstanceInformation `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstanceInformationOutput) GoString added in v0.9.17

GoString returns the string representation

func (*DescribeInstanceInformationOutput) SetInstanceInformationList added in v1.5.0

SetInstanceInformationList sets the InstanceInformationList field's value.

func (*DescribeInstanceInformationOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (DescribeInstanceInformationOutput) String added in v0.9.17

String returns the string representation

type DescribeInstancePatchStatesForPatchGroupInput added in v1.6.4

type DescribeInstancePatchStatesForPatchGroupInput struct {

	// 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 []*InstancePatchStateFilter `type:"list"`

	// The maximum number of patches to return (per page).
	MaxResults *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The name of the patch group for which the patch state information should
	// be retrieved.
	//
	// PatchGroup is a required field
	PatchGroup *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeInstancePatchStatesForPatchGroupInput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeInstancePatchStatesForPatchGroupInput) SetFilters added in v1.6.4

SetFilters sets the Filters field's value.

func (*DescribeInstancePatchStatesForPatchGroupInput) SetMaxResults added in v1.6.4

SetMaxResults sets the MaxResults field's value.

func (*DescribeInstancePatchStatesForPatchGroupInput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (*DescribeInstancePatchStatesForPatchGroupInput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (DescribeInstancePatchStatesForPatchGroupInput) String added in v1.6.4

String returns the string representation

func (*DescribeInstancePatchStatesForPatchGroupInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type DescribeInstancePatchStatesForPatchGroupOutput added in v1.6.4

type DescribeInstancePatchStatesForPatchGroupOutput struct {

	// The high-level patch state for the requested instances.
	InstancePatchStates []*InstancePatchState `min:"1" type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstancePatchStatesForPatchGroupOutput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeInstancePatchStatesForPatchGroupOutput) SetInstancePatchStates added in v1.6.4

SetInstancePatchStates sets the InstancePatchStates field's value.

func (*DescribeInstancePatchStatesForPatchGroupOutput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribeInstancePatchStatesForPatchGroupOutput) String added in v1.6.4

String returns the string representation

type DescribeInstancePatchStatesInput added in v1.6.4

type DescribeInstancePatchStatesInput struct {

	// The ID of the instance whose patch state information should be retrieved.
	//
	// InstanceIds is a required field
	InstanceIds []*string `type:"list" required:"true"`

	// The maximum number of instances to return (per page).
	MaxResults *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstancePatchStatesInput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeInstancePatchStatesInput) SetInstanceIds added in v1.6.4

SetInstanceIds sets the InstanceIds field's value.

func (*DescribeInstancePatchStatesInput) SetMaxResults added in v1.6.4

SetMaxResults sets the MaxResults field's value.

func (*DescribeInstancePatchStatesInput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribeInstancePatchStatesInput) String added in v1.6.4

String returns the string representation

func (*DescribeInstancePatchStatesInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type DescribeInstancePatchStatesOutput added in v1.6.4

type DescribeInstancePatchStatesOutput struct {

	// The high-level patch state for the requested instances.
	InstancePatchStates []*InstancePatchState `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstancePatchStatesOutput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeInstancePatchStatesOutput) SetInstancePatchStates added in v1.6.4

SetInstancePatchStates sets the InstancePatchStates field's value.

func (*DescribeInstancePatchStatesOutput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribeInstancePatchStatesOutput) String added in v1.6.4

String returns the string representation

type DescribeInstancePatchesInput added in v1.6.4

type DescribeInstancePatchesInput struct {

	// Each entry in the array is a structure containing:
	//
	// Key (string, between 1 and 128 characters)
	//
	// Values (array of strings, each string between 1 and 256 characters)
	Filters []*PatchOrchestratorFilter `type:"list"`

	// The ID of the instance whose patch state information should be retrieved.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The maximum number of patches to return (per page).
	MaxResults *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInstancePatchesInput) GoString added in v1.6.4

func (s DescribeInstancePatchesInput) GoString() string

GoString returns the string representation

func (*DescribeInstancePatchesInput) SetFilters added in v1.6.4

SetFilters sets the Filters field's value.

func (*DescribeInstancePatchesInput) SetInstanceId added in v1.6.4

SetInstanceId sets the InstanceId field's value.

func (*DescribeInstancePatchesInput) SetMaxResults added in v1.6.4

SetMaxResults sets the MaxResults field's value.

func (*DescribeInstancePatchesInput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribeInstancePatchesInput) String added in v1.6.4

String returns the string representation

func (*DescribeInstancePatchesInput) Validate added in v1.6.4

func (s *DescribeInstancePatchesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeInstancePatchesOutput added in v1.6.4

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 `type:"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 []*PatchComplianceData `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeInstancePatchesOutput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribeInstancePatchesOutput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (*DescribeInstancePatchesOutput) SetPatches added in v1.6.4

SetPatches sets the Patches field's value.

func (DescribeInstancePatchesOutput) String added in v1.6.4

String returns the string representation

type DescribeInventoryDeletionsInput added in v1.13.33

type DescribeInventoryDeletionsInput struct {

	// Specify the delete inventory ID for which you want information. This ID was
	// returned by the DeleteInventory action.
	DeletionId *string `type:"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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInventoryDeletionsInput) GoString added in v1.13.33

GoString returns the string representation

func (*DescribeInventoryDeletionsInput) SetDeletionId added in v1.13.33

SetDeletionId sets the DeletionId field's value.

func (*DescribeInventoryDeletionsInput) SetMaxResults added in v1.13.33

SetMaxResults sets the MaxResults field's value.

func (*DescribeInventoryDeletionsInput) SetNextToken added in v1.13.33

SetNextToken sets the NextToken field's value.

func (DescribeInventoryDeletionsInput) String added in v1.13.33

String returns the string representation

func (*DescribeInventoryDeletionsInput) Validate added in v1.13.33

func (s *DescribeInventoryDeletionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeInventoryDeletionsOutput added in v1.13.33

type DescribeInventoryDeletionsOutput struct {

	// A list of status items for deleted inventory.
	InventoryDeletions []*InventoryDeletionStatusItem `type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInventoryDeletionsOutput) GoString added in v1.13.33

GoString returns the string representation

func (*DescribeInventoryDeletionsOutput) SetInventoryDeletions added in v1.13.33

SetInventoryDeletions sets the InventoryDeletions field's value.

func (*DescribeInventoryDeletionsOutput) SetNextToken added in v1.13.33

SetNextToken sets the NextToken field's value.

func (DescribeInventoryDeletionsOutput) String added in v1.13.33

String returns the string representation

type DescribeMaintenanceWindowExecutionTaskInvocationsInput added in v1.5.13

type DescribeMaintenanceWindowExecutionTaskInvocationsInput struct {

	// 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 []*MaintenanceWindowFilter `type:"list"`

	// 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 *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The ID of the specific task in the maintenance window task that should be
	// retrieved.
	//
	// TaskId is a required field
	TaskId *string `min:"36" type:"string" required:"true"`

	// The ID of the maintenance window execution the task is part of.
	//
	// WindowExecutionId is a required field
	WindowExecutionId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowExecutionTaskInvocationsInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowExecutionTaskInvocationsInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeMaintenanceWindowExecutionTaskInvocationsInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowExecutionTaskInvocationsInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowExecutionTaskInvocationsInput) SetTaskId added in v1.5.13

SetTaskId sets the TaskId field's value.

func (*DescribeMaintenanceWindowExecutionTaskInvocationsInput) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (DescribeMaintenanceWindowExecutionTaskInvocationsInput) String added in v1.5.13

String returns the string representation

func (*DescribeMaintenanceWindowExecutionTaskInvocationsInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowExecutionTaskInvocationsOutput added in v1.5.13

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 `type:"string"`

	// Information about the task invocation results per invocation.
	WindowExecutionTaskInvocationIdentities []*MaintenanceWindowExecutionTaskInvocationIdentity `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowExecutionTaskInvocationsOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput) SetWindowExecutionTaskInvocationIdentities added in v1.5.13

SetWindowExecutionTaskInvocationIdentities sets the WindowExecutionTaskInvocationIdentities field's value.

func (DescribeMaintenanceWindowExecutionTaskInvocationsOutput) String added in v1.5.13

String returns the string representation

type DescribeMaintenanceWindowExecutionTasksInput added in v1.5.13

type DescribeMaintenanceWindowExecutionTasksInput struct {

	// Optional filters used to scope down the returned tasks. The supported filter
	// key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS,
	// FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
	Filters []*MaintenanceWindowFilter `type:"list"`

	// 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 *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The ID of the maintenance window execution whose task executions should be
	// retrieved.
	//
	// WindowExecutionId is a required field
	WindowExecutionId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowExecutionTasksInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowExecutionTasksInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeMaintenanceWindowExecutionTasksInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowExecutionTasksInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowExecutionTasksInput) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (DescribeMaintenanceWindowExecutionTasksInput) String added in v1.5.13

String returns the string representation

func (*DescribeMaintenanceWindowExecutionTasksInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowExecutionTasksOutput added in v1.5.13

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 `type:"string"`

	// Information about the task executions.
	WindowExecutionTaskIdentities []*MaintenanceWindowExecutionTaskIdentity `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowExecutionTasksOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowExecutionTasksOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowExecutionTasksOutput) SetWindowExecutionTaskIdentities added in v1.5.13

SetWindowExecutionTaskIdentities sets the WindowExecutionTaskIdentities field's value.

func (DescribeMaintenanceWindowExecutionTasksOutput) String added in v1.5.13

String returns the string representation

type DescribeMaintenanceWindowExecutionsInput added in v1.5.13

type DescribeMaintenanceWindowExecutionsInput struct {

	// Each entry in the array is a structure containing:
	//
	// Key (string, between 1 and 128 characters)
	//
	// Values (array of strings, each string is between 1 and 256 characters)
	//
	// The supported Keys are ExecutedBefore and ExecutedAfter with the value being
	// a date/time string such as 2016-11-04T05:00:00Z.
	Filters []*MaintenanceWindowFilter `type:"list"`

	// 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 *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The ID of the maintenance window whose executions should be retrieved.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowExecutionsInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowExecutionsInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeMaintenanceWindowExecutionsInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowExecutionsInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowExecutionsInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (DescribeMaintenanceWindowExecutionsInput) String added in v1.5.13

String returns the string representation

func (*DescribeMaintenanceWindowExecutionsInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowExecutionsOutput added in v1.5.13

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 `type:"string"`

	// Information about the maintenance window executions.
	WindowExecutions []*MaintenanceWindowExecution `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowExecutionsOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowExecutionsOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowExecutionsOutput) SetWindowExecutions added in v1.5.13

SetWindowExecutions sets the WindowExecutions field's value.

func (DescribeMaintenanceWindowExecutionsOutput) String added in v1.5.13

String returns the string representation

type DescribeMaintenanceWindowScheduleInput added in v1.99.0

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 []*PatchOrchestratorFilter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The type of resource you want to retrieve information about. For example,
	// "INSTANCE".
	ResourceType *string `type:"string" enum:"MaintenanceWindowResourceType"`

	// The instance ID or key/value pair to retrieve information about.
	Targets []*Target `type:"list"`

	// The ID of the maintenance window to retrieve information about.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowScheduleInput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeMaintenanceWindowScheduleInput) SetFilters added in v1.99.0

SetFilters sets the Filters field's value.

func (*DescribeMaintenanceWindowScheduleInput) SetMaxResults added in v1.99.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowScheduleInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowScheduleInput) SetResourceType added in v1.99.0

SetResourceType sets the ResourceType field's value.

func (*DescribeMaintenanceWindowScheduleInput) SetTargets added in v1.99.0

SetTargets sets the Targets field's value.

func (*DescribeMaintenanceWindowScheduleInput) SetWindowId added in v1.99.0

SetWindowId sets the WindowId field's value.

func (DescribeMaintenanceWindowScheduleInput) String added in v1.99.0

String returns the string representation

func (*DescribeMaintenanceWindowScheduleInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowScheduleOutput added in v1.99.0

type DescribeMaintenanceWindowScheduleOutput struct {

	// The token for the next set of items to return. (You use this token in the
	// next call.)
	NextToken *string `type:"string"`

	// Information about maintenance window executions scheduled for the specified
	// time range.
	ScheduledWindowExecutions []*ScheduledWindowExecution `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowScheduleOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeMaintenanceWindowScheduleOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowScheduleOutput) SetScheduledWindowExecutions added in v1.99.0

SetScheduledWindowExecutions sets the ScheduledWindowExecutions field's value.

func (DescribeMaintenanceWindowScheduleOutput) String added in v1.99.0

String returns the string representation

type DescribeMaintenanceWindowTargetsInput added in v1.5.13

type DescribeMaintenanceWindowTargetsInput struct {

	// Optional filters that can be used to narrow down the scope of the returned
	// window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.
	Filters []*MaintenanceWindowFilter `type:"list"`

	// 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 *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The ID of the maintenance window whose targets should be retrieved.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowTargetsInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowTargetsInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeMaintenanceWindowTargetsInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowTargetsInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowTargetsInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (DescribeMaintenanceWindowTargetsInput) String added in v1.5.13

String returns the string representation

func (*DescribeMaintenanceWindowTargetsInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowTargetsOutput added in v1.5.13

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 `type:"string"`

	// Information about the targets in the maintenance window.
	Targets []*MaintenanceWindowTarget `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowTargetsOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowTargetsOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowTargetsOutput) SetTargets added in v1.5.13

SetTargets sets the Targets field's value.

func (DescribeMaintenanceWindowTargetsOutput) String added in v1.5.13

String returns the string representation

type DescribeMaintenanceWindowTasksInput added in v1.5.13

type DescribeMaintenanceWindowTasksInput struct {

	// Optional filters used to narrow down the scope of the returned tasks. The
	// supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
	Filters []*MaintenanceWindowFilter `type:"list"`

	// 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 *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The ID of the maintenance window whose tasks should be retrieved.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowTasksInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowTasksInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeMaintenanceWindowTasksInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowTasksInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowTasksInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (DescribeMaintenanceWindowTasksInput) String added in v1.5.13

String returns the string representation

func (*DescribeMaintenanceWindowTasksInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowTasksOutput added in v1.5.13

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 `type:"string"`

	// Information about the tasks in the maintenance window.
	Tasks []*MaintenanceWindowTask `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowTasksOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowTasksOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowTasksOutput) SetTasks added in v1.5.13

SetTasks sets the Tasks field's value.

func (DescribeMaintenanceWindowTasksOutput) String added in v1.5.13

String returns the string representation

type DescribeMaintenanceWindowsForTargetInput added in v1.99.0

type DescribeMaintenanceWindowsForTargetInput 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The type of resource you want to retrieve information about. For example,
	// "INSTANCE".
	//
	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true" enum:"MaintenanceWindowResourceType"`

	// The instance ID or key/value pair to retrieve information about.
	//
	// Targets is a required field
	Targets []*Target `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowsForTargetInput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeMaintenanceWindowsForTargetInput) SetMaxResults added in v1.99.0

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowsForTargetInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowsForTargetInput) SetResourceType added in v1.99.0

SetResourceType sets the ResourceType field's value.

func (*DescribeMaintenanceWindowsForTargetInput) SetTargets added in v1.99.0

SetTargets sets the Targets field's value.

func (DescribeMaintenanceWindowsForTargetInput) String added in v1.99.0

String returns the string representation

func (*DescribeMaintenanceWindowsForTargetInput) Validate added in v1.99.0

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowsForTargetOutput added in v1.99.0

type DescribeMaintenanceWindowsForTargetOutput struct {

	// The token for the next set of items to return. (You use this token in the
	// next call.)
	NextToken *string `type:"string"`

	// Information about the maintenance window targets and tasks an instance is
	// associated with.
	WindowIdentities []*MaintenanceWindowIdentityForTarget `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowsForTargetOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeMaintenanceWindowsForTargetOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowsForTargetOutput) SetWindowIdentities added in v1.99.0

SetWindowIdentities sets the WindowIdentities field's value.

func (DescribeMaintenanceWindowsForTargetOutput) String added in v1.99.0

String returns the string representation

type DescribeMaintenanceWindowsInput added in v1.5.13

type DescribeMaintenanceWindowsInput struct {

	// Optional filters used to narrow down the scope of the returned maintenance
	// windows. Supported filter keys are Name and Enabled.
	Filters []*MaintenanceWindowFilter `type:"list"`

	// 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 *int64 `min:"10" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowsInput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowsInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeMaintenanceWindowsInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeMaintenanceWindowsInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (DescribeMaintenanceWindowsInput) String added in v1.5.13

String returns the string representation

func (*DescribeMaintenanceWindowsInput) Validate added in v1.5.13

func (s *DescribeMaintenanceWindowsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMaintenanceWindowsOutput added in v1.5.13

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 `type:"string"`

	// Information about the maintenance windows.
	WindowIdentities []*MaintenanceWindowIdentity `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeMaintenanceWindowsOutput) GoString added in v1.5.13

GoString returns the string representation

func (*DescribeMaintenanceWindowsOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeMaintenanceWindowsOutput) SetWindowIdentities added in v1.5.13

SetWindowIdentities sets the WindowIdentities field's value.

func (DescribeMaintenanceWindowsOutput) String added in v1.5.13

String returns the string representation

type DescribeOpsItemsInput added in v1.99.0

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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`

	// One or more filters to limit the reponse.
	//
	//    * Key: CreatedTime Operations: GreaterThan, LessThan
	//
	//    * Key: LastModifiedBy Operations: Contains, Equals
	//
	//    * Key: LastModifiedTime Operations: GreaterThan, LessThan
	//
	//    * Key: Priority Operations: Equals
	//
	//    * Key: Source Operations: Contains, Equals
	//
	//    * Key: Status Operations: Equals
	//
	//    * Key: Title Operations: Contains
	//
	//    * Key: OperationalData* Operations: Equals
	//
	//    * Key: OperationalDataKey Operations: Equals
	//
	//    * Key: OperationalDataValue Operations: Equals, Contains
	//
	//    * Key: OpsItemId Operations: Equals
	//
	//    * Key: ResourceId Operations: Contains
	//
	//    * Key: AutomationId Operations: Equals
	//
	// *If you filter the response by using the OperationalData operator, specify
	// a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}
	OpsItemFilters []*OpsItemFilter `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeOpsItemsInput) GoString added in v1.99.0

func (s DescribeOpsItemsInput) GoString() string

GoString returns the string representation

func (*DescribeOpsItemsInput) SetMaxResults added in v1.99.0

func (s *DescribeOpsItemsInput) SetMaxResults(v int64) *DescribeOpsItemsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeOpsItemsInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeOpsItemsInput) SetOpsItemFilters added in v1.99.0

func (s *DescribeOpsItemsInput) SetOpsItemFilters(v []*OpsItemFilter) *DescribeOpsItemsInput

SetOpsItemFilters sets the OpsItemFilters field's value.

func (DescribeOpsItemsInput) String added in v1.99.0

func (s DescribeOpsItemsInput) String() string

String returns the string representation

func (*DescribeOpsItemsInput) Validate added in v1.99.0

func (s *DescribeOpsItemsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeOpsItemsOutput added in v1.99.0

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 `type:"string"`

	// A list of OpsItems.
	OpsItemSummaries []*OpsItemSummary `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeOpsItemsOutput) GoString added in v1.99.0

func (s DescribeOpsItemsOutput) GoString() string

GoString returns the string representation

func (*DescribeOpsItemsOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeOpsItemsOutput) SetOpsItemSummaries added in v1.99.0

func (s *DescribeOpsItemsOutput) SetOpsItemSummaries(v []*OpsItemSummary) *DescribeOpsItemsOutput

SetOpsItemSummaries sets the OpsItemSummaries field's value.

func (DescribeOpsItemsOutput) String added in v1.99.0

func (s DescribeOpsItemsOutput) String() string

String returns the string representation

type DescribeParametersInput added in v1.5.13

type DescribeParametersInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*ParametersFilter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// Filters to limit the request results.
	ParameterFilters []*ParameterStringFilter `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeParametersInput) GoString added in v1.5.13

func (s DescribeParametersInput) GoString() string

GoString returns the string representation

func (*DescribeParametersInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*DescribeParametersInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*DescribeParametersInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeParametersInput) SetParameterFilters added in v1.10.1

SetParameterFilters sets the ParameterFilters field's value.

func (DescribeParametersInput) String added in v1.5.13

func (s DescribeParametersInput) String() string

String returns the string representation

func (*DescribeParametersInput) Validate added in v1.5.13

func (s *DescribeParametersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeParametersOutput added in v1.5.13

type DescribeParametersOutput 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 `type:"string"`

	// Parameters returned by the request.
	Parameters []*ParameterMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeParametersOutput) GoString added in v1.5.13

func (s DescribeParametersOutput) GoString() string

GoString returns the string representation

func (*DescribeParametersOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*DescribeParametersOutput) SetParameters added in v1.5.13

SetParameters sets the Parameters field's value.

func (DescribeParametersOutput) String added in v1.5.13

func (s DescribeParametersOutput) String() string

String returns the string representation

type DescribePatchBaselinesInput added in v1.6.4

type DescribePatchBaselinesInput struct {

	// Each element in the array is a structure containing:
	//
	// Key: (string, "NAME_PREFIX" or "OWNER")
	//
	// Value: (array of strings, exactly 1 entry, between 1 and 255 characters)
	Filters []*PatchOrchestratorFilter `type:"list"`

	// The maximum number of patch baselines to return (per page).
	MaxResults *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePatchBaselinesInput) GoString added in v1.6.4

func (s DescribePatchBaselinesInput) GoString() string

GoString returns the string representation

func (*DescribePatchBaselinesInput) SetFilters added in v1.6.4

SetFilters sets the Filters field's value.

func (*DescribePatchBaselinesInput) SetMaxResults added in v1.6.4

SetMaxResults sets the MaxResults field's value.

func (*DescribePatchBaselinesInput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribePatchBaselinesInput) String added in v1.6.4

String returns the string representation

func (*DescribePatchBaselinesInput) Validate added in v1.6.4

func (s *DescribePatchBaselinesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePatchBaselinesOutput added in v1.6.4

type DescribePatchBaselinesOutput struct {

	// An array of PatchBaselineIdentity elements.
	BaselineIdentities []*PatchBaselineIdentity `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePatchBaselinesOutput) GoString added in v1.6.4

func (s DescribePatchBaselinesOutput) GoString() string

GoString returns the string representation

func (*DescribePatchBaselinesOutput) SetBaselineIdentities added in v1.6.4

SetBaselineIdentities sets the BaselineIdentities field's value.

func (*DescribePatchBaselinesOutput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribePatchBaselinesOutput) String added in v1.6.4

String returns the string representation

type DescribePatchGroupStateInput added in v1.6.4

type DescribePatchGroupStateInput struct {

	// The name of the patch group whose patch snapshot should be retrieved.
	//
	// PatchGroup is a required field
	PatchGroup *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePatchGroupStateInput) GoString added in v1.6.4

func (s DescribePatchGroupStateInput) GoString() string

GoString returns the string representation

func (*DescribePatchGroupStateInput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (DescribePatchGroupStateInput) String added in v1.6.4

String returns the string representation

func (*DescribePatchGroupStateInput) Validate added in v1.6.4

func (s *DescribePatchGroupStateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePatchGroupStateOutput added in v1.6.4

type DescribePatchGroupStateOutput struct {

	// The number of instances in the patch group.
	Instances *int64 `type:"integer"`

	// The number of instances with patches from the patch baseline that failed
	// to install.
	InstancesWithFailedPatches *int64 `type:"integer"`

	// The number of instances with patches installed that aren't defined in the
	// patch baseline.
	InstancesWithInstalledOtherPatches *int64 `type:"integer"`

	// The number of instances with installed patches.
	InstancesWithInstalledPatches *int64 `type:"integer"`

	// The number of instances with patches installed that are specified in a RejectedPatches
	// list. Patches with a status of INSTALLED_REJECTED were typically installed
	// before they were added to a RejectedPatches list.
	//
	// If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction,
	// the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).
	InstancesWithInstalledRejectedPatches *int64 `type:"integer"`

	// The number of instances with missing patches from the patch baseline.
	InstancesWithMissingPatches *int64 `type:"integer"`

	// The number of instances with patches that aren't applicable.
	InstancesWithNotApplicablePatches *int64 `type:"integer"`

	// The number of instances with NotApplicable patches beyond the supported limit,
	// which are not reported by name to Systems Manager Inventory.
	InstancesWithUnreportedNotApplicablePatches *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribePatchGroupStateOutput) GoString added in v1.6.4

GoString returns the string representation

func (*DescribePatchGroupStateOutput) SetInstances added in v1.6.4

SetInstances sets the Instances field's value.

func (*DescribePatchGroupStateOutput) SetInstancesWithFailedPatches added in v1.6.4

func (s *DescribePatchGroupStateOutput) SetInstancesWithFailedPatches(v int64) *DescribePatchGroupStateOutput

SetInstancesWithFailedPatches sets the InstancesWithFailedPatches field's value.

func (*DescribePatchGroupStateOutput) SetInstancesWithInstalledOtherPatches added in v1.6.4

func (s *DescribePatchGroupStateOutput) SetInstancesWithInstalledOtherPatches(v int64) *DescribePatchGroupStateOutput

SetInstancesWithInstalledOtherPatches sets the InstancesWithInstalledOtherPatches field's value.

func (*DescribePatchGroupStateOutput) SetInstancesWithInstalledPatches added in v1.6.4

func (s *DescribePatchGroupStateOutput) SetInstancesWithInstalledPatches(v int64) *DescribePatchGroupStateOutput

SetInstancesWithInstalledPatches sets the InstancesWithInstalledPatches field's value.

func (*DescribePatchGroupStateOutput) SetInstancesWithInstalledRejectedPatches added in v1.99.0

func (s *DescribePatchGroupStateOutput) SetInstancesWithInstalledRejectedPatches(v int64) *DescribePatchGroupStateOutput

SetInstancesWithInstalledRejectedPatches sets the InstancesWithInstalledRejectedPatches field's value.

func (*DescribePatchGroupStateOutput) SetInstancesWithMissingPatches added in v1.6.4

func (s *DescribePatchGroupStateOutput) SetInstancesWithMissingPatches(v int64) *DescribePatchGroupStateOutput

SetInstancesWithMissingPatches sets the InstancesWithMissingPatches field's value.

func (*DescribePatchGroupStateOutput) SetInstancesWithNotApplicablePatches added in v1.6.4

func (s *DescribePatchGroupStateOutput) SetInstancesWithNotApplicablePatches(v int64) *DescribePatchGroupStateOutput

SetInstancesWithNotApplicablePatches sets the InstancesWithNotApplicablePatches field's value.

func (*DescribePatchGroupStateOutput) SetInstancesWithUnreportedNotApplicablePatches added in v1.99.0

func (s *DescribePatchGroupStateOutput) SetInstancesWithUnreportedNotApplicablePatches(v int64) *DescribePatchGroupStateOutput

SetInstancesWithUnreportedNotApplicablePatches sets the InstancesWithUnreportedNotApplicablePatches field's value.

func (DescribePatchGroupStateOutput) String added in v1.6.4

String returns the string representation

type DescribePatchGroupsInput added in v1.6.4

type DescribePatchGroupsInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*PatchOrchestratorFilter `type:"list"`

	// The maximum number of patch groups to return (per page).
	MaxResults *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePatchGroupsInput) GoString added in v1.6.4

func (s DescribePatchGroupsInput) GoString() string

GoString returns the string representation

func (*DescribePatchGroupsInput) SetFilters added in v1.10.8

SetFilters sets the Filters field's value.

func (*DescribePatchGroupsInput) SetMaxResults added in v1.6.4

SetMaxResults sets the MaxResults field's value.

func (*DescribePatchGroupsInput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribePatchGroupsInput) String added in v1.6.4

func (s DescribePatchGroupsInput) String() string

String returns the string representation

func (*DescribePatchGroupsInput) Validate added in v1.6.4

func (s *DescribePatchGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePatchGroupsOutput added in v1.6.4

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 []*PatchGroupPatchBaselineMapping `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePatchGroupsOutput) GoString added in v1.6.4

func (s DescribePatchGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribePatchGroupsOutput) SetMappings added in v1.6.4

SetMappings sets the Mappings field's value.

func (*DescribePatchGroupsOutput) SetNextToken added in v1.6.4

SetNextToken sets the NextToken field's value.

func (DescribePatchGroupsOutput) String added in v1.6.4

func (s DescribePatchGroupsOutput) String() string

String returns the string representation

type DescribePatchPropertiesInput added in v1.99.0

type DescribePatchPropertiesInput 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The operating system type for which to list patches.
	//
	// OperatingSystem is a required field
	OperatingSystem *string `type:"string" required:"true" enum:"OperatingSystem"`

	// Indicates whether to list patches for the Windows operating system or for
	// Microsoft applications. Not applicable for Linux operating systems.
	PatchSet *string `type:"string" enum:"PatchSet"`

	// The patch property for which you want to view patch details.
	//
	// Property is a required field
	Property *string `type:"string" required:"true" enum:"PatchProperty"`
	// contains filtered or unexported fields
}

func (DescribePatchPropertiesInput) GoString added in v1.99.0

func (s DescribePatchPropertiesInput) GoString() string

GoString returns the string representation

func (*DescribePatchPropertiesInput) SetMaxResults added in v1.99.0

SetMaxResults sets the MaxResults field's value.

func (*DescribePatchPropertiesInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribePatchPropertiesInput) SetOperatingSystem added in v1.99.0

SetOperatingSystem sets the OperatingSystem field's value.

func (*DescribePatchPropertiesInput) SetPatchSet added in v1.99.0

SetPatchSet sets the PatchSet field's value.

func (*DescribePatchPropertiesInput) SetProperty added in v1.99.0

SetProperty sets the Property field's value.

func (DescribePatchPropertiesInput) String added in v1.99.0

String returns the string representation

func (*DescribePatchPropertiesInput) Validate added in v1.99.0

func (s *DescribePatchPropertiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePatchPropertiesOutput added in v1.99.0

type DescribePatchPropertiesOutput struct {

	// The token for the next set of items to return. (You use this token in the
	// next call.)
	NextToken *string `type:"string"`

	// A list of the properties for patches matching the filter request parameters.
	Properties []map[string]*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribePatchPropertiesOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribePatchPropertiesOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribePatchPropertiesOutput) SetProperties added in v1.99.0

SetProperties sets the Properties field's value.

func (DescribePatchPropertiesOutput) String added in v1.99.0

String returns the string representation

type DescribeSessionsInput added in v1.99.0

type DescribeSessionsInput struct {

	// One or more filters to limit the type of sessions returned by the request.
	Filters []*SessionFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The session status to retrieve a list of sessions for. For example, "Active".
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"SessionState"`
	// contains filtered or unexported fields
}

func (DescribeSessionsInput) GoString added in v1.99.0

func (s DescribeSessionsInput) GoString() string

GoString returns the string representation

func (*DescribeSessionsInput) SetFilters added in v1.99.0

SetFilters sets the Filters field's value.

func (*DescribeSessionsInput) SetMaxResults added in v1.99.0

func (s *DescribeSessionsInput) SetMaxResults(v int64) *DescribeSessionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeSessionsInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeSessionsInput) SetState added in v1.99.0

SetState sets the State field's value.

func (DescribeSessionsInput) String added in v1.99.0

func (s DescribeSessionsInput) String() string

String returns the string representation

func (*DescribeSessionsInput) Validate added in v1.99.0

func (s *DescribeSessionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSessionsOutput added in v1.99.0

type DescribeSessionsOutput struct {

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// A list of sessions meeting the request parameters.
	Sessions []*Session `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSessionsOutput) GoString added in v1.99.0

func (s DescribeSessionsOutput) GoString() string

GoString returns the string representation

func (*DescribeSessionsOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (*DescribeSessionsOutput) SetSessions added in v1.99.0

SetSessions sets the Sessions field's value.

func (DescribeSessionsOutput) String added in v1.99.0

func (s DescribeSessionsOutput) String() string

String returns the string representation

type DocumentDefaultVersionDescription added in v1.5.13

type DocumentDefaultVersionDescription struct {

	// The default version of the document.
	DefaultVersion *string `type:"string"`

	// The default version of the artifact associated with the document.
	DefaultVersionName *string `type:"string"`

	// The name of the document.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A default version of a document.

func (DocumentDefaultVersionDescription) GoString added in v1.5.13

GoString returns the string representation

func (*DocumentDefaultVersionDescription) SetDefaultVersion added in v1.5.13

SetDefaultVersion sets the DefaultVersion field's value.

func (*DocumentDefaultVersionDescription) SetDefaultVersionName added in v1.99.0

SetDefaultVersionName sets the DefaultVersionName field's value.

func (*DocumentDefaultVersionDescription) SetName added in v1.5.13

SetName sets the Name field's value.

func (DocumentDefaultVersionDescription) String added in v1.5.13

String returns the string representation

type DocumentDescription

type DocumentDescription struct {

	// Details about the document attachments, including names, locations, sizes,
	// etc.
	AttachmentsInformation []*AttachmentInformation `type:"list"`

	// The date when the document was created.
	CreatedDate *time.Time `type:"timestamp"`

	// The default version.
	DefaultVersion *string `type:"string"`

	// A description of the document.
	Description *string `type:"string"`

	// The document format, either JSON or YAML.
	DocumentFormat *string `type:"string" enum:"DocumentFormat"`

	// The type of document.
	DocumentType *string `type:"string" enum:"DocumentType"`

	// The document version.
	DocumentVersion *string `type:"string"`

	// The Sha256 or Sha1 hash created by the system when the document was created.
	//
	// Sha1 hashes have been deprecated.
	Hash *string `type:"string"`

	// The hash type of the document. Valid values include Sha256 or Sha1.
	//
	// Sha1 hashes have been deprecated.
	HashType *string `type:"string" enum:"DocumentHashType"`

	// The latest version of the document.
	LatestVersion *string `type:"string"`

	// The name of the Systems Manager document.
	Name *string `type:"string"`

	// The AWS user account that created the document.
	Owner *string `type:"string"`

	// A description of the parameters for a document.
	Parameters []*DocumentParameter `type:"list"`

	// The list of OS platforms compatible with this Systems Manager document.
	PlatformTypes []*string `type:"list"`

	// The schema version.
	SchemaVersion *string `type:"string"`

	// The SHA1 hash of the document, which you can use for verification.
	Sha1 *string `type:"string"`

	// The status of the Systems Manager document.
	Status *string `type:"string" enum:"DocumentStatus"`

	// A message returned by AWS Systems Manager that explains the Status value.
	// For example, a Failed status might be explained by the StatusInformation
	// message, "The specified S3 bucket does not exist. Verify that the URL of
	// the S3 bucket is correct."
	StatusInformation *string `type:"string"`

	// The tags, or metadata, that have been applied to the document.
	Tags []*Tag `type:"list"`

	// The target type which defines the kinds of resources the document can run
	// on. For example, /AWS::EC2::Instance. For a list of valid resource types,
	// see AWS Resource Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.
	TargetType *string `type:"string"`

	// The version of the artifact associated with the document.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a Systems Manager document.

func (DocumentDescription) GoString added in v0.6.5

func (s DocumentDescription) GoString() string

GoString returns the string representation

func (*DocumentDescription) SetAttachmentsInformation added in v1.99.0

func (s *DocumentDescription) SetAttachmentsInformation(v []*AttachmentInformation) *DocumentDescription

SetAttachmentsInformation sets the AttachmentsInformation field's value.

func (*DocumentDescription) SetCreatedDate added in v1.5.0

func (s *DocumentDescription) SetCreatedDate(v time.Time) *DocumentDescription

SetCreatedDate sets the CreatedDate field's value.

func (*DocumentDescription) SetDefaultVersion added in v1.5.13

func (s *DocumentDescription) SetDefaultVersion(v string) *DocumentDescription

SetDefaultVersion sets the DefaultVersion field's value.

func (*DocumentDescription) SetDescription added in v1.5.0

func (s *DocumentDescription) SetDescription(v string) *DocumentDescription

SetDescription sets the Description field's value.

func (*DocumentDescription) SetDocumentFormat added in v1.12.37

func (s *DocumentDescription) SetDocumentFormat(v string) *DocumentDescription

SetDocumentFormat sets the DocumentFormat field's value.

func (*DocumentDescription) SetDocumentType added in v1.5.13

func (s *DocumentDescription) SetDocumentType(v string) *DocumentDescription

SetDocumentType sets the DocumentType field's value.

func (*DocumentDescription) SetDocumentVersion added in v1.5.13

func (s *DocumentDescription) SetDocumentVersion(v string) *DocumentDescription

SetDocumentVersion sets the DocumentVersion field's value.

func (*DocumentDescription) SetHash added in v1.5.0

SetHash sets the Hash field's value.

func (*DocumentDescription) SetHashType added in v1.5.0

func (s *DocumentDescription) SetHashType(v string) *DocumentDescription

SetHashType sets the HashType field's value.

func (*DocumentDescription) SetLatestVersion added in v1.5.13

func (s *DocumentDescription) SetLatestVersion(v string) *DocumentDescription

SetLatestVersion sets the LatestVersion field's value.

func (*DocumentDescription) SetName added in v1.5.0

SetName sets the Name field's value.

func (*DocumentDescription) SetOwner added in v1.5.0

SetOwner sets the Owner field's value.

func (*DocumentDescription) SetParameters added in v1.5.0

SetParameters sets the Parameters field's value.

func (*DocumentDescription) SetPlatformTypes added in v1.5.0

func (s *DocumentDescription) SetPlatformTypes(v []*string) *DocumentDescription

SetPlatformTypes sets the PlatformTypes field's value.

func (*DocumentDescription) SetSchemaVersion added in v1.5.13

func (s *DocumentDescription) SetSchemaVersion(v string) *DocumentDescription

SetSchemaVersion sets the SchemaVersion field's value.

func (*DocumentDescription) SetSha1 added in v1.5.0

SetSha1 sets the Sha1 field's value.

func (*DocumentDescription) SetStatus added in v1.5.0

SetStatus sets the Status field's value.

func (*DocumentDescription) SetStatusInformation added in v1.99.0

func (s *DocumentDescription) SetStatusInformation(v string) *DocumentDescription

SetStatusInformation sets the StatusInformation field's value.

func (*DocumentDescription) SetTags added in v1.12.4

func (s *DocumentDescription) SetTags(v []*Tag) *DocumentDescription

SetTags sets the Tags field's value.

func (*DocumentDescription) SetTargetType added in v1.12.37

func (s *DocumentDescription) SetTargetType(v string) *DocumentDescription

SetTargetType sets the TargetType field's value.

func (*DocumentDescription) SetVersionName added in v1.99.0

func (s *DocumentDescription) SetVersionName(v string) *DocumentDescription

SetVersionName sets the VersionName field's value.

func (DocumentDescription) String added in v0.6.5

func (s DocumentDescription) String() string

String returns the string representation

type DocumentFilter

type DocumentFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true" enum:"DocumentFilterKey"`

	// The value of the filter.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a filter.

func (DocumentFilter) GoString added in v0.6.5

func (s DocumentFilter) GoString() string

GoString returns the string representation

func (*DocumentFilter) SetKey added in v1.5.0

func (s *DocumentFilter) SetKey(v string) *DocumentFilter

SetKey sets the Key field's value.

func (*DocumentFilter) SetValue added in v1.5.0

func (s *DocumentFilter) SetValue(v string) *DocumentFilter

SetValue sets the Value field's value.

func (DocumentFilter) String added in v0.6.5

func (s DocumentFilter) String() string

String returns the string representation

func (*DocumentFilter) Validate added in v1.1.21

func (s *DocumentFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentIdentifier

type DocumentIdentifier struct {

	// The document format, either JSON or YAML.
	DocumentFormat *string `type:"string" enum:"DocumentFormat"`

	// The document type.
	DocumentType *string `type:"string" enum:"DocumentType"`

	// The document version.
	DocumentVersion *string `type:"string"`

	// The name of the Systems Manager document.
	Name *string `type:"string"`

	// The AWS user account that created the document.
	Owner *string `type:"string"`

	// The operating system platform.
	PlatformTypes []*string `type:"list"`

	// The schema version.
	SchemaVersion *string `type:"string"`

	// The tags, or metadata, that have been applied to the document.
	Tags []*Tag `type:"list"`

	// The target type which defines the kinds of resources the document can run
	// on. For example, /AWS::EC2::Instance. For a list of valid resource types,
	// see AWS Resource Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.
	TargetType *string `type:"string"`

	// An optional field specifying the version of the artifact associated with
	// the document. For example, "Release 12, Update 6". This value is unique across
	// all versions of a document, and cannot be changed.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the name of a Systems Manager document.

func (DocumentIdentifier) GoString added in v0.6.5

func (s DocumentIdentifier) GoString() string

GoString returns the string representation

func (*DocumentIdentifier) SetDocumentFormat added in v1.12.37

func (s *DocumentIdentifier) SetDocumentFormat(v string) *DocumentIdentifier

SetDocumentFormat sets the DocumentFormat field's value.

func (*DocumentIdentifier) SetDocumentType added in v1.5.13

func (s *DocumentIdentifier) SetDocumentType(v string) *DocumentIdentifier

SetDocumentType sets the DocumentType field's value.

func (*DocumentIdentifier) SetDocumentVersion added in v1.5.13

func (s *DocumentIdentifier) SetDocumentVersion(v string) *DocumentIdentifier

SetDocumentVersion sets the DocumentVersion field's value.

func (*DocumentIdentifier) SetName added in v1.5.0

SetName sets the Name field's value.

func (*DocumentIdentifier) SetOwner added in v1.5.0

SetOwner sets the Owner field's value.

func (*DocumentIdentifier) SetPlatformTypes added in v1.5.0

func (s *DocumentIdentifier) SetPlatformTypes(v []*string) *DocumentIdentifier

SetPlatformTypes sets the PlatformTypes field's value.

func (*DocumentIdentifier) SetSchemaVersion added in v1.5.13

func (s *DocumentIdentifier) SetSchemaVersion(v string) *DocumentIdentifier

SetSchemaVersion sets the SchemaVersion field's value.

func (*DocumentIdentifier) SetTags added in v1.12.4

func (s *DocumentIdentifier) SetTags(v []*Tag) *DocumentIdentifier

SetTags sets the Tags field's value.

func (*DocumentIdentifier) SetTargetType added in v1.12.37

func (s *DocumentIdentifier) SetTargetType(v string) *DocumentIdentifier

SetTargetType sets the TargetType field's value.

func (*DocumentIdentifier) SetVersionName added in v1.99.0

func (s *DocumentIdentifier) SetVersionName(v string) *DocumentIdentifier

SetVersionName sets the VersionName field's value.

func (DocumentIdentifier) String added in v0.6.5

func (s DocumentIdentifier) String() string

String returns the string representation

type DocumentKeyValuesFilter added in v1.12.4

type DocumentKeyValuesFilter struct {

	// The name of the filter key.
	Key *string `min:"1" type:"string"`

	// The value for the filter key.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

One or more filters. Use a filter to return a more specific list of documents.

For keys, you can specify one or more tags that have been applied to a document.

Other valid values include Owner, Name, PlatformTypes, and DocumentType.

Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.

If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the AWS CLI, to return a list of all documents that begin with Te, run the following command:

aws ssm list-documents --filters Key=Name,Values=Te

If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.

To specify a custom key and value pair, use the format Key=tag:[tagName],Values=[valueName].

For example, if you created a Key called region and are using the AWS CLI to call the list-documents command:

aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self

func (DocumentKeyValuesFilter) GoString added in v1.12.4

func (s DocumentKeyValuesFilter) GoString() string

GoString returns the string representation

func (*DocumentKeyValuesFilter) SetKey added in v1.12.4

SetKey sets the Key field's value.

func (*DocumentKeyValuesFilter) SetValues added in v1.12.4

SetValues sets the Values field's value.

func (DocumentKeyValuesFilter) String added in v1.12.4

func (s DocumentKeyValuesFilter) String() string

String returns the string representation

func (*DocumentKeyValuesFilter) Validate added in v1.12.4

func (s *DocumentKeyValuesFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentParameter added in v0.9.17

type DocumentParameter struct {

	// If specified, the default values for the parameters. Parameters without a
	// default value are required. Parameters with a default value are optional.
	DefaultValue *string `type:"string"`

	// A description of what the parameter does, how to use it, the default value,
	// and whether or not the parameter is optional.
	Description *string `type:"string"`

	// The name of the parameter.
	Name *string `type:"string"`

	// The type of parameter. The type can be either String or StringList.
	Type *string `type:"string" enum:"DocumentParameterType"`
	// contains filtered or unexported fields
}

Parameters specified in a System Manager document that run on the server when the command is run.

func (DocumentParameter) GoString added in v0.9.17

func (s DocumentParameter) GoString() string

GoString returns the string representation

func (*DocumentParameter) SetDefaultValue added in v1.5.0

func (s *DocumentParameter) SetDefaultValue(v string) *DocumentParameter

SetDefaultValue sets the DefaultValue field's value.

func (*DocumentParameter) SetDescription added in v1.5.0

func (s *DocumentParameter) SetDescription(v string) *DocumentParameter

SetDescription sets the Description field's value.

func (*DocumentParameter) SetName added in v1.5.0

SetName sets the Name field's value.

func (*DocumentParameter) SetType added in v1.5.0

SetType sets the Type field's value.

func (DocumentParameter) String added in v0.9.17

func (s DocumentParameter) String() string

String returns the string representation

type DocumentVersionInfo added in v1.5.13

type DocumentVersionInfo struct {

	// The date the document was created.
	CreatedDate *time.Time `type:"timestamp"`

	// The document format, either JSON or YAML.
	DocumentFormat *string `type:"string" enum:"DocumentFormat"`

	// The document version.
	DocumentVersion *string `type:"string"`

	// An identifier for the default version of the document.
	IsDefaultVersion *bool `type:"boolean"`

	// The document name.
	Name *string `type:"string"`

	// The status of the Systems Manager document, such as Creating, Active, Failed,
	// and Deleting.
	Status *string `type:"string" enum:"DocumentStatus"`

	// A message returned by AWS Systems Manager that explains the Status value.
	// For example, a Failed status might be explained by the StatusInformation
	// message, "The specified S3 bucket does not exist. Verify that the URL of
	// the S3 bucket is correct."
	StatusInformation *string `type:"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
	// cannot be changed.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

Version information about the document.

func (DocumentVersionInfo) GoString added in v1.5.13

func (s DocumentVersionInfo) GoString() string

GoString returns the string representation

func (*DocumentVersionInfo) SetCreatedDate added in v1.5.13

func (s *DocumentVersionInfo) SetCreatedDate(v time.Time) *DocumentVersionInfo

SetCreatedDate sets the CreatedDate field's value.

func (*DocumentVersionInfo) SetDocumentFormat added in v1.12.37

func (s *DocumentVersionInfo) SetDocumentFormat(v string) *DocumentVersionInfo

SetDocumentFormat sets the DocumentFormat field's value.

func (*DocumentVersionInfo) SetDocumentVersion added in v1.5.13

func (s *DocumentVersionInfo) SetDocumentVersion(v string) *DocumentVersionInfo

SetDocumentVersion sets the DocumentVersion field's value.

func (*DocumentVersionInfo) SetIsDefaultVersion added in v1.5.13

func (s *DocumentVersionInfo) SetIsDefaultVersion(v bool) *DocumentVersionInfo

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*DocumentVersionInfo) SetName added in v1.5.13

SetName sets the Name field's value.

func (*DocumentVersionInfo) SetStatus added in v1.99.0

SetStatus sets the Status field's value.

func (*DocumentVersionInfo) SetStatusInformation added in v1.99.0

func (s *DocumentVersionInfo) SetStatusInformation(v string) *DocumentVersionInfo

SetStatusInformation sets the StatusInformation field's value.

func (*DocumentVersionInfo) SetVersionName added in v1.99.0

func (s *DocumentVersionInfo) SetVersionName(v string) *DocumentVersionInfo

SetVersionName sets the VersionName field's value.

func (DocumentVersionInfo) String added in v1.5.13

func (s DocumentVersionInfo) String() string

String returns the string representation

type EffectivePatch added in v1.6.4

type EffectivePatch struct {

	// Provides metadata for a patch, including information such as the KB ID, severity,
	// classification and a URL for where more information can be obtained about
	// the patch.
	Patch *Patch `type:"structure"`

	// The status of the patch in a patch baseline. This includes information about
	// whether the patch is currently approved, due to be approved by a rule, explicitly
	// approved, or explicitly rejected and the date the patch was or will be approved.
	PatchStatus *PatchStatus `type:"structure"`
	// contains filtered or unexported fields
}

The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

func (EffectivePatch) GoString added in v1.6.4

func (s EffectivePatch) GoString() string

GoString returns the string representation

func (*EffectivePatch) SetPatch added in v1.6.4

func (s *EffectivePatch) SetPatch(v *Patch) *EffectivePatch

SetPatch sets the Patch field's value.

func (*EffectivePatch) SetPatchStatus added in v1.6.4

func (s *EffectivePatch) SetPatchStatus(v *PatchStatus) *EffectivePatch

SetPatchStatus sets the PatchStatus field's value.

func (EffectivePatch) String added in v1.6.4

func (s EffectivePatch) String() string

String returns the string representation

type FailedCreateAssociation

type FailedCreateAssociation struct {

	// The association.
	Entry *CreateAssociationBatchRequestEntry `type:"structure"`

	// The source of the failure.
	Fault *string `type:"string" enum:"Fault"`

	// A description of the failure.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

Describes a failed association.

func (FailedCreateAssociation) GoString added in v0.6.5

func (s FailedCreateAssociation) GoString() string

GoString returns the string representation

func (*FailedCreateAssociation) SetEntry added in v1.5.0

SetEntry sets the Entry field's value.

func (*FailedCreateAssociation) SetFault added in v1.5.0

SetFault sets the Fault field's value.

func (*FailedCreateAssociation) SetMessage added in v1.5.0

SetMessage sets the Message field's value.

func (FailedCreateAssociation) String added in v0.6.5

func (s FailedCreateAssociation) String() string

String returns the string representation

type FailureDetails added in v1.8.23

type FailureDetails struct {

	// Detailed information about the Automation step failure.
	Details map[string][]*string `min:"1" type:"map"`

	// The stage of the Automation execution when the failure occurred. The stages
	// include the following: InputValidation, PreVerification, Invocation, PostVerification.
	FailureStage *string `type:"string"`

	// The type of Automation failure. Failure types include the following: Action,
	// Permission, Throttling, Verification, Internal.
	FailureType *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Automation failure.

func (FailureDetails) GoString added in v1.8.23

func (s FailureDetails) GoString() string

GoString returns the string representation

func (*FailureDetails) SetDetails added in v1.8.23

func (s *FailureDetails) SetDetails(v map[string][]*string) *FailureDetails

SetDetails sets the Details field's value.

func (*FailureDetails) SetFailureStage added in v1.8.23

func (s *FailureDetails) SetFailureStage(v string) *FailureDetails

SetFailureStage sets the FailureStage field's value.

func (*FailureDetails) SetFailureType added in v1.8.23

func (s *FailureDetails) SetFailureType(v string) *FailureDetails

SetFailureType sets the FailureType field's value.

func (FailureDetails) String added in v1.8.23

func (s FailureDetails) String() string

String returns the string representation

type GetAutomationExecutionInput added in v1.5.13

type GetAutomationExecutionInput struct {

	// The unique identifier for an existing automation execution to examine. The
	// execution ID is returned by StartAutomationExecution when the execution of
	// an Automation document is initiated.
	//
	// AutomationExecutionId is a required field
	AutomationExecutionId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAutomationExecutionInput) GoString added in v1.5.13

func (s GetAutomationExecutionInput) GoString() string

GoString returns the string representation

func (*GetAutomationExecutionInput) SetAutomationExecutionId added in v1.5.13

func (s *GetAutomationExecutionInput) SetAutomationExecutionId(v string) *GetAutomationExecutionInput

SetAutomationExecutionId sets the AutomationExecutionId field's value.

func (GetAutomationExecutionInput) String added in v1.5.13

String returns the string representation

func (*GetAutomationExecutionInput) Validate added in v1.5.13

func (s *GetAutomationExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAutomationExecutionOutput added in v1.5.13

type GetAutomationExecutionOutput struct {

	// Detailed information about the current state of an automation execution.
	AutomationExecution *AutomationExecution `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAutomationExecutionOutput) GoString added in v1.5.13

func (s GetAutomationExecutionOutput) GoString() string

GoString returns the string representation

func (*GetAutomationExecutionOutput) SetAutomationExecution added in v1.5.13

SetAutomationExecution sets the AutomationExecution field's value.

func (GetAutomationExecutionOutput) String added in v1.5.13

String returns the string representation

type GetCommandInvocationInput added in v1.5.13

type GetCommandInvocationInput struct {

	// (Required) The parent command ID of the invocation plugin.
	//
	// CommandId is a required field
	CommandId *string `min:"36" type:"string" required:"true"`

	// (Required) The ID of the managed instance targeted by the command. A managed
	// instance can be an Amazon EC2 instance or an instance in your hybrid environment
	// that is configured for Systems Manager.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// (Optional) The name of the plugin for which you want detailed results. If
	// the document contains only one plugin, the name can be omitted and the details
	// will be returned.
	PluginName *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (GetCommandInvocationInput) GoString added in v1.5.13

func (s GetCommandInvocationInput) GoString() string

GoString returns the string representation

func (*GetCommandInvocationInput) SetCommandId added in v1.5.13

SetCommandId sets the CommandId field's value.

func (*GetCommandInvocationInput) SetInstanceId added in v1.5.13

SetInstanceId sets the InstanceId field's value.

func (*GetCommandInvocationInput) SetPluginName added in v1.5.13

SetPluginName sets the PluginName field's value.

func (GetCommandInvocationInput) String added in v1.5.13

func (s GetCommandInvocationInput) String() string

String returns the string representation

func (*GetCommandInvocationInput) Validate added in v1.5.13

func (s *GetCommandInvocationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCommandInvocationOutput added in v1.5.13

type GetCommandInvocationOutput struct {

	// CloudWatch Logs information where Systems Manager sent the command output.
	CloudWatchOutputConfig *CloudWatchOutputConfig `type:"structure"`

	// The parent command ID of the invocation plugin.
	CommandId *string `min:"36" type:"string"`

	// The comment text for the command.
	Comment *string `type:"string"`

	// The name of the document that was run. For example, AWS-RunShellScript.
	DocumentName *string `type:"string"`

	// The SSM document version used in the request.
	DocumentVersion *string `type:"string"`

	// Duration since ExecutionStartDateTime.
	ExecutionElapsedTime *string `type:"string"`

	// The date and time the plugin was finished running. Date and time are written
	// in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7.
	// The following sample AWS CLI command uses the InvokedAfter filter.
	//
	// aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z
	//
	// If the plugin has not started to run, the string is empty.
	ExecutionEndDateTime *string `type:"string"`

	// The date and time the plugin started running. Date and time are written in
	// ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The
	// following sample AWS CLI command uses the InvokedBefore filter.
	//
	// aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z
	//
	// If the plugin has not started to run, the string is empty.
	ExecutionStartDateTime *string `type:"string"`

	// The ID of the managed instance targeted by the command. A managed instance
	// can be an Amazon EC2 instance or an instance in your hybrid environment that
	// is configured for Systems Manager.
	InstanceId *string `type:"string"`

	// The name of the plugin for which you want detailed results. For example,
	// aws:RunShellScript is a plugin.
	PluginName *string `min:"4" type:"string"`

	// The error level response code for the plugin script. If the response code
	// is -1, then the command has not started running on the instance, or it was
	// not received by the instance.
	ResponseCode *int64 `type:"integer"`

	// The first 8,000 characters written by the plugin to stderr. If the command
	// has not finished running, then this string is empty.
	StandardErrorContent *string `type:"string"`

	// The URL for the complete text written by the plugin to stderr. If the command
	// has not finished running, then this string is empty.
	StandardErrorUrl *string `type:"string"`

	// The first 24,000 characters written by the plugin to stdout. If the command
	// has not finished running, if ExecutionStatus is neither Succeeded nor Failed,
	// then this string is empty.
	StandardOutputContent *string `type:"string"`

	// The URL for the complete text written by the plugin to stdout in Amazon S3.
	// If an Amazon S3 bucket was not specified, then this string is empty.
	StandardOutputUrl *string `type:"string"`

	// The status of this invocation plugin. This status can be different than StatusDetails.
	Status *string `type:"string" enum:"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 (http://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html)
	// in the AWS Systems Manager User Guide. StatusDetails can be one of the following
	// values:
	//
	//    * Pending: The command has not been sent to the instance.
	//
	//    * In Progress: The command has been sent to the instance but has not reached
	//    a terminal state.
	//
	//    * Delayed: The system attempted to send the command to the target, but
	//    the target was not available. The instance might not be available because
	//    of network issues, the instance was stopped, etc. The system will try
	//    to deliver the command again.
	//
	//    * Success: The command or plugin was run successfully. This is a terminal
	//    state.
	//
	//    * Delivery Timed Out: The command was not delivered to the instance before
	//    the delivery timeout expired. Delivery timeouts do not count against the
	//    parent command's MaxErrors limit, but they do contribute to whether the
	//    parent command status is Success or Incomplete. This is a terminal state.
	//
	//    * Execution Timed Out: The command started to run on the instance, but
	//    the execution was not complete before the timeout expired. Execution timeouts
	//    count against the MaxErrors limit of the parent command. This is a terminal
	//    state.
	//
	//    * Failed: The command wasn't run successfully on the instance. For a plugin,
	//    this indicates that the result code was not zero. For a command invocation,
	//    this indicates that the result code for one or more plugins was not zero.
	//    Invocation failures count against the MaxErrors limit of the parent command.
	//    This is a terminal state.
	//
	//    * Canceled: The command was terminated before it was completed. This is
	//    a terminal state.
	//
	//    * Undeliverable: The command can't be delivered to the instance. The instance
	//    might not exist or might not be responding. Undeliverable invocations
	//    don't count against the parent command's MaxErrors limit and don't contribute
	//    to whether the parent command status is Success or Incomplete. This is
	//    a terminal state.
	//
	//    * Terminated: The parent command exceeded its MaxErrors limit and subsequent
	//    command invocations were canceled by the system. This is a terminal state.
	StatusDetails *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCommandInvocationOutput) GoString added in v1.5.13

func (s GetCommandInvocationOutput) GoString() string

GoString returns the string representation

func (*GetCommandInvocationOutput) SetCloudWatchOutputConfig added in v1.14.6

SetCloudWatchOutputConfig sets the CloudWatchOutputConfig field's value.

func (*GetCommandInvocationOutput) SetCommandId added in v1.5.13

SetCommandId sets the CommandId field's value.

func (*GetCommandInvocationOutput) SetComment added in v1.5.13

SetComment sets the Comment field's value.

func (*GetCommandInvocationOutput) SetDocumentName added in v1.5.13

SetDocumentName sets the DocumentName field's value.

func (*GetCommandInvocationOutput) SetDocumentVersion added in v1.13.40

SetDocumentVersion sets the DocumentVersion field's value.

func (*GetCommandInvocationOutput) SetExecutionElapsedTime added in v1.5.13

func (s *GetCommandInvocationOutput) SetExecutionElapsedTime(v string) *GetCommandInvocationOutput

SetExecutionElapsedTime sets the ExecutionElapsedTime field's value.

func (*GetCommandInvocationOutput) SetExecutionEndDateTime added in v1.5.13

func (s *GetCommandInvocationOutput) SetExecutionEndDateTime(v string) *GetCommandInvocationOutput

SetExecutionEndDateTime sets the ExecutionEndDateTime field's value.

func (*GetCommandInvocationOutput) SetExecutionStartDateTime added in v1.5.13

func (s *GetCommandInvocationOutput) SetExecutionStartDateTime(v string) *GetCommandInvocationOutput

SetExecutionStartDateTime sets the ExecutionStartDateTime field's value.

func (*GetCommandInvocationOutput) SetInstanceId added in v1.5.13

SetInstanceId sets the InstanceId field's value.

func (*GetCommandInvocationOutput) SetPluginName added in v1.5.13

SetPluginName sets the PluginName field's value.

func (*GetCommandInvocationOutput) SetResponseCode added in v1.5.13

SetResponseCode sets the ResponseCode field's value.

func (*GetCommandInvocationOutput) SetStandardErrorContent added in v1.5.13

func (s *GetCommandInvocationOutput) SetStandardErrorContent(v string) *GetCommandInvocationOutput

SetStandardErrorContent sets the StandardErrorContent field's value.

func (*GetCommandInvocationOutput) SetStandardErrorUrl added in v1.5.13

SetStandardErrorUrl sets the StandardErrorUrl field's value.

func (*GetCommandInvocationOutput) SetStandardOutputContent added in v1.5.13

func (s *GetCommandInvocationOutput) SetStandardOutputContent(v string) *GetCommandInvocationOutput

SetStandardOutputContent sets the StandardOutputContent field's value.

func (*GetCommandInvocationOutput) SetStandardOutputUrl added in v1.5.13

func (s *GetCommandInvocationOutput) SetStandardOutputUrl(v string) *GetCommandInvocationOutput

SetStandardOutputUrl sets the StandardOutputUrl field's value.

func (*GetCommandInvocationOutput) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (*GetCommandInvocationOutput) SetStatusDetails added in v1.5.13

SetStatusDetails sets the StatusDetails field's value.

func (GetCommandInvocationOutput) String added in v1.5.13

String returns the string representation

type GetConnectionStatusInput added in v1.99.0

type GetConnectionStatusInput struct {

	// The ID of the instance.
	//
	// Target is a required field
	Target *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetConnectionStatusInput) GoString added in v1.99.0

func (s GetConnectionStatusInput) GoString() string

GoString returns the string representation

func (*GetConnectionStatusInput) SetTarget added in v1.99.0

SetTarget sets the Target field's value.

func (GetConnectionStatusInput) String added in v1.99.0

func (s GetConnectionStatusInput) String() string

String returns the string representation

func (*GetConnectionStatusInput) Validate added in v1.99.0

func (s *GetConnectionStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConnectionStatusOutput added in v1.99.0

type GetConnectionStatusOutput struct {

	// The status of the connection to the instance. For example, 'Connected' or
	// 'Not Connected'.
	Status *string `type:"string" enum:"ConnectionStatus"`

	// The ID of the instance to check connection status.
	Target *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetConnectionStatusOutput) GoString added in v1.99.0

func (s GetConnectionStatusOutput) GoString() string

GoString returns the string representation

func (*GetConnectionStatusOutput) SetStatus added in v1.99.0

SetStatus sets the Status field's value.

func (*GetConnectionStatusOutput) SetTarget added in v1.99.0

SetTarget sets the Target field's value.

func (GetConnectionStatusOutput) String added in v1.99.0

func (s GetConnectionStatusOutput) String() string

String returns the string representation

type GetDefaultPatchBaselineInput added in v1.6.4

type GetDefaultPatchBaselineInput struct {

	// Returns the default patch baseline for the specified operating system.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`
	// contains filtered or unexported fields
}

func (GetDefaultPatchBaselineInput) GoString added in v1.6.4

func (s GetDefaultPatchBaselineInput) GoString() string

GoString returns the string representation

func (*GetDefaultPatchBaselineInput) SetOperatingSystem added in v1.10.8

SetOperatingSystem sets the OperatingSystem field's value.

func (GetDefaultPatchBaselineInput) String added in v1.6.4

String returns the string representation

type GetDefaultPatchBaselineOutput added in v1.6.4

type GetDefaultPatchBaselineOutput struct {

	// The ID of the default patch baseline.
	BaselineId *string `min:"20" type:"string"`

	// The operating system for the returned patch baseline.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`
	// contains filtered or unexported fields
}

func (GetDefaultPatchBaselineOutput) GoString added in v1.6.4

GoString returns the string representation

func (*GetDefaultPatchBaselineOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*GetDefaultPatchBaselineOutput) SetOperatingSystem added in v1.10.8

SetOperatingSystem sets the OperatingSystem field's value.

func (GetDefaultPatchBaselineOutput) String added in v1.6.4

String returns the string representation

type GetDeployablePatchSnapshotForInstanceInput added in v1.6.4

type GetDeployablePatchSnapshotForInstanceInput struct {

	// The ID of the instance for which the appropriate patch snapshot should be
	// retrieved.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The user-defined snapshot ID.
	//
	// SnapshotId is a required field
	SnapshotId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeployablePatchSnapshotForInstanceInput) GoString added in v1.6.4

GoString returns the string representation

func (*GetDeployablePatchSnapshotForInstanceInput) SetInstanceId added in v1.6.4

SetInstanceId sets the InstanceId field's value.

func (*GetDeployablePatchSnapshotForInstanceInput) SetSnapshotId added in v1.6.4

SetSnapshotId sets the SnapshotId field's value.

func (GetDeployablePatchSnapshotForInstanceInput) String added in v1.6.4

String returns the string representation

func (*GetDeployablePatchSnapshotForInstanceInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type GetDeployablePatchSnapshotForInstanceOutput added in v1.6.4

type GetDeployablePatchSnapshotForInstanceOutput struct {

	// The ID of the instance.
	InstanceId *string `type:"string"`

	// Returns the specific operating system (for example Windows Server 2012 or
	// Amazon Linux 2015.09) on the instance for the specified patch snapshot.
	Product *string `type:"string"`

	// A pre-signed Amazon S3 URL that can be used to download the patch snapshot.
	SnapshotDownloadUrl *string `type:"string"`

	// The user-defined snapshot ID.
	SnapshotId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (GetDeployablePatchSnapshotForInstanceOutput) GoString added in v1.6.4

GoString returns the string representation

func (*GetDeployablePatchSnapshotForInstanceOutput) SetInstanceId added in v1.6.4

SetInstanceId sets the InstanceId field's value.

func (*GetDeployablePatchSnapshotForInstanceOutput) SetProduct added in v1.10.8

SetProduct sets the Product field's value.

func (*GetDeployablePatchSnapshotForInstanceOutput) SetSnapshotDownloadUrl added in v1.6.4

SetSnapshotDownloadUrl sets the SnapshotDownloadUrl field's value.

func (*GetDeployablePatchSnapshotForInstanceOutput) SetSnapshotId added in v1.6.4

SetSnapshotId sets the SnapshotId field's value.

func (GetDeployablePatchSnapshotForInstanceOutput) String added in v1.6.4

String returns the string representation

type GetDocumentInput

type GetDocumentInput struct {

	// Returns the document in the specified format. The document format can be
	// either JSON or YAML. JSON is the default format.
	DocumentFormat *string `type:"string" enum:"DocumentFormat"`

	// The document version for which you want information.
	DocumentVersion *string `type:"string"`

	// The name of the Systems Manager document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// An optional field specifying the version of the artifact associated with
	// the document. For example, "Release 12, Update 6". This value is unique across
	// all versions of a document, and cannot be changed.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDocumentInput) GoString added in v0.6.5

func (s GetDocumentInput) GoString() string

GoString returns the string representation

func (*GetDocumentInput) SetDocumentFormat added in v1.12.37

func (s *GetDocumentInput) SetDocumentFormat(v string) *GetDocumentInput

SetDocumentFormat sets the DocumentFormat field's value.

func (*GetDocumentInput) SetDocumentVersion added in v1.5.13

func (s *GetDocumentInput) SetDocumentVersion(v string) *GetDocumentInput

SetDocumentVersion sets the DocumentVersion field's value.

func (*GetDocumentInput) SetName added in v1.5.0

func (s *GetDocumentInput) SetName(v string) *GetDocumentInput

SetName sets the Name field's value.

func (*GetDocumentInput) SetVersionName added in v1.99.0

func (s *GetDocumentInput) SetVersionName(v string) *GetDocumentInput

SetVersionName sets the VersionName field's value.

func (GetDocumentInput) String added in v0.6.5

func (s GetDocumentInput) String() string

String returns the string representation

func (*GetDocumentInput) Validate added in v1.1.21

func (s *GetDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDocumentOutput

type GetDocumentOutput struct {

	// A description of the document attachments, including names, locations, sizes,
	// etc.
	AttachmentsContent []*AttachmentContent `type:"list"`

	// The contents of the Systems Manager document.
	Content *string `min:"1" type:"string"`

	// The document format, either JSON or YAML.
	DocumentFormat *string `type:"string" enum:"DocumentFormat"`

	// The document type.
	DocumentType *string `type:"string" enum:"DocumentType"`

	// The document version.
	DocumentVersion *string `type:"string"`

	// The name of the Systems Manager document.
	Name *string `type:"string"`

	// The status of the Systems Manager document, such as Creating, Active, Updating,
	// Failed, and Deleting.
	Status *string `type:"string" enum:"DocumentStatus"`

	// A message returned by AWS Systems Manager that explains the Status value.
	// For example, a Failed status might be explained by the StatusInformation
	// message, "The specified S3 bucket does not exist. Verify that the URL of
	// the S3 bucket is correct."
	StatusInformation *string `type:"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
	// cannot be changed.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDocumentOutput) GoString added in v0.6.5

func (s GetDocumentOutput) GoString() string

GoString returns the string representation

func (*GetDocumentOutput) SetAttachmentsContent added in v1.99.0

func (s *GetDocumentOutput) SetAttachmentsContent(v []*AttachmentContent) *GetDocumentOutput

SetAttachmentsContent sets the AttachmentsContent field's value.

func (*GetDocumentOutput) SetContent added in v1.5.0

func (s *GetDocumentOutput) SetContent(v string) *GetDocumentOutput

SetContent sets the Content field's value.

func (*GetDocumentOutput) SetDocumentFormat added in v1.12.37

func (s *GetDocumentOutput) SetDocumentFormat(v string) *GetDocumentOutput

SetDocumentFormat sets the DocumentFormat field's value.

func (*GetDocumentOutput) SetDocumentType added in v1.5.13

func (s *GetDocumentOutput) SetDocumentType(v string) *GetDocumentOutput

SetDocumentType sets the DocumentType field's value.

func (*GetDocumentOutput) SetDocumentVersion added in v1.5.13

func (s *GetDocumentOutput) SetDocumentVersion(v string) *GetDocumentOutput

SetDocumentVersion sets the DocumentVersion field's value.

func (*GetDocumentOutput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*GetDocumentOutput) SetStatus added in v1.99.0

func (s *GetDocumentOutput) SetStatus(v string) *GetDocumentOutput

SetStatus sets the Status field's value.

func (*GetDocumentOutput) SetStatusInformation added in v1.99.0

func (s *GetDocumentOutput) SetStatusInformation(v string) *GetDocumentOutput

SetStatusInformation sets the StatusInformation field's value.

func (*GetDocumentOutput) SetVersionName added in v1.99.0

func (s *GetDocumentOutput) SetVersionName(v string) *GetDocumentOutput

SetVersionName sets the VersionName field's value.

func (GetDocumentOutput) String added in v0.6.5

func (s GetDocumentOutput) String() string

String returns the string representation

type GetInventoryInput added in v1.5.13

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 instances exist in
	// your inventoried fleet.
	Aggregators []*InventoryAggregator `min:"1" type:"list"`

	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*InventoryFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The list of inventory item types to return.
	ResultAttributes []*ResultAttribute `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GetInventoryInput) GoString added in v1.5.13

func (s GetInventoryInput) GoString() string

GoString returns the string representation

func (*GetInventoryInput) SetAggregators added in v1.12.27

func (s *GetInventoryInput) SetAggregators(v []*InventoryAggregator) *GetInventoryInput

SetAggregators sets the Aggregators field's value.

func (*GetInventoryInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*GetInventoryInput) SetMaxResults added in v1.5.13

func (s *GetInventoryInput) SetMaxResults(v int64) *GetInventoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetInventoryInput) SetNextToken added in v1.5.13

func (s *GetInventoryInput) SetNextToken(v string) *GetInventoryInput

SetNextToken sets the NextToken field's value.

func (*GetInventoryInput) SetResultAttributes added in v1.5.13

func (s *GetInventoryInput) SetResultAttributes(v []*ResultAttribute) *GetInventoryInput

SetResultAttributes sets the ResultAttributes field's value.

func (GetInventoryInput) String added in v1.5.13

func (s GetInventoryInput) String() string

String returns the string representation

func (*GetInventoryInput) Validate added in v1.5.13

func (s *GetInventoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInventoryOutput added in v1.5.13

type GetInventoryOutput struct {

	// Collection of inventory entities such as a collection of instance inventory.
	Entities []*InventoryResultEntity `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (GetInventoryOutput) GoString added in v1.5.13

func (s GetInventoryOutput) GoString() string

GoString returns the string representation

func (*GetInventoryOutput) SetEntities added in v1.5.13

SetEntities sets the Entities field's value.

func (*GetInventoryOutput) SetNextToken added in v1.5.13

func (s *GetInventoryOutput) SetNextToken(v string) *GetInventoryOutput

SetNextToken sets the NextToken field's value.

func (GetInventoryOutput) String added in v1.5.13

func (s GetInventoryOutput) String() string

String returns the string representation

type GetInventorySchemaInput added in v1.5.13

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 `type:"boolean"`

	// 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 *int64 `min:"50" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// Returns the sub-type schema for a specified inventory type.
	SubType *bool `type:"boolean"`

	// The type of inventory item to return.
	TypeName *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetInventorySchemaInput) GoString added in v1.5.13

func (s GetInventorySchemaInput) GoString() string

GoString returns the string representation

func (*GetInventorySchemaInput) SetAggregator added in v1.12.27

SetAggregator sets the Aggregator field's value.

func (*GetInventorySchemaInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*GetInventorySchemaInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*GetInventorySchemaInput) SetSubType added in v1.10.25

SetSubType sets the SubType field's value.

func (*GetInventorySchemaInput) SetTypeName added in v1.5.13

SetTypeName sets the TypeName field's value.

func (GetInventorySchemaInput) String added in v1.5.13

func (s GetInventorySchemaInput) String() string

String returns the string representation

func (*GetInventorySchemaInput) Validate added in v1.5.13

func (s *GetInventorySchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInventorySchemaOutput added in v1.5.13

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 `type:"string"`

	// Inventory schemas returned by the request.
	Schemas []*InventoryItemSchema `type:"list"`
	// contains filtered or unexported fields
}

func (GetInventorySchemaOutput) GoString added in v1.5.13

func (s GetInventorySchemaOutput) GoString() string

GoString returns the string representation

func (*GetInventorySchemaOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*GetInventorySchemaOutput) SetSchemas added in v1.5.13

SetSchemas sets the Schemas field's value.

func (GetInventorySchemaOutput) String added in v1.5.13

func (s GetInventorySchemaOutput) String() string

String returns the string representation

type GetMaintenanceWindowExecutionInput added in v1.5.13

type GetMaintenanceWindowExecutionInput struct {

	// The ID of the maintenance window execution that includes the task.
	//
	// WindowExecutionId is a required field
	WindowExecutionId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowExecutionInput) GoString added in v1.5.13

GoString returns the string representation

func (*GetMaintenanceWindowExecutionInput) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (GetMaintenanceWindowExecutionInput) String added in v1.5.13

String returns the string representation

func (*GetMaintenanceWindowExecutionInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type GetMaintenanceWindowExecutionOutput added in v1.5.13

type GetMaintenanceWindowExecutionOutput struct {

	// The time the maintenance window finished running.
	EndTime *time.Time `type:"timestamp"`

	// The time the maintenance window started running.
	StartTime *time.Time `type:"timestamp"`

	// The status of the maintenance window execution.
	Status *string `type:"string" enum:"MaintenanceWindowExecutionStatus"`

	// The details explaining the Status. Only available for certain status values.
	StatusDetails *string `type:"string"`

	// The ID of the task executions from the maintenance window execution.
	TaskIds []*string `type:"list"`

	// The ID of the maintenance window execution.
	WindowExecutionId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowExecutionOutput) GoString added in v1.5.13

GoString returns the string representation

func (*GetMaintenanceWindowExecutionOutput) SetEndTime added in v1.5.13

SetEndTime sets the EndTime field's value.

func (*GetMaintenanceWindowExecutionOutput) SetStartTime added in v1.5.13

SetStartTime sets the StartTime field's value.

func (*GetMaintenanceWindowExecutionOutput) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (*GetMaintenanceWindowExecutionOutput) SetStatusDetails added in v1.5.13

SetStatusDetails sets the StatusDetails field's value.

func (*GetMaintenanceWindowExecutionOutput) SetTaskIds added in v1.5.13

SetTaskIds sets the TaskIds field's value.

func (*GetMaintenanceWindowExecutionOutput) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (GetMaintenanceWindowExecutionOutput) String added in v1.5.13

String returns the string representation

type GetMaintenanceWindowExecutionTaskInput added in v1.5.13

type GetMaintenanceWindowExecutionTaskInput struct {

	// The ID of the specific task execution in the maintenance window task that
	// should be retrieved.
	//
	// TaskId is a required field
	TaskId *string `min:"36" type:"string" required:"true"`

	// The ID of the maintenance window execution that includes the task.
	//
	// WindowExecutionId is a required field
	WindowExecutionId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowExecutionTaskInput) GoString added in v1.5.13

GoString returns the string representation

func (*GetMaintenanceWindowExecutionTaskInput) SetTaskId added in v1.5.13

SetTaskId sets the TaskId field's value.

func (*GetMaintenanceWindowExecutionTaskInput) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (GetMaintenanceWindowExecutionTaskInput) String added in v1.5.13

String returns the string representation

func (*GetMaintenanceWindowExecutionTaskInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type GetMaintenanceWindowExecutionTaskInvocationInput added in v1.10.25

type GetMaintenanceWindowExecutionTaskInvocationInput struct {

	// The invocation ID to retrieve.
	//
	// InvocationId is a required field
	InvocationId *string `min:"36" type:"string" required:"true"`

	// The ID of the specific task in the maintenance window task that should be
	// retrieved.
	//
	// TaskId is a required field
	TaskId *string `min:"36" type:"string" required:"true"`

	// The ID of the maintenance window execution for which the task is a part.
	//
	// WindowExecutionId is a required field
	WindowExecutionId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowExecutionTaskInvocationInput) GoString added in v1.10.25

GoString returns the string representation

func (*GetMaintenanceWindowExecutionTaskInvocationInput) SetInvocationId added in v1.10.25

SetInvocationId sets the InvocationId field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationInput) SetTaskId added in v1.10.25

SetTaskId sets the TaskId field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationInput) SetWindowExecutionId added in v1.10.25

SetWindowExecutionId sets the WindowExecutionId field's value.

func (GetMaintenanceWindowExecutionTaskInvocationInput) String added in v1.10.25

String returns the string representation

func (*GetMaintenanceWindowExecutionTaskInvocationInput) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type GetMaintenanceWindowExecutionTaskInvocationOutput added in v1.10.25

type GetMaintenanceWindowExecutionTaskInvocationOutput struct {

	// The time that the task finished running on the target.
	EndTime *time.Time `type:"timestamp"`

	// The execution ID.
	ExecutionId *string `type:"string"`

	// The invocation ID.
	InvocationId *string `min:"36" type:"string"`

	// User-provided value to be included in any CloudWatch events raised while
	// running tasks for these targets in this maintenance window.
	OwnerInformation *string `min:"1" type:"string" sensitive:"true"`

	// The parameters used at the time that the task ran.
	Parameters *string `type:"string" sensitive:"true"`

	// The time that the task started running on the target.
	StartTime *time.Time `type:"timestamp"`

	// The task status for an invocation.
	Status *string `type:"string" enum:"MaintenanceWindowExecutionStatus"`

	// The details explaining the status. Details are only available for certain
	// status values.
	StatusDetails *string `type:"string"`

	// The task execution ID.
	TaskExecutionId *string `min:"36" type:"string"`

	// Retrieves the task type for a maintenance window. Task types include the
	// following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.
	TaskType *string `type:"string" enum:"MaintenanceWindowTaskType"`

	// The maintenance window execution ID.
	WindowExecutionId *string `min:"36" type:"string"`

	// The maintenance window target ID.
	WindowTargetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowExecutionTaskInvocationOutput) GoString added in v1.10.25

GoString returns the string representation

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetEndTime added in v1.10.25

SetEndTime sets the EndTime field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetExecutionId added in v1.10.25

SetExecutionId sets the ExecutionId field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetInvocationId added in v1.10.25

SetInvocationId sets the InvocationId field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetOwnerInformation added in v1.10.25

SetOwnerInformation sets the OwnerInformation field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetParameters added in v1.10.25

SetParameters sets the Parameters field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetStartTime added in v1.10.25

SetStartTime sets the StartTime field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetStatus added in v1.10.25

SetStatus sets the Status field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetStatusDetails added in v1.10.25

SetStatusDetails sets the StatusDetails field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetTaskExecutionId added in v1.10.25

SetTaskExecutionId sets the TaskExecutionId field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetTaskType added in v1.10.25

SetTaskType sets the TaskType field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetWindowExecutionId added in v1.10.25

SetWindowExecutionId sets the WindowExecutionId field's value.

func (*GetMaintenanceWindowExecutionTaskInvocationOutput) SetWindowTargetId added in v1.10.25

SetWindowTargetId sets the WindowTargetId field's value.

func (GetMaintenanceWindowExecutionTaskInvocationOutput) String added in v1.10.25

String returns the string representation

type GetMaintenanceWindowExecutionTaskOutput added in v1.5.13

type GetMaintenanceWindowExecutionTaskOutput struct {

	// The time the task execution completed.
	EndTime *time.Time `type:"timestamp"`

	// The defined maximum number of task executions that could be run in parallel.
	MaxConcurrency *string `min:"1" type:"string"`

	// The defined maximum number of task execution errors allowed before scheduling
	// of the task execution would have been stopped.
	MaxErrors *string `min:"1" type:"string"`

	// The priority of the task.
	Priority *int64 `type:"integer"`

	// The role that was assumed when running the task.
	ServiceRole *string `type:"string"`

	// The time the task execution started.
	StartTime *time.Time `type:"timestamp"`

	// The status of the task.
	Status *string `type:"string" enum:"MaintenanceWindowExecutionStatus"`

	// The details explaining the Status. Only available for certain status values.
	StatusDetails *string `type:"string"`

	// The ARN of the task that ran.
	TaskArn *string `min:"1" type:"string"`

	// The ID of the specific task execution in the maintenance window task that
	// was retrieved.
	TaskExecutionId *string `min:"36" type:"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 string is between 1 and 255 characters
	TaskParameters []map[string]*MaintenanceWindowTaskParameterValueExpression `type:"list" sensitive:"true"`

	// The type of task that was run.
	Type *string `type:"string" enum:"MaintenanceWindowTaskType"`

	// The ID of the maintenance window execution that includes the task.
	WindowExecutionId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowExecutionTaskOutput) GoString added in v1.5.13

GoString returns the string representation

func (*GetMaintenanceWindowExecutionTaskOutput) SetEndTime added in v1.5.13

SetEndTime sets the EndTime field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetMaxConcurrency added in v1.5.13

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetMaxErrors added in v1.5.13

SetMaxErrors sets the MaxErrors field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetPriority added in v1.5.13

SetPriority sets the Priority field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetServiceRole added in v1.5.13

SetServiceRole sets the ServiceRole field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetStartTime added in v1.5.13

SetStartTime sets the StartTime field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetStatusDetails added in v1.5.13

SetStatusDetails sets the StatusDetails field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetTaskArn added in v1.5.13

SetTaskArn sets the TaskArn field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetTaskExecutionId added in v1.5.13

SetTaskExecutionId sets the TaskExecutionId field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetTaskParameters added in v1.5.13

SetTaskParameters sets the TaskParameters field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetType added in v1.5.13

SetType sets the Type field's value.

func (*GetMaintenanceWindowExecutionTaskOutput) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (GetMaintenanceWindowExecutionTaskOutput) String added in v1.5.13

String returns the string representation

type GetMaintenanceWindowInput added in v1.5.13

type GetMaintenanceWindowInput struct {

	// The ID of the maintenance window for which you want to retrieve information.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowInput) GoString added in v1.5.13

func (s GetMaintenanceWindowInput) GoString() string

GoString returns the string representation

func (*GetMaintenanceWindowInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (GetMaintenanceWindowInput) String added in v1.5.13

func (s GetMaintenanceWindowInput) String() string

String returns the string representation

func (*GetMaintenanceWindowInput) Validate added in v1.5.13

func (s *GetMaintenanceWindowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMaintenanceWindowOutput added in v1.5.13

type GetMaintenanceWindowOutput struct {

	// Whether targets must be registered with the maintenance window before tasks
	// can be defined for those targets.
	AllowUnassociatedTargets *bool `type:"boolean"`

	// The date the maintenance window was created.
	CreatedDate *time.Time `type:"timestamp"`

	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int64 `type:"integer"`

	// The description of the maintenance window.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The duration of the maintenance window in hours.
	Duration *int64 `min:"1" type:"integer"`

	// Indicates whether the maintenance window is enabled.
	Enabled *bool `type:"boolean"`

	// The date and time, in ISO-8601 Extended format, for when the maintenance
	// window is scheduled to become inactive. The maintenance window will not run
	// after this specified time.
	EndDate *string `type:"string"`

	// The date the maintenance window was last modified.
	ModifiedDate *time.Time `type:"timestamp"`

	// The name of the maintenance window.
	Name *string `min:"3" type:"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 `type:"string"`

	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string `min:"1" type:"string"`

	// The time zone that the scheduled maintenance window executions are based
	// on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles",
	// "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database
	// (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string `type:"string"`

	// The date and time, in ISO-8601 Extended format, for when the maintenance
	// window is scheduled to become active. The maintenance window will not run
	// before this specified time.
	StartDate *string `type:"string"`

	// The ID of the created maintenance window.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowOutput) GoString added in v1.5.13

func (s GetMaintenanceWindowOutput) GoString() string

GoString returns the string representation

func (*GetMaintenanceWindowOutput) SetAllowUnassociatedTargets added in v1.5.13

func (s *GetMaintenanceWindowOutput) SetAllowUnassociatedTargets(v bool) *GetMaintenanceWindowOutput

SetAllowUnassociatedTargets sets the AllowUnassociatedTargets field's value.

func (*GetMaintenanceWindowOutput) SetCreatedDate added in v1.5.13

SetCreatedDate sets the CreatedDate field's value.

func (*GetMaintenanceWindowOutput) SetCutoff added in v1.5.13

SetCutoff sets the Cutoff field's value.

func (*GetMaintenanceWindowOutput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*GetMaintenanceWindowOutput) SetDuration added in v1.5.13

SetDuration sets the Duration field's value.

func (*GetMaintenanceWindowOutput) SetEnabled added in v1.5.13

SetEnabled sets the Enabled field's value.

func (*GetMaintenanceWindowOutput) SetEndDate added in v1.99.0

SetEndDate sets the EndDate field's value.

func (*GetMaintenanceWindowOutput) SetModifiedDate added in v1.5.13

SetModifiedDate sets the ModifiedDate field's value.

func (*GetMaintenanceWindowOutput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*GetMaintenanceWindowOutput) SetNextExecutionTime added in v1.99.0

func (s *GetMaintenanceWindowOutput) SetNextExecutionTime(v string) *GetMaintenanceWindowOutput

SetNextExecutionTime sets the NextExecutionTime field's value.

func (*GetMaintenanceWindowOutput) SetSchedule added in v1.5.13

SetSchedule sets the Schedule field's value.

func (*GetMaintenanceWindowOutput) SetScheduleTimezone added in v1.99.0

SetScheduleTimezone sets the ScheduleTimezone field's value.

func (*GetMaintenanceWindowOutput) SetStartDate added in v1.99.0

SetStartDate sets the StartDate field's value.

func (*GetMaintenanceWindowOutput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (GetMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type GetMaintenanceWindowTaskInput added in v1.10.25

type GetMaintenanceWindowTaskInput struct {

	// The maintenance window ID that includes the task to retrieve.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`

	// The maintenance window task ID to retrieve.
	//
	// WindowTaskId is a required field
	WindowTaskId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowTaskInput) GoString added in v1.10.25

GoString returns the string representation

func (*GetMaintenanceWindowTaskInput) SetWindowId added in v1.10.25

SetWindowId sets the WindowId field's value.

func (*GetMaintenanceWindowTaskInput) SetWindowTaskId added in v1.10.25

SetWindowTaskId sets the WindowTaskId field's value.

func (GetMaintenanceWindowTaskInput) String added in v1.10.25

String returns the string representation

func (*GetMaintenanceWindowTaskInput) Validate added in v1.10.25

func (s *GetMaintenanceWindowTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMaintenanceWindowTaskOutput added in v1.10.25

type GetMaintenanceWindowTaskOutput struct {

	// The retrieved task description.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The location in Amazon S3 where the task results are logged.
	//
	// LoggingInfo has been deprecated. To specify an S3 bucket to contain logs,
	// instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	LoggingInfo *LoggingInfo `type:"structure"`

	// The maximum number of targets allowed to run this task in parallel.
	MaxConcurrency *string `min:"1" type:"string"`

	// The maximum number of errors allowed before the task stops being scheduled.
	MaxErrors *string `min:"1" type:"string"`

	// The retrieved task name.
	Name *string `min:"3" type:"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 *int64 `type:"integer"`

	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for maintenance window Run Command tasks.
	ServiceRoleArn *string `type:"string"`

	// The targets where the task should run.
	Targets []*Target `type:"list"`

	// The resource that the task used during execution. For RUN_COMMAND and AUTOMATION
	// task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA
	// tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the
	// value is the state machine ARN.
	TaskArn *string `min:"1" type:"string"`

	// The parameters to pass to the task when it runs.
	TaskInvocationParameters *MaintenanceWindowTaskInvocationParameters `type:"structure"`

	// 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]*MaintenanceWindowTaskParameterValueExpression `type:"map" sensitive:"true"`

	// The type of task to run.
	TaskType *string `type:"string" enum:"MaintenanceWindowTaskType"`

	// The retrieved maintenance window ID.
	WindowId *string `min:"20" type:"string"`

	// The retrieved maintenance window task ID.
	WindowTaskId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (GetMaintenanceWindowTaskOutput) GoString added in v1.10.25

GoString returns the string representation

func (*GetMaintenanceWindowTaskOutput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*GetMaintenanceWindowTaskOutput) SetLoggingInfo added in v1.10.25

SetLoggingInfo sets the LoggingInfo field's value.

func (*GetMaintenanceWindowTaskOutput) SetMaxConcurrency added in v1.10.25

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*GetMaintenanceWindowTaskOutput) SetMaxErrors added in v1.10.25

SetMaxErrors sets the MaxErrors field's value.

func (*GetMaintenanceWindowTaskOutput) SetName added in v1.10.25

SetName sets the Name field's value.

func (*GetMaintenanceWindowTaskOutput) SetPriority added in v1.10.25

SetPriority sets the Priority field's value.

func (*GetMaintenanceWindowTaskOutput) SetServiceRoleArn added in v1.10.25

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*GetMaintenanceWindowTaskOutput) SetTargets added in v1.10.25

SetTargets sets the Targets field's value.

func (*GetMaintenanceWindowTaskOutput) SetTaskArn added in v1.10.25

SetTaskArn sets the TaskArn field's value.

func (*GetMaintenanceWindowTaskOutput) SetTaskInvocationParameters added in v1.10.25

SetTaskInvocationParameters sets the TaskInvocationParameters field's value.

func (*GetMaintenanceWindowTaskOutput) SetTaskParameters added in v1.10.25

SetTaskParameters sets the TaskParameters field's value.

func (*GetMaintenanceWindowTaskOutput) SetTaskType added in v1.10.25

SetTaskType sets the TaskType field's value.

func (*GetMaintenanceWindowTaskOutput) SetWindowId added in v1.10.25

SetWindowId sets the WindowId field's value.

func (*GetMaintenanceWindowTaskOutput) SetWindowTaskId added in v1.10.25

SetWindowTaskId sets the WindowTaskId field's value.

func (GetMaintenanceWindowTaskOutput) String added in v1.10.25

String returns the string representation

type GetOpsItemInput added in v1.99.0

type GetOpsItemInput struct {

	// The ID of the OpsItem that you want to get.
	//
	// OpsItemId is a required field
	OpsItemId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetOpsItemInput) GoString added in v1.99.0

func (s GetOpsItemInput) GoString() string

GoString returns the string representation

func (*GetOpsItemInput) SetOpsItemId added in v1.99.0

func (s *GetOpsItemInput) SetOpsItemId(v string) *GetOpsItemInput

SetOpsItemId sets the OpsItemId field's value.

func (GetOpsItemInput) String added in v1.99.0

func (s GetOpsItemInput) String() string

String returns the string representation

func (*GetOpsItemInput) Validate added in v1.99.0

func (s *GetOpsItemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOpsItemOutput added in v1.99.0

type GetOpsItemOutput struct {

	// The OpsItem.
	OpsItem *OpsItem `type:"structure"`
	// contains filtered or unexported fields
}

func (GetOpsItemOutput) GoString added in v1.99.0

func (s GetOpsItemOutput) GoString() string

GoString returns the string representation

func (*GetOpsItemOutput) SetOpsItem added in v1.99.0

func (s *GetOpsItemOutput) SetOpsItem(v *OpsItem) *GetOpsItemOutput

SetOpsItem sets the OpsItem field's value.

func (GetOpsItemOutput) String added in v1.99.0

func (s GetOpsItemOutput) String() string

String returns the string representation

type GetOpsSummaryInput added in v1.99.0

type GetOpsSummaryInput struct {

	// Optional aggregators that return counts of OpsItems based on one or more
	// expressions.
	//
	// Aggregators is a required field
	Aggregators []*OpsAggregator `min:"1" type:"list" required:"true"`

	// Optional filters used to scope down the returned OpsItems.
	Filters []*OpsFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetOpsSummaryInput) GoString added in v1.99.0

func (s GetOpsSummaryInput) GoString() string

GoString returns the string representation

func (*GetOpsSummaryInput) SetAggregators added in v1.99.0

func (s *GetOpsSummaryInput) SetAggregators(v []*OpsAggregator) *GetOpsSummaryInput

SetAggregators sets the Aggregators field's value.

func (*GetOpsSummaryInput) SetFilters added in v1.99.0

func (s *GetOpsSummaryInput) SetFilters(v []*OpsFilter) *GetOpsSummaryInput

SetFilters sets the Filters field's value.

func (*GetOpsSummaryInput) SetMaxResults added in v1.99.0

func (s *GetOpsSummaryInput) SetMaxResults(v int64) *GetOpsSummaryInput

SetMaxResults sets the MaxResults field's value.

func (*GetOpsSummaryInput) SetNextToken added in v1.99.0

func (s *GetOpsSummaryInput) SetNextToken(v string) *GetOpsSummaryInput

SetNextToken sets the NextToken field's value.

func (GetOpsSummaryInput) String added in v1.99.0

func (s GetOpsSummaryInput) String() string

String returns the string representation

func (*GetOpsSummaryInput) Validate added in v1.99.0

func (s *GetOpsSummaryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOpsSummaryOutput added in v1.99.0

type GetOpsSummaryOutput struct {

	// The list of aggregated and filtered OpsItems.
	Entities []*OpsEntity `type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetOpsSummaryOutput) GoString added in v1.99.0

func (s GetOpsSummaryOutput) GoString() string

GoString returns the string representation

func (*GetOpsSummaryOutput) SetEntities added in v1.99.0

func (s *GetOpsSummaryOutput) SetEntities(v []*OpsEntity) *GetOpsSummaryOutput

SetEntities sets the Entities field's value.

func (*GetOpsSummaryOutput) SetNextToken added in v1.99.0

func (s *GetOpsSummaryOutput) SetNextToken(v string) *GetOpsSummaryOutput

SetNextToken sets the NextToken field's value.

func (GetOpsSummaryOutput) String added in v1.99.0

func (s GetOpsSummaryOutput) String() string

String returns the string representation

type GetParameterHistoryInput added in v1.5.13

type GetParameterHistoryInput 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 *int64 `min:"1" type:"integer"`

	// The name of a parameter you want to query.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// Return decrypted values for secure string parameters. This flag is ignored
	// for String and StringList parameter types.
	WithDecryption *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (GetParameterHistoryInput) GoString added in v1.5.13

func (s GetParameterHistoryInput) GoString() string

GoString returns the string representation

func (*GetParameterHistoryInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*GetParameterHistoryInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*GetParameterHistoryInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*GetParameterHistoryInput) SetWithDecryption added in v1.5.13

func (s *GetParameterHistoryInput) SetWithDecryption(v bool) *GetParameterHistoryInput

SetWithDecryption sets the WithDecryption field's value.

func (GetParameterHistoryInput) String added in v1.5.13

func (s GetParameterHistoryInput) String() string

String returns the string representation

func (*GetParameterHistoryInput) Validate added in v1.5.13

func (s *GetParameterHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetParameterHistoryOutput added in v1.5.13

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 `type:"string"`

	// A list of parameters returned by the request.
	Parameters []*ParameterHistory `type:"list"`
	// contains filtered or unexported fields
}

func (GetParameterHistoryOutput) GoString added in v1.5.13

func (s GetParameterHistoryOutput) GoString() string

GoString returns the string representation

func (*GetParameterHistoryOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*GetParameterHistoryOutput) SetParameters added in v1.5.13

SetParameters sets the Parameters field's value.

func (GetParameterHistoryOutput) String added in v1.5.13

func (s GetParameterHistoryOutput) String() string

String returns the string representation

type GetParameterInput added in v1.10.1

type GetParameterInput struct {

	// The name of the parameter you want to query.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Return decrypted values for secure string parameters. This flag is ignored
	// for String and StringList parameter types.
	WithDecryption *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (GetParameterInput) GoString added in v1.10.1

func (s GetParameterInput) GoString() string

GoString returns the string representation

func (*GetParameterInput) SetName added in v1.10.1

SetName sets the Name field's value.

func (*GetParameterInput) SetWithDecryption added in v1.10.1

func (s *GetParameterInput) SetWithDecryption(v bool) *GetParameterInput

SetWithDecryption sets the WithDecryption field's value.

func (GetParameterInput) String added in v1.10.1

func (s GetParameterInput) String() string

String returns the string representation

func (*GetParameterInput) Validate added in v1.10.1

func (s *GetParameterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetParameterOutput added in v1.10.1

type GetParameterOutput struct {

	// Information about a parameter.
	Parameter *Parameter `type:"structure"`
	// contains filtered or unexported fields
}

func (GetParameterOutput) GoString added in v1.10.1

func (s GetParameterOutput) GoString() string

GoString returns the string representation

func (*GetParameterOutput) SetParameter added in v1.10.1

func (s *GetParameterOutput) SetParameter(v *Parameter) *GetParameterOutput

SetParameter sets the Parameter field's value.

func (GetParameterOutput) String added in v1.10.1

func (s GetParameterOutput) String() string

String returns the string representation

type GetParametersByPathInput added in v1.10.1

type GetParametersByPathInput 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`

	// Filters to limit the request results.
	//
	// You can't filter using the parameter name.
	ParameterFilters []*ParameterStringFilter `type:"list"`

	// The hierarchy for the parameter. Hierarchies start with a forward slash (/)
	// and end with the parameter name. A parameter name hierarchy can have a maximum
	// of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
	//
	// Path is a required field
	Path *string `min:"1" type:"string" required:"true"`

	// Retrieve all parameters within a hierarchy.
	//
	// If a user has access to a path, then the user can access all levels of that
	// path. For example, if a user has permission to access path /a, then the user
	// can also access /a/b. Even if a user has explicitly been denied access in
	// IAM for parameter /a/b, they can still call the GetParametersByPath API action
	// recursively for /a and view /a/b.
	Recursive *bool `type:"boolean"`

	// Retrieve all parameters in a hierarchy with their value decrypted.
	WithDecryption *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (GetParametersByPathInput) GoString added in v1.10.1

func (s GetParametersByPathInput) GoString() string

GoString returns the string representation

func (*GetParametersByPathInput) SetMaxResults added in v1.10.1

SetMaxResults sets the MaxResults field's value.

func (*GetParametersByPathInput) SetNextToken added in v1.10.1

SetNextToken sets the NextToken field's value.

func (*GetParametersByPathInput) SetParameterFilters added in v1.10.1

SetParameterFilters sets the ParameterFilters field's value.

func (*GetParametersByPathInput) SetPath added in v1.10.1

SetPath sets the Path field's value.

func (*GetParametersByPathInput) SetRecursive added in v1.10.1

SetRecursive sets the Recursive field's value.

func (*GetParametersByPathInput) SetWithDecryption added in v1.10.1

func (s *GetParametersByPathInput) SetWithDecryption(v bool) *GetParametersByPathInput

SetWithDecryption sets the WithDecryption field's value.

func (GetParametersByPathInput) String added in v1.10.1

func (s GetParametersByPathInput) String() string

String returns the string representation

func (*GetParametersByPathInput) Validate added in v1.10.1

func (s *GetParametersByPathInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetParametersByPathOutput added in v1.10.1

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 `type:"string"`

	// A list of parameters found in the specified hierarchy.
	Parameters []*Parameter `type:"list"`
	// contains filtered or unexported fields
}

func (GetParametersByPathOutput) GoString added in v1.10.1

func (s GetParametersByPathOutput) GoString() string

GoString returns the string representation

func (*GetParametersByPathOutput) SetNextToken added in v1.10.1

SetNextToken sets the NextToken field's value.

func (*GetParametersByPathOutput) SetParameters added in v1.10.1

SetParameters sets the Parameters field's value.

func (GetParametersByPathOutput) String added in v1.10.1

func (s GetParametersByPathOutput) String() string

String returns the string representation

type GetParametersInput added in v1.5.13

type GetParametersInput struct {

	// Names of the parameters for which you want to query information.
	//
	// Names is a required field
	Names []*string `min:"1" type:"list" required:"true"`

	// Return decrypted secure string value. Return decrypted values for secure
	// string parameters. This flag is ignored for String and StringList parameter
	// types.
	WithDecryption *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (GetParametersInput) GoString added in v1.5.13

func (s GetParametersInput) GoString() string

GoString returns the string representation

func (*GetParametersInput) SetNames added in v1.5.13

func (s *GetParametersInput) SetNames(v []*string) *GetParametersInput

SetNames sets the Names field's value.

func (*GetParametersInput) SetWithDecryption added in v1.5.13

func (s *GetParametersInput) SetWithDecryption(v bool) *GetParametersInput

SetWithDecryption sets the WithDecryption field's value.

func (GetParametersInput) String added in v1.5.13

func (s GetParametersInput) String() string

String returns the string representation

func (*GetParametersInput) Validate added in v1.5.13

func (s *GetParametersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetParametersOutput added in v1.5.13

type GetParametersOutput struct {

	// A list of parameters that are not formatted correctly or do not run during
	// an execution.
	InvalidParameters []*string `min:"1" type:"list"`

	// A list of details for a parameter.
	Parameters []*Parameter `type:"list"`
	// contains filtered or unexported fields
}

func (GetParametersOutput) GoString added in v1.5.13

func (s GetParametersOutput) GoString() string

GoString returns the string representation

func (*GetParametersOutput) SetInvalidParameters added in v1.5.13

func (s *GetParametersOutput) SetInvalidParameters(v []*string) *GetParametersOutput

SetInvalidParameters sets the InvalidParameters field's value.

func (*GetParametersOutput) SetParameters added in v1.5.13

func (s *GetParametersOutput) SetParameters(v []*Parameter) *GetParametersOutput

SetParameters sets the Parameters field's value.

func (GetParametersOutput) String added in v1.5.13

func (s GetParametersOutput) String() string

String returns the string representation

type GetPatchBaselineForPatchGroupInput added in v1.6.4

type GetPatchBaselineForPatchGroupInput struct {

	// Returns he operating system rule specified for patch groups using the patch
	// baseline.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// The name of the patch group whose patch baseline should be retrieved.
	//
	// PatchGroup is a required field
	PatchGroup *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPatchBaselineForPatchGroupInput) GoString added in v1.6.4

GoString returns the string representation

func (*GetPatchBaselineForPatchGroupInput) SetOperatingSystem added in v1.10.8

SetOperatingSystem sets the OperatingSystem field's value.

func (*GetPatchBaselineForPatchGroupInput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (GetPatchBaselineForPatchGroupInput) String added in v1.6.4

String returns the string representation

func (*GetPatchBaselineForPatchGroupInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type GetPatchBaselineForPatchGroupOutput added in v1.6.4

type GetPatchBaselineForPatchGroupOutput struct {

	// The ID of the patch baseline that should be used for the patch group.
	BaselineId *string `min:"20" type:"string"`

	// The operating system rule specified for patch groups using the patch baseline.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// The name of the patch group.
	PatchGroup *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetPatchBaselineForPatchGroupOutput) GoString added in v1.6.4

GoString returns the string representation

func (*GetPatchBaselineForPatchGroupOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*GetPatchBaselineForPatchGroupOutput) SetOperatingSystem added in v1.10.8

SetOperatingSystem sets the OperatingSystem field's value.

func (*GetPatchBaselineForPatchGroupOutput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (GetPatchBaselineForPatchGroupOutput) String added in v1.6.4

String returns the string representation

type GetPatchBaselineInput added in v1.6.4

type GetPatchBaselineInput struct {

	// The ID of the patch baseline to retrieve.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPatchBaselineInput) GoString added in v1.6.4

func (s GetPatchBaselineInput) GoString() string

GoString returns the string representation

func (*GetPatchBaselineInput) SetBaselineId added in v1.6.4

func (s *GetPatchBaselineInput) SetBaselineId(v string) *GetPatchBaselineInput

SetBaselineId sets the BaselineId field's value.

func (GetPatchBaselineInput) String added in v1.6.4

func (s GetPatchBaselineInput) String() string

String returns the string representation

func (*GetPatchBaselineInput) Validate added in v1.6.4

func (s *GetPatchBaselineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPatchBaselineOutput added in v1.6.4

type GetPatchBaselineOutput struct {

	// A set of rules used to include patches in the baseline.
	ApprovalRules *PatchRuleGroup `type:"structure"`

	// A list of explicitly approved patches for the baseline.
	ApprovedPatches []*string `type:"list"`

	// Returns the specified compliance severity level for approved patches in the
	// patch baseline.
	ApprovedPatchesComplianceLevel *string `type:"string" enum:"PatchComplianceLevel"`

	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool `type:"boolean"`

	// The ID of the retrieved patch baseline.
	BaselineId *string `min:"20" type:"string"`

	// The date the patch baseline was created.
	CreatedDate *time.Time `type:"timestamp"`

	// A description of the patch baseline.
	Description *string `min:"1" type:"string"`

	// A set of global filters used to exclude patches from the baseline.
	GlobalFilters *PatchFilterGroup `type:"structure"`

	// The date the patch baseline was last modified.
	ModifiedDate *time.Time `type:"timestamp"`

	// The name of the patch baseline.
	Name *string `min:"3" type:"string"`

	// Returns the operating system specified for the patch baseline.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// Patch groups included in the patch baseline.
	PatchGroups []*string `type:"list"`

	// A list of explicitly rejected patches for the baseline.
	RejectedPatches []*string `type:"list"`

	// 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 *string `type:"string" enum:"PatchAction"`

	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*PatchSource `type:"list"`
	// contains filtered or unexported fields
}

func (GetPatchBaselineOutput) GoString added in v1.6.4

func (s GetPatchBaselineOutput) GoString() string

GoString returns the string representation

func (*GetPatchBaselineOutput) SetApprovalRules added in v1.6.4

SetApprovalRules sets the ApprovalRules field's value.

func (*GetPatchBaselineOutput) SetApprovedPatches added in v1.6.4

func (s *GetPatchBaselineOutput) SetApprovedPatches(v []*string) *GetPatchBaselineOutput

SetApprovedPatches sets the ApprovedPatches field's value.

func (*GetPatchBaselineOutput) SetApprovedPatchesComplianceLevel added in v1.10.8

func (s *GetPatchBaselineOutput) SetApprovedPatchesComplianceLevel(v string) *GetPatchBaselineOutput

SetApprovedPatchesComplianceLevel sets the ApprovedPatchesComplianceLevel field's value.

func (*GetPatchBaselineOutput) SetApprovedPatchesEnableNonSecurity added in v1.12.72

func (s *GetPatchBaselineOutput) SetApprovedPatchesEnableNonSecurity(v bool) *GetPatchBaselineOutput

SetApprovedPatchesEnableNonSecurity sets the ApprovedPatchesEnableNonSecurity field's value.

func (*GetPatchBaselineOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*GetPatchBaselineOutput) SetCreatedDate added in v1.6.4

SetCreatedDate sets the CreatedDate field's value.

func (*GetPatchBaselineOutput) SetDescription added in v1.6.4

SetDescription sets the Description field's value.

func (*GetPatchBaselineOutput) SetGlobalFilters added in v1.6.4

SetGlobalFilters sets the GlobalFilters field's value.

func (*GetPatchBaselineOutput) SetModifiedDate added in v1.6.4

func (s *GetPatchBaselineOutput) SetModifiedDate(v time.Time) *GetPatchBaselineOutput

SetModifiedDate sets the ModifiedDate field's value.

func (*GetPatchBaselineOutput) SetName added in v1.6.4

SetName sets the Name field's value.

func (*GetPatchBaselineOutput) SetOperatingSystem added in v1.10.8

func (s *GetPatchBaselineOutput) SetOperatingSystem(v string) *GetPatchBaselineOutput

SetOperatingSystem sets the OperatingSystem field's value.

func (*GetPatchBaselineOutput) SetPatchGroups added in v1.6.4

func (s *GetPatchBaselineOutput) SetPatchGroups(v []*string) *GetPatchBaselineOutput

SetPatchGroups sets the PatchGroups field's value.

func (*GetPatchBaselineOutput) SetRejectedPatches added in v1.6.4

func (s *GetPatchBaselineOutput) SetRejectedPatches(v []*string) *GetPatchBaselineOutput

SetRejectedPatches sets the RejectedPatches field's value.

func (*GetPatchBaselineOutput) SetRejectedPatchesAction added in v1.99.0

func (s *GetPatchBaselineOutput) SetRejectedPatchesAction(v string) *GetPatchBaselineOutput

SetRejectedPatchesAction sets the RejectedPatchesAction field's value.

func (*GetPatchBaselineOutput) SetSources added in v1.12.72

SetSources sets the Sources field's value.

func (GetPatchBaselineOutput) String added in v1.6.4

func (s GetPatchBaselineOutput) String() string

String returns the string representation

type GetServiceSettingInput added in v1.99.0

type GetServiceSettingInput struct {

	// The ID of the service setting to get.
	//
	// SettingId is a required field
	SettingId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request body of the GetServiceSetting API action.

func (GetServiceSettingInput) GoString added in v1.99.0

func (s GetServiceSettingInput) GoString() string

GoString returns the string representation

func (*GetServiceSettingInput) SetSettingId added in v1.99.0

SetSettingId sets the SettingId field's value.

func (GetServiceSettingInput) String added in v1.99.0

func (s GetServiceSettingInput) String() string

String returns the string representation

func (*GetServiceSettingInput) Validate added in v1.99.0

func (s *GetServiceSettingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetServiceSettingOutput added in v1.99.0

type GetServiceSettingOutput struct {

	// The query result of the current service setting.
	ServiceSetting *ServiceSetting `type:"structure"`
	// contains filtered or unexported fields
}

The query result body of the GetServiceSetting API action.

func (GetServiceSettingOutput) GoString added in v1.99.0

func (s GetServiceSettingOutput) GoString() string

GoString returns the string representation

func (*GetServiceSettingOutput) SetServiceSetting added in v1.99.0

SetServiceSetting sets the ServiceSetting field's value.

func (GetServiceSettingOutput) String added in v1.99.0

func (s GetServiceSettingOutput) String() string

String returns the string representation

type InstanceAggregatedAssociationOverview added in v1.5.13

type InstanceAggregatedAssociationOverview struct {

	// Detailed status information about the aggregated associations.
	DetailedStatus *string `type:"string"`

	// The number of associations for the instance(s).
	InstanceAssociationStatusAggregatedCount map[string]*int64 `type:"map"`
	// contains filtered or unexported fields
}

Status information about the aggregated associations.

func (InstanceAggregatedAssociationOverview) GoString added in v1.5.13

GoString returns the string representation

func (*InstanceAggregatedAssociationOverview) SetDetailedStatus added in v1.5.13

SetDetailedStatus sets the DetailedStatus field's value.

func (*InstanceAggregatedAssociationOverview) SetInstanceAssociationStatusAggregatedCount added in v1.5.13

func (s *InstanceAggregatedAssociationOverview) SetInstanceAssociationStatusAggregatedCount(v map[string]*int64) *InstanceAggregatedAssociationOverview

SetInstanceAssociationStatusAggregatedCount sets the InstanceAssociationStatusAggregatedCount field's value.

func (InstanceAggregatedAssociationOverview) String added in v1.5.13

String returns the string representation

type InstanceAssociation added in v1.5.13

type InstanceAssociation struct {

	// The association ID.
	AssociationId *string `type:"string"`

	// Version information for the association on the instance.
	AssociationVersion *string `type:"string"`

	// The content of the association document for the instance(s).
	Content *string `min:"1" type:"string"`

	// The instance ID.
	InstanceId *string `type:"string"`
	// contains filtered or unexported fields
}

One or more association documents on the instance.

func (InstanceAssociation) GoString added in v1.5.13

func (s InstanceAssociation) GoString() string

GoString returns the string representation

func (*InstanceAssociation) SetAssociationId added in v1.5.13

func (s *InstanceAssociation) SetAssociationId(v string) *InstanceAssociation

SetAssociationId sets the AssociationId field's value.

func (*InstanceAssociation) SetAssociationVersion added in v1.10.30

func (s *InstanceAssociation) SetAssociationVersion(v string) *InstanceAssociation

SetAssociationVersion sets the AssociationVersion field's value.

func (*InstanceAssociation) SetContent added in v1.5.13

SetContent sets the Content field's value.

func (*InstanceAssociation) SetInstanceId added in v1.5.13

func (s *InstanceAssociation) SetInstanceId(v string) *InstanceAssociation

SetInstanceId sets the InstanceId field's value.

func (InstanceAssociation) String added in v1.5.13

func (s InstanceAssociation) String() string

String returns the string representation

type InstanceAssociationOutputLocation added in v1.5.13

type InstanceAssociationOutputLocation struct {

	// An Amazon S3 bucket where you want to store the results of this request.
	S3Location *S3OutputLocation `type:"structure"`
	// contains filtered or unexported fields
}

An Amazon S3 bucket where you want to store the results of this request.

func (InstanceAssociationOutputLocation) GoString added in v1.5.13

GoString returns the string representation

func (*InstanceAssociationOutputLocation) SetS3Location added in v1.5.13

SetS3Location sets the S3Location field's value.

func (InstanceAssociationOutputLocation) String added in v1.5.13

String returns the string representation

func (*InstanceAssociationOutputLocation) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type InstanceAssociationOutputUrl added in v1.5.13

type InstanceAssociationOutputUrl struct {

	// The URL of Amazon S3 bucket where you want to store the results of this request.
	S3OutputUrl *S3OutputUrl `type:"structure"`
	// contains filtered or unexported fields
}

The URL of Amazon S3 bucket where you want to store the results of this request.

func (InstanceAssociationOutputUrl) GoString added in v1.5.13

func (s InstanceAssociationOutputUrl) GoString() string

GoString returns the string representation

func (*InstanceAssociationOutputUrl) SetS3OutputUrl added in v1.5.13

SetS3OutputUrl sets the S3OutputUrl field's value.

func (InstanceAssociationOutputUrl) String added in v1.5.13

String returns the string representation

type InstanceAssociationStatusInfo added in v1.5.13

type InstanceAssociationStatusInfo struct {

	// The association ID.
	AssociationId *string `type:"string"`

	// The name of the association applied to the instance.
	AssociationName *string `type:"string"`

	// The version of the association applied to the instance.
	AssociationVersion *string `type:"string"`

	// Detailed status information about the instance association.
	DetailedStatus *string `type:"string"`

	// The association document versions.
	DocumentVersion *string `type:"string"`

	// An error code returned by the request to create the association.
	ErrorCode *string `type:"string"`

	// The date the instance association ran.
	ExecutionDate *time.Time `type:"timestamp"`

	// Summary information about association execution.
	ExecutionSummary *string `min:"1" type:"string"`

	// The instance ID where the association was created.
	InstanceId *string `type:"string"`

	// The name of the association.
	Name *string `type:"string"`

	// A URL for an Amazon S3 bucket where you want to store the results of this
	// request.
	OutputUrl *InstanceAssociationOutputUrl `type:"structure"`

	// Status information about the instance association.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Status information about the instance association.

func (InstanceAssociationStatusInfo) GoString added in v1.5.13

GoString returns the string representation

func (*InstanceAssociationStatusInfo) SetAssociationId added in v1.5.13

SetAssociationId sets the AssociationId field's value.

func (*InstanceAssociationStatusInfo) SetAssociationName added in v1.10.30

SetAssociationName sets the AssociationName field's value.

func (*InstanceAssociationStatusInfo) SetAssociationVersion added in v1.10.30

SetAssociationVersion sets the AssociationVersion field's value.

func (*InstanceAssociationStatusInfo) SetDetailedStatus added in v1.5.13

SetDetailedStatus sets the DetailedStatus field's value.

func (*InstanceAssociationStatusInfo) SetDocumentVersion added in v1.5.13

SetDocumentVersion sets the DocumentVersion field's value.

func (*InstanceAssociationStatusInfo) SetErrorCode added in v1.5.13

SetErrorCode sets the ErrorCode field's value.

func (*InstanceAssociationStatusInfo) SetExecutionDate added in v1.5.13

SetExecutionDate sets the ExecutionDate field's value.

func (*InstanceAssociationStatusInfo) SetExecutionSummary added in v1.5.13

SetExecutionSummary sets the ExecutionSummary field's value.

func (*InstanceAssociationStatusInfo) SetInstanceId added in v1.5.13

SetInstanceId sets the InstanceId field's value.

func (*InstanceAssociationStatusInfo) SetName added in v1.5.13

SetName sets the Name field's value.

func (*InstanceAssociationStatusInfo) SetOutputUrl added in v1.5.13

SetOutputUrl sets the OutputUrl field's value.

func (*InstanceAssociationStatusInfo) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (InstanceAssociationStatusInfo) String added in v1.5.13

String returns the string representation

type InstanceInformation added in v0.9.17

type InstanceInformation struct {

	// The activation ID created by Systems Manager when the server or VM was registered.
	ActivationId *string `type:"string"`

	// The version of SSM Agent running on your Linux instance.
	AgentVersion *string `type:"string"`

	// Information about the association.
	AssociationOverview *InstanceAggregatedAssociationOverview `type:"structure"`

	// The status of the association.
	AssociationStatus *string `type:"string"`

	// The fully qualified host name of the managed instance.
	ComputerName *string `min:"1" type:"string"`

	// The IP address of the managed instance.
	IPAddress *string `min:"1" type:"string"`

	// The Amazon Identity and Access Management (IAM) role assigned to the on-premises
	// Systems Manager managed instances. This call does not return the IAM role
	// for Amazon EC2 instances.
	IamRole *string `type:"string"`

	// The instance ID.
	InstanceId *string `type:"string"`

	// Indicates whether latest version of SSM Agent is running on your instance.
	// Some older versions of Windows Server use the EC2Config service to process
	// SSM requests. For this reason, this field does not indicate whether or not
	// the latest version is installed on Windows managed instances.
	IsLatestVersion *bool `type:"boolean"`

	// The date the association was last run.
	LastAssociationExecutionDate *time.Time `type:"timestamp"`

	// The date and time when agent last pinged Systems Manager service.
	LastPingDateTime *time.Time `type:"timestamp"`

	// The last date the association was successfully run.
	LastSuccessfulAssociationExecutionDate *time.Time `type:"timestamp"`

	// The name of the managed instance.
	Name *string `type:"string"`

	// Connection status of SSM Agent.
	PingStatus *string `type:"string" enum:"PingStatus"`

	// The name of the operating system platform running on your instance.
	PlatformName *string `type:"string"`

	// The operating system platform type.
	PlatformType *string `type:"string" enum:"PlatformType"`

	// The version of the OS platform running on your instance.
	PlatformVersion *string `type:"string"`

	// The date the server or VM was registered with AWS as a managed instance.
	RegistrationDate *time.Time `type:"timestamp"`

	// The type of instance. Instances are either EC2 instances or managed instances.
	ResourceType *string `type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

Describes a filter for a specific list of instances.

func (InstanceInformation) GoString added in v0.9.17

func (s InstanceInformation) GoString() string

GoString returns the string representation

func (*InstanceInformation) SetActivationId added in v1.5.0

func (s *InstanceInformation) SetActivationId(v string) *InstanceInformation

SetActivationId sets the ActivationId field's value.

func (*InstanceInformation) SetAgentVersion added in v1.5.0

func (s *InstanceInformation) SetAgentVersion(v string) *InstanceInformation

SetAgentVersion sets the AgentVersion field's value.

func (*InstanceInformation) SetAssociationOverview added in v1.5.13

SetAssociationOverview sets the AssociationOverview field's value.

func (*InstanceInformation) SetAssociationStatus added in v1.5.13

func (s *InstanceInformation) SetAssociationStatus(v string) *InstanceInformation

SetAssociationStatus sets the AssociationStatus field's value.

func (*InstanceInformation) SetComputerName added in v1.5.0

func (s *InstanceInformation) SetComputerName(v string) *InstanceInformation

SetComputerName sets the ComputerName field's value.

func (*InstanceInformation) SetIPAddress added in v1.5.0

func (s *InstanceInformation) SetIPAddress(v string) *InstanceInformation

SetIPAddress sets the IPAddress field's value.

func (*InstanceInformation) SetIamRole added in v1.5.0

SetIamRole sets the IamRole field's value.

func (*InstanceInformation) SetInstanceId added in v1.5.0

func (s *InstanceInformation) SetInstanceId(v string) *InstanceInformation

SetInstanceId sets the InstanceId field's value.

func (*InstanceInformation) SetIsLatestVersion added in v1.5.0

func (s *InstanceInformation) SetIsLatestVersion(v bool) *InstanceInformation

SetIsLatestVersion sets the IsLatestVersion field's value.

func (*InstanceInformation) SetLastAssociationExecutionDate added in v1.5.13

func (s *InstanceInformation) SetLastAssociationExecutionDate(v time.Time) *InstanceInformation

SetLastAssociationExecutionDate sets the LastAssociationExecutionDate field's value.

func (*InstanceInformation) SetLastPingDateTime added in v1.5.0

func (s *InstanceInformation) SetLastPingDateTime(v time.Time) *InstanceInformation

SetLastPingDateTime sets the LastPingDateTime field's value.

func (*InstanceInformation) SetLastSuccessfulAssociationExecutionDate added in v1.5.13

func (s *InstanceInformation) SetLastSuccessfulAssociationExecutionDate(v time.Time) *InstanceInformation

SetLastSuccessfulAssociationExecutionDate sets the LastSuccessfulAssociationExecutionDate field's value.

func (*InstanceInformation) SetName added in v1.5.0

SetName sets the Name field's value.

func (*InstanceInformation) SetPingStatus added in v1.5.0

func (s *InstanceInformation) SetPingStatus(v string) *InstanceInformation

SetPingStatus sets the PingStatus field's value.

func (*InstanceInformation) SetPlatformName added in v1.5.0

func (s *InstanceInformation) SetPlatformName(v string) *InstanceInformation

SetPlatformName sets the PlatformName field's value.

func (*InstanceInformation) SetPlatformType added in v1.5.0

func (s *InstanceInformation) SetPlatformType(v string) *InstanceInformation

SetPlatformType sets the PlatformType field's value.

func (*InstanceInformation) SetPlatformVersion added in v1.5.0

func (s *InstanceInformation) SetPlatformVersion(v string) *InstanceInformation

SetPlatformVersion sets the PlatformVersion field's value.

func (*InstanceInformation) SetRegistrationDate added in v1.5.0

func (s *InstanceInformation) SetRegistrationDate(v time.Time) *InstanceInformation

SetRegistrationDate sets the RegistrationDate field's value.

func (*InstanceInformation) SetResourceType added in v1.5.0

func (s *InstanceInformation) SetResourceType(v string) *InstanceInformation

SetResourceType sets the ResourceType field's value.

func (InstanceInformation) String added in v0.9.17

func (s InstanceInformation) String() string

String returns the string representation

type InstanceInformationFilter added in v0.9.17

type InstanceInformationFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true" enum:"InstanceInformationFilterKey"`

	// The filter values.
	//
	// ValueSet is a required field
	ValueSet []*string `locationName:"valueSet" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Describes a filter for a specific list of instances. You can filter instances information by using tags. You specify tags by using a key-value mapping.

Use this action instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and does not support tags.

func (InstanceInformationFilter) GoString added in v0.9.17

func (s InstanceInformationFilter) GoString() string

GoString returns the string representation

func (*InstanceInformationFilter) SetKey added in v1.5.0

SetKey sets the Key field's value.

func (*InstanceInformationFilter) SetValueSet added in v1.5.0

SetValueSet sets the ValueSet field's value.

func (InstanceInformationFilter) String added in v0.9.17

func (s InstanceInformationFilter) String() string

String returns the string representation

func (*InstanceInformationFilter) Validate added in v1.1.21

func (s *InstanceInformationFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InstanceInformationStringFilter added in v1.5.13

type InstanceInformationStringFilter struct {

	// The filter key name to describe your instances. For example:
	//
	// "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus"|"Tag
	// Key"
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The filter values.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The filters to describe or get information about your managed instances.

func (InstanceInformationStringFilter) GoString added in v1.5.13

GoString returns the string representation

func (*InstanceInformationStringFilter) SetKey added in v1.5.13

SetKey sets the Key field's value.

func (*InstanceInformationStringFilter) SetValues added in v1.5.13

SetValues sets the Values field's value.

func (InstanceInformationStringFilter) String added in v1.5.13

String returns the string representation

func (*InstanceInformationStringFilter) Validate added in v1.5.13

func (s *InstanceInformationStringFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InstancePatchState added in v1.6.4

type InstancePatchState struct {

	// The ID of the patch baseline used to patch the instance.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`

	// The number of patches from the patch baseline that were attempted to be installed
	// during the last patching operation, but failed to install.
	FailedCount *int64 `type:"integer"`

	// An https URL or an Amazon S3 path-style URL to a list of patches to be installed.
	// This patch installation list, which you maintain in an Amazon S3 bucket in
	// YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides
	// the patches specified by the default patch baseline.
	//
	// For more information about the InstallOverrideList parameter, see About the
	// SSM Document AWS-RunPatchBaseline (http://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html)
	// in the AWS Systems Manager User Guide.
	InstallOverrideList *string `min:"1" type:"string"`

	// The number of patches from the patch baseline that are installed on the instance.
	InstalledCount *int64 `type:"integer"`

	// The number of patches not specified in the patch baseline that are installed
	// on the instance.
	InstalledOtherCount *int64 `type:"integer"`

	// The number of instances with patches installed that are specified in a RejectedPatches
	// list. Patches with a status of InstalledRejected were typically installed
	// before they were added to a RejectedPatches list.
	//
	// If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction,
	// the value of InstalledRejectedCount will always be 0 (zero).
	InstalledRejectedCount *int64 `type:"integer"`

	// The ID of the managed instance the high-level patch compliance information
	// was collected for.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The number of patches from the patch baseline that are applicable for the
	// instance but aren't currently installed.
	MissingCount *int64 `type:"integer"`

	// The number of patches from the patch baseline that aren't applicable for
	// the instance and therefore aren't installed on the instance. This number
	// may be truncated if the list of patch names is very large. The number of
	// patches beyond this limit are reported in UnreportedNotApplicableCount.
	NotApplicableCount *int64 `type:"integer"`

	// The type of patching operation that was performed: SCAN (assess patch compliance
	// state) or INSTALL (install missing patches).
	//
	// Operation is a required field
	Operation *string `type:"string" required:"true" enum:"PatchOperationType"`

	// The time the most recent patching operation completed on the instance.
	//
	// OperationEndTime is a required field
	OperationEndTime *time.Time `type:"timestamp" required:"true"`

	// The time the most recent patching operation was started on the instance.
	//
	// OperationStartTime is a required field
	OperationStartTime *time.Time `type:"timestamp" required:"true"`

	// Placeholder information. This field will always be empty in the current release
	// of the service.
	OwnerInformation *string `min:"1" type:"string" sensitive:"true"`

	// The name of the patch group the managed instance belongs to.
	//
	// PatchGroup is a required field
	PatchGroup *string `min:"1" type:"string" required:"true"`

	// The ID of the patch baseline snapshot used during the patching operation
	// when this compliance data was collected.
	SnapshotId *string `min:"36" type:"string"`

	// The number of patches beyond the supported limit of NotApplicableCount that
	// are not reported by name to Systems Manager Inventory.
	UnreportedNotApplicableCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

func (InstancePatchState) GoString added in v1.6.4

func (s InstancePatchState) GoString() string

GoString returns the string representation

func (*InstancePatchState) SetBaselineId added in v1.6.4

func (s *InstancePatchState) SetBaselineId(v string) *InstancePatchState

SetBaselineId sets the BaselineId field's value.

func (*InstancePatchState) SetFailedCount added in v1.6.4

func (s *InstancePatchState) SetFailedCount(v int64) *InstancePatchState

SetFailedCount sets the FailedCount field's value.

func (*InstancePatchState) SetInstallOverrideList added in v1.99.0

func (s *InstancePatchState) SetInstallOverrideList(v string) *InstancePatchState

SetInstallOverrideList sets the InstallOverrideList field's value.

func (*InstancePatchState) SetInstalledCount added in v1.6.4

func (s *InstancePatchState) SetInstalledCount(v int64) *InstancePatchState

SetInstalledCount sets the InstalledCount field's value.

func (*InstancePatchState) SetInstalledOtherCount added in v1.6.4

func (s *InstancePatchState) SetInstalledOtherCount(v int64) *InstancePatchState

SetInstalledOtherCount sets the InstalledOtherCount field's value.

func (*InstancePatchState) SetInstalledRejectedCount added in v1.99.0

func (s *InstancePatchState) SetInstalledRejectedCount(v int64) *InstancePatchState

SetInstalledRejectedCount sets the InstalledRejectedCount field's value.

func (*InstancePatchState) SetInstanceId added in v1.6.4

func (s *InstancePatchState) SetInstanceId(v string) *InstancePatchState

SetInstanceId sets the InstanceId field's value.

func (*InstancePatchState) SetMissingCount added in v1.6.4

func (s *InstancePatchState) SetMissingCount(v int64) *InstancePatchState

SetMissingCount sets the MissingCount field's value.

func (*InstancePatchState) SetNotApplicableCount added in v1.6.4

func (s *InstancePatchState) SetNotApplicableCount(v int64) *InstancePatchState

SetNotApplicableCount sets the NotApplicableCount field's value.

func (*InstancePatchState) SetOperation added in v1.6.4

func (s *InstancePatchState) SetOperation(v string) *InstancePatchState

SetOperation sets the Operation field's value.

func (*InstancePatchState) SetOperationEndTime added in v1.6.4

func (s *InstancePatchState) SetOperationEndTime(v time.Time) *InstancePatchState

SetOperationEndTime sets the OperationEndTime field's value.

func (*InstancePatchState) SetOperationStartTime added in v1.6.4

func (s *InstancePatchState) SetOperationStartTime(v time.Time) *InstancePatchState

SetOperationStartTime sets the OperationStartTime field's value.

func (*InstancePatchState) SetOwnerInformation added in v1.6.4

func (s *InstancePatchState) SetOwnerInformation(v string) *InstancePatchState

SetOwnerInformation sets the OwnerInformation field's value.

func (*InstancePatchState) SetPatchGroup added in v1.6.4

func (s *InstancePatchState) SetPatchGroup(v string) *InstancePatchState

SetPatchGroup sets the PatchGroup field's value.

func (*InstancePatchState) SetSnapshotId added in v1.6.4

func (s *InstancePatchState) SetSnapshotId(v string) *InstancePatchState

SetSnapshotId sets the SnapshotId field's value.

func (*InstancePatchState) SetUnreportedNotApplicableCount added in v1.99.0

func (s *InstancePatchState) SetUnreportedNotApplicableCount(v int64) *InstancePatchState

SetUnreportedNotApplicableCount sets the UnreportedNotApplicableCount field's value.

func (InstancePatchState) String added in v1.6.4

func (s InstancePatchState) String() string

String returns the string representation

type InstancePatchStateFilter added in v1.6.4

type InstancePatchStateFilter struct {

	// The key for the filter. Supported values are FailedCount, InstalledCount,
	// InstalledOtherCount, MissingCount and NotApplicableCount.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The type of comparison that should be performed for the value: Equal, NotEqual,
	// LessThan or GreaterThan.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"InstancePatchStateOperatorType"`

	// The value for the filter, must be an integer greater than or equal to 0.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the information returned by the API.

func (InstancePatchStateFilter) GoString added in v1.6.4

func (s InstancePatchStateFilter) GoString() string

GoString returns the string representation

func (*InstancePatchStateFilter) SetKey added in v1.6.4

SetKey sets the Key field's value.

func (*InstancePatchStateFilter) SetType added in v1.6.4

SetType sets the Type field's value.

func (*InstancePatchStateFilter) SetValues added in v1.6.4

SetValues sets the Values field's value.

func (InstancePatchStateFilter) String added in v1.6.4

func (s InstancePatchStateFilter) String() string

String returns the string representation

func (*InstancePatchStateFilter) Validate added in v1.6.4

func (s *InstancePatchStateFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryAggregator added in v1.12.27

type InventoryAggregator struct {

	// Nested aggregators to further refine aggregation for an inventory type.
	Aggregators []*InventoryAggregator `min:"1" type:"list"`

	// The inventory type and attribute name for aggregation.
	Expression *string `min:"1" type:"string"`

	// A user-defined set of one or more filters on which to aggregate inventory
	// data. Groups return a count of resources that match and don't match the specified
	// criteria.
	Groups []*InventoryGroup `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Specifies the inventory type and attribute for the aggregation execution.

func (InventoryAggregator) GoString added in v1.12.27

func (s InventoryAggregator) GoString() string

GoString returns the string representation

func (*InventoryAggregator) SetAggregators added in v1.12.27

SetAggregators sets the Aggregators field's value.

func (*InventoryAggregator) SetExpression added in v1.12.27

func (s *InventoryAggregator) SetExpression(v string) *InventoryAggregator

SetExpression sets the Expression field's value.

func (*InventoryAggregator) SetGroups added in v1.99.0

SetGroups sets the Groups field's value.

func (InventoryAggregator) String added in v1.12.27

func (s InventoryAggregator) String() string

String returns the string representation

func (*InventoryAggregator) Validate added in v1.12.27

func (s *InventoryAggregator) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryDeletionStatusItem added in v1.13.33

type InventoryDeletionStatusItem struct {

	// The deletion ID returned by the DeleteInventory action.
	DeletionId *string `type:"string"`

	// The UTC timestamp when the delete operation started.
	DeletionStartTime *time.Time `type:"timestamp"`

	// Information about the delete operation. For more information about this summary,
	// see Understanding the Delete Inventory Summary (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete)
	// in the AWS Systems Manager User Guide.
	DeletionSummary *InventoryDeletionSummary `type:"structure"`

	// The status of the operation. Possible values are InProgress and Complete.
	LastStatus *string `type:"string" enum:"InventoryDeletionStatus"`

	// Information about the status.
	LastStatusMessage *string `type:"string"`

	// The UTC timestamp of when the last status report.
	LastStatusUpdateTime *time.Time `type:"timestamp"`

	// The name of the inventory data type.
	TypeName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Status information returned by the DeleteInventory action.

func (InventoryDeletionStatusItem) GoString added in v1.13.33

func (s InventoryDeletionStatusItem) GoString() string

GoString returns the string representation

func (*InventoryDeletionStatusItem) SetDeletionId added in v1.13.33

SetDeletionId sets the DeletionId field's value.

func (*InventoryDeletionStatusItem) SetDeletionStartTime added in v1.13.33

SetDeletionStartTime sets the DeletionStartTime field's value.

func (*InventoryDeletionStatusItem) SetDeletionSummary added in v1.13.33

SetDeletionSummary sets the DeletionSummary field's value.

func (*InventoryDeletionStatusItem) SetLastStatus added in v1.13.33

SetLastStatus sets the LastStatus field's value.

func (*InventoryDeletionStatusItem) SetLastStatusMessage added in v1.13.33

SetLastStatusMessage sets the LastStatusMessage field's value.

func (*InventoryDeletionStatusItem) SetLastStatusUpdateTime added in v1.13.33

func (s *InventoryDeletionStatusItem) SetLastStatusUpdateTime(v time.Time) *InventoryDeletionStatusItem

SetLastStatusUpdateTime sets the LastStatusUpdateTime field's value.

func (*InventoryDeletionStatusItem) SetTypeName added in v1.13.33

SetTypeName sets the TypeName field's value.

func (InventoryDeletionStatusItem) String added in v1.13.33

String returns the string representation

type InventoryDeletionSummary added in v1.13.33

type InventoryDeletionSummary struct {

	// Remaining number of items to delete.
	RemainingCount *int64 `type:"integer"`

	// A list of counts and versions for deleted items.
	SummaryItems []*InventoryDeletionSummaryItem `type:"list"`

	// The total number of items to delete. This count does not change during the
	// delete operation.
	TotalCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about the delete operation.

func (InventoryDeletionSummary) GoString added in v1.13.33

func (s InventoryDeletionSummary) GoString() string

GoString returns the string representation

func (*InventoryDeletionSummary) SetRemainingCount added in v1.13.33

func (s *InventoryDeletionSummary) SetRemainingCount(v int64) *InventoryDeletionSummary

SetRemainingCount sets the RemainingCount field's value.

func (*InventoryDeletionSummary) SetSummaryItems added in v1.13.33

SetSummaryItems sets the SummaryItems field's value.

func (*InventoryDeletionSummary) SetTotalCount added in v1.13.33

SetTotalCount sets the TotalCount field's value.

func (InventoryDeletionSummary) String added in v1.13.33

func (s InventoryDeletionSummary) String() string

String returns the string representation

type InventoryDeletionSummaryItem added in v1.13.33

type InventoryDeletionSummaryItem struct {

	// A count of the number of deleted items.
	Count *int64 `type:"integer"`

	// The remaining number of items to delete.
	RemainingCount *int64 `type:"integer"`

	// The inventory type version.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Either a count, remaining count, or a version number in a delete inventory summary.

func (InventoryDeletionSummaryItem) GoString added in v1.13.33

func (s InventoryDeletionSummaryItem) GoString() string

GoString returns the string representation

func (*InventoryDeletionSummaryItem) SetCount added in v1.13.33

SetCount sets the Count field's value.

func (*InventoryDeletionSummaryItem) SetRemainingCount added in v1.13.33

SetRemainingCount sets the RemainingCount field's value.

func (*InventoryDeletionSummaryItem) SetVersion added in v1.13.33

SetVersion sets the Version field's value.

func (InventoryDeletionSummaryItem) String added in v1.13.33

String returns the string representation

type InventoryFilter added in v1.5.13

type InventoryFilter struct {

	// The name of the filter key.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The type of filter. Valid values include the following: "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
	Type *string `type:"string" enum:"InventoryQueryOperatorType"`

	// Inventory filter values. Example: inventory filter where instance IDs are
	// specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g,
	// i-1a2b3c4d5e6,Type=Equal
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

One or more filters. Use a filter to return a more specific list of results.

func (InventoryFilter) GoString added in v1.5.13

func (s InventoryFilter) GoString() string

GoString returns the string representation

func (*InventoryFilter) SetKey added in v1.5.13

func (s *InventoryFilter) SetKey(v string) *InventoryFilter

SetKey sets the Key field's value.

func (*InventoryFilter) SetType added in v1.5.13

func (s *InventoryFilter) SetType(v string) *InventoryFilter

SetType sets the Type field's value.

func (*InventoryFilter) SetValues added in v1.5.13

func (s *InventoryFilter) SetValues(v []*string) *InventoryFilter

SetValues sets the Values field's value.

func (InventoryFilter) String added in v1.5.13

func (s InventoryFilter) String() string

String returns the string representation

func (*InventoryFilter) Validate added in v1.5.13

func (s *InventoryFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryGroup added in v1.99.0

type InventoryGroup struct {

	// Filters define the criteria for the group. The matchingCount field displays
	// the number of resources that match the criteria. The notMatchingCount field
	// displays the number of resources that don't match the criteria.
	//
	// Filters is a required field
	Filters []*InventoryFilter `min:"1" type:"list" required:"true"`

	// The name of the group.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

func (InventoryGroup) GoString added in v1.99.0

func (s InventoryGroup) GoString() string

GoString returns the string representation

func (*InventoryGroup) SetFilters added in v1.99.0

func (s *InventoryGroup) SetFilters(v []*InventoryFilter) *InventoryGroup

SetFilters sets the Filters field's value.

func (*InventoryGroup) SetName added in v1.99.0

func (s *InventoryGroup) SetName(v string) *InventoryGroup

SetName sets the Name field's value.

func (InventoryGroup) String added in v1.99.0

func (s InventoryGroup) String() string

String returns the string representation

func (*InventoryGroup) Validate added in v1.99.0

func (s *InventoryGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryItem added in v1.5.13

type InventoryItem struct {

	// The time the inventory information was collected.
	//
	// CaptureTime is a required field
	CaptureTime *string `type:"string" required:"true"`

	// The inventory data of the inventory type.
	Content []map[string]*string `type:"list"`

	// MD5 hash of the inventory item type contents. The content hash is used to
	// determine whether to update inventory information. The PutInventory API does
	// not update the inventory item type contents if the MD5 hash has not changed
	// since last update.
	ContentHash *string `type:"string"`

	// A map of associated properties for a specified inventory type. For example,
	// with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType
	// properties of the AWS:ComplianceItem type.
	Context map[string]*string `type:"map"`

	// The schema version for the inventory item.
	//
	// SchemaVersion is a required field
	SchemaVersion *string `type:"string" required:"true"`

	// The name of the inventory type. Default inventory item type names start with
	// AWS. Custom inventory type names will start with Custom. Default inventory
	// item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation,
	// AWS:Network, and AWS:WindowsUpdate.
	//
	// TypeName is a required field
	TypeName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information collected from managed instances based on your inventory policy document

func (InventoryItem) GoString added in v1.5.13

func (s InventoryItem) GoString() string

GoString returns the string representation

func (*InventoryItem) SetCaptureTime added in v1.5.13

func (s *InventoryItem) SetCaptureTime(v string) *InventoryItem

SetCaptureTime sets the CaptureTime field's value.

func (*InventoryItem) SetContent added in v1.5.13

func (s *InventoryItem) SetContent(v []map[string]*string) *InventoryItem

SetContent sets the Content field's value.

func (*InventoryItem) SetContentHash added in v1.5.13

func (s *InventoryItem) SetContentHash(v string) *InventoryItem

SetContentHash sets the ContentHash field's value.

func (*InventoryItem) SetContext added in v1.10.25

func (s *InventoryItem) SetContext(v map[string]*string) *InventoryItem

SetContext sets the Context field's value.

func (*InventoryItem) SetSchemaVersion added in v1.5.13

func (s *InventoryItem) SetSchemaVersion(v string) *InventoryItem

SetSchemaVersion sets the SchemaVersion field's value.

func (*InventoryItem) SetTypeName added in v1.5.13

func (s *InventoryItem) SetTypeName(v string) *InventoryItem

SetTypeName sets the TypeName field's value.

func (InventoryItem) String added in v1.5.13

func (s InventoryItem) String() string

String returns the string representation

func (*InventoryItem) Validate added in v1.5.13

func (s *InventoryItem) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InventoryItemAttribute added in v1.5.13

type InventoryItemAttribute struct {

	// The data type of the inventory item attribute.
	//
	// DataType is a required field
	DataType *string `type:"string" required:"true" enum:"InventoryAttributeDataType"`

	// Name of the inventory item attribute.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Attributes are the entries within the inventory item content. It contains name and value.

func (InventoryItemAttribute) GoString added in v1.5.13

func (s InventoryItemAttribute) GoString() string

GoString returns the string representation

func (*InventoryItemAttribute) SetDataType added in v1.5.13

SetDataType sets the DataType field's value.

func (*InventoryItemAttribute) SetName added in v1.5.13

SetName sets the Name field's value.

func (InventoryItemAttribute) String added in v1.5.13

func (s InventoryItemAttribute) String() string

String returns the string representation

type InventoryItemSchema added in v1.5.13

type InventoryItemSchema struct {

	// The schema attributes for inventory. This contains data type and attribute
	// name.
	//
	// Attributes is a required field
	Attributes []*InventoryItemAttribute `min:"1" type:"list" required:"true"`

	// The alias name of the inventory type. The alias name is used for display
	// purposes.
	DisplayName *string `type:"string"`

	// The name of the inventory type. Default inventory item type names start with
	// AWS. Custom inventory type names will start with Custom. Default inventory
	// item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation,
	// AWS:Network, and AWS:WindowsUpdate.
	//
	// TypeName is a required field
	TypeName *string `min:"1" type:"string" required:"true"`

	// The schema version for the inventory item.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

The inventory item schema definition. Users can use this to compose inventory query filters.

func (InventoryItemSchema) GoString added in v1.5.13

func (s InventoryItemSchema) GoString() string

GoString returns the string representation

func (*InventoryItemSchema) SetAttributes added in v1.5.13

SetAttributes sets the Attributes field's value.

func (*InventoryItemSchema) SetDisplayName added in v1.12.27

func (s *InventoryItemSchema) SetDisplayName(v string) *InventoryItemSchema

SetDisplayName sets the DisplayName field's value.

func (*InventoryItemSchema) SetTypeName added in v1.5.13

func (s *InventoryItemSchema) SetTypeName(v string) *InventoryItemSchema

SetTypeName sets the TypeName field's value.

func (*InventoryItemSchema) SetVersion added in v1.5.13

SetVersion sets the Version field's value.

func (InventoryItemSchema) String added in v1.5.13

func (s InventoryItemSchema) String() string

String returns the string representation

type InventoryResultEntity added in v1.5.13

type InventoryResultEntity struct {

	// The data section in the inventory result entity JSON.
	Data map[string]*InventoryResultItem `type:"map"`

	// ID of the inventory result entity. For example, for managed instance inventory
	// the result will be the managed instance ID. For EC2 instance inventory, the
	// result will be the instance ID.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

Inventory query results.

func (InventoryResultEntity) GoString added in v1.5.13

func (s InventoryResultEntity) GoString() string

GoString returns the string representation

func (*InventoryResultEntity) SetData added in v1.5.13

SetData sets the Data field's value.

func (*InventoryResultEntity) SetId added in v1.5.13

SetId sets the Id field's value.

func (InventoryResultEntity) String added in v1.5.13

func (s InventoryResultEntity) String() string

String returns the string representation

type InventoryResultItem added in v1.5.13

type InventoryResultItem struct {

	// The time inventory item data was captured.
	CaptureTime *string `type:"string"`

	// Contains all the inventory data of the item type. Results include attribute
	// names and values.
	//
	// Content is a required field
	Content []map[string]*string `type:"list" required:"true"`

	// MD5 hash of the inventory item type contents. The content hash is used to
	// determine whether to update inventory information. The PutInventory API does
	// not update the inventory item type contents if the MD5 hash has not changed
	// since last update.
	ContentHash *string `type:"string"`

	// The schema version for the inventory result item/
	//
	// SchemaVersion is a required field
	SchemaVersion *string `type:"string" required:"true"`

	// The name of the inventory result item type.
	//
	// TypeName is a required field
	TypeName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The inventory result item.

func (InventoryResultItem) GoString added in v1.5.13

func (s InventoryResultItem) GoString() string

GoString returns the string representation

func (*InventoryResultItem) SetCaptureTime added in v1.5.13

func (s *InventoryResultItem) SetCaptureTime(v string) *InventoryResultItem

SetCaptureTime sets the CaptureTime field's value.

func (*InventoryResultItem) SetContent added in v1.5.13

func (s *InventoryResultItem) SetContent(v []map[string]*string) *InventoryResultItem

SetContent sets the Content field's value.

func (*InventoryResultItem) SetContentHash added in v1.5.13

func (s *InventoryResultItem) SetContentHash(v string) *InventoryResultItem

SetContentHash sets the ContentHash field's value.

func (*InventoryResultItem) SetSchemaVersion added in v1.5.13

func (s *InventoryResultItem) SetSchemaVersion(v string) *InventoryResultItem

SetSchemaVersion sets the SchemaVersion field's value.

func (*InventoryResultItem) SetTypeName added in v1.5.13

func (s *InventoryResultItem) SetTypeName(v string) *InventoryResultItem

SetTypeName sets the TypeName field's value.

func (InventoryResultItem) String added in v1.5.13

func (s InventoryResultItem) String() string

String returns the string representation

type LabelParameterVersionInput added in v1.99.0

type LabelParameterVersionInput struct {

	// One or more labels to attach to the specified parameter version.
	//
	// Labels is a required field
	Labels []*string `min:"1" type:"list" required:"true"`

	// The parameter name on which you want to attach one or more labels.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// 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 `type:"long"`
	// contains filtered or unexported fields
}

func (LabelParameterVersionInput) GoString added in v1.99.0

func (s LabelParameterVersionInput) GoString() string

GoString returns the string representation

func (*LabelParameterVersionInput) SetLabels added in v1.99.0

SetLabels sets the Labels field's value.

func (*LabelParameterVersionInput) SetName added in v1.99.0

SetName sets the Name field's value.

func (*LabelParameterVersionInput) SetParameterVersion added in v1.99.0

func (s *LabelParameterVersionInput) SetParameterVersion(v int64) *LabelParameterVersionInput

SetParameterVersion sets the ParameterVersion field's value.

func (LabelParameterVersionInput) String added in v1.99.0

String returns the string representation

func (*LabelParameterVersionInput) Validate added in v1.99.0

func (s *LabelParameterVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LabelParameterVersionOutput added in v1.99.0

type LabelParameterVersionOutput struct {

	// The label does not meet the requirements. For information about parameter
	// label requirements, see Labeling Parameters (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html)
	// in the AWS Systems Manager User Guide.
	InvalidLabels []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (LabelParameterVersionOutput) GoString added in v1.99.0

func (s LabelParameterVersionOutput) GoString() string

GoString returns the string representation

func (*LabelParameterVersionOutput) SetInvalidLabels added in v1.99.0

SetInvalidLabels sets the InvalidLabels field's value.

func (LabelParameterVersionOutput) String added in v1.99.0

String returns the string representation

type ListAssociationVersionsInput added in v1.10.30

type ListAssociationVersionsInput struct {

	// The association ID for which you want to view all versions.
	//
	// AssociationId is a required field
	AssociationId *string `type:"string" required:"true"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAssociationVersionsInput) GoString added in v1.10.30

func (s ListAssociationVersionsInput) GoString() string

GoString returns the string representation

func (*ListAssociationVersionsInput) SetAssociationId added in v1.10.30

SetAssociationId sets the AssociationId field's value.

func (*ListAssociationVersionsInput) SetMaxResults added in v1.10.30

SetMaxResults sets the MaxResults field's value.

func (*ListAssociationVersionsInput) SetNextToken added in v1.10.30

SetNextToken sets the NextToken field's value.

func (ListAssociationVersionsInput) String added in v1.10.30

String returns the string representation

func (*ListAssociationVersionsInput) Validate added in v1.10.30

func (s *ListAssociationVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssociationVersionsOutput added in v1.10.30

type ListAssociationVersionsOutput struct {

	// Information about all versions of the association for the specified association
	// ID.
	AssociationVersions []*AssociationVersionInfo `min:"1" type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAssociationVersionsOutput) GoString added in v1.10.30

GoString returns the string representation

func (*ListAssociationVersionsOutput) SetAssociationVersions added in v1.10.30

SetAssociationVersions sets the AssociationVersions field's value.

func (*ListAssociationVersionsOutput) SetNextToken added in v1.10.30

SetNextToken sets the NextToken field's value.

func (ListAssociationVersionsOutput) String added in v1.10.30

String returns the string representation

type ListAssociationsInput

type ListAssociationsInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	AssociationFilterList []*AssociationFilter `min:"1" type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAssociationsInput) GoString added in v0.6.5

func (s ListAssociationsInput) GoString() string

GoString returns the string representation

func (*ListAssociationsInput) SetAssociationFilterList added in v1.5.0

func (s *ListAssociationsInput) SetAssociationFilterList(v []*AssociationFilter) *ListAssociationsInput

SetAssociationFilterList sets the AssociationFilterList field's value.

func (*ListAssociationsInput) SetMaxResults added in v1.5.0

func (s *ListAssociationsInput) SetMaxResults(v int64) *ListAssociationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssociationsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (ListAssociationsInput) String added in v0.6.5

func (s ListAssociationsInput) String() string

String returns the string representation

func (*ListAssociationsInput) Validate added in v1.1.21

func (s *ListAssociationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssociationsOutput

type ListAssociationsOutput struct {

	// The associations.
	Associations []*Association `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (ListAssociationsOutput) GoString added in v0.6.5

func (s ListAssociationsOutput) GoString() string

GoString returns the string representation

func (*ListAssociationsOutput) SetAssociations added in v1.5.0

func (s *ListAssociationsOutput) SetAssociations(v []*Association) *ListAssociationsOutput

SetAssociations sets the Associations field's value.

func (*ListAssociationsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (ListAssociationsOutput) String added in v0.6.5

func (s ListAssociationsOutput) String() string

String returns the string representation

type ListCommandInvocationsInput added in v0.9.17

type ListCommandInvocationsInput struct {

	// (Optional) The invocations for a specific command ID.
	CommandId *string `min:"36" type:"string"`

	// (Optional) If set this returns the response of the command executions and
	// any command output. By default this is set to False.
	Details *bool `type:"boolean"`

	// (Optional) One or more filters. Use a filter to return a more specific list
	// of results.
	Filters []*CommandFilter `min:"1" type:"list"`

	// (Optional) The command execution details for a specific instance ID.
	InstanceId *string `type:"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 *int64 `min:"1" type:"integer"`

	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCommandInvocationsInput) GoString added in v0.9.17

func (s ListCommandInvocationsInput) GoString() string

GoString returns the string representation

func (*ListCommandInvocationsInput) SetCommandId added in v1.5.0

SetCommandId sets the CommandId field's value.

func (*ListCommandInvocationsInput) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*ListCommandInvocationsInput) SetFilters added in v1.5.0

SetFilters sets the Filters field's value.

func (*ListCommandInvocationsInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*ListCommandInvocationsInput) SetMaxResults added in v1.5.0

SetMaxResults sets the MaxResults field's value.

func (*ListCommandInvocationsInput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (ListCommandInvocationsInput) String added in v0.9.17

String returns the string representation

func (*ListCommandInvocationsInput) Validate added in v1.1.21

func (s *ListCommandInvocationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCommandInvocationsOutput added in v0.9.17

type ListCommandInvocationsOutput struct {

	// (Optional) A list of all invocations.
	CommandInvocations []*CommandInvocation `type:"list"`

	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCommandInvocationsOutput) GoString added in v0.9.17

func (s ListCommandInvocationsOutput) GoString() string

GoString returns the string representation

func (*ListCommandInvocationsOutput) SetCommandInvocations added in v1.5.0

SetCommandInvocations sets the CommandInvocations field's value.

func (*ListCommandInvocationsOutput) SetNextToken added in v1.5.0

SetNextToken sets the NextToken field's value.

func (ListCommandInvocationsOutput) String added in v0.9.17

String returns the string representation

type ListCommandsInput added in v0.9.17

type ListCommandsInput struct {

	// (Optional) If provided, lists only the specified command.
	CommandId *string `min:"36" type:"string"`

	// (Optional) One or more filters. Use a filter to return a more specific list
	// of results.
	Filters []*CommandFilter `min:"1" type:"list"`

	// (Optional) Lists commands issued against this instance ID.
	InstanceId *string `type:"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 *int64 `min:"1" type:"integer"`

	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCommandsInput) GoString added in v0.9.17

func (s ListCommandsInput) GoString() string

GoString returns the string representation

func (*ListCommandsInput) SetCommandId added in v1.5.0

func (s *ListCommandsInput) SetCommandId(v string) *ListCommandsInput

SetCommandId sets the CommandId field's value.

func (*ListCommandsInput) SetFilters added in v1.5.0

func (s *ListCommandsInput) SetFilters(v []*CommandFilter) *ListCommandsInput

SetFilters sets the Filters field's value.

func (*ListCommandsInput) SetInstanceId added in v1.5.0

func (s *ListCommandsInput) SetInstanceId(v string) *ListCommandsInput

SetInstanceId sets the InstanceId field's value.

func (*ListCommandsInput) SetMaxResults added in v1.5.0

func (s *ListCommandsInput) SetMaxResults(v int64) *ListCommandsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCommandsInput) SetNextToken added in v1.5.0

func (s *ListCommandsInput) SetNextToken(v string) *ListCommandsInput

SetNextToken sets the NextToken field's value.

func (ListCommandsInput) String added in v0.9.17

func (s ListCommandsInput) String() string

String returns the string representation

func (*ListCommandsInput) Validate added in v1.1.21

func (s *ListCommandsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCommandsOutput added in v0.9.17

type ListCommandsOutput struct {

	// (Optional) The list of commands requested by the user.
	Commands []*Command `type:"list"`

	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCommandsOutput) GoString added in v0.9.17

func (s ListCommandsOutput) GoString() string

GoString returns the string representation

func (*ListCommandsOutput) SetCommands added in v1.5.0

func (s *ListCommandsOutput) SetCommands(v []*Command) *ListCommandsOutput

SetCommands sets the Commands field's value.

func (*ListCommandsOutput) SetNextToken added in v1.5.0

func (s *ListCommandsOutput) SetNextToken(v string) *ListCommandsOutput

SetNextToken sets the NextToken field's value.

func (ListCommandsOutput) String added in v0.9.17

func (s ListCommandsOutput) String() string

String returns the string representation

type ListComplianceItemsInput added in v1.10.25

type ListComplianceItemsInput struct {

	// One or more compliance filters. Use a filter to return a more specific list
	// of results.
	Filters []*ComplianceStringFilter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`

	// The ID for the resources from which to get compliance information. Currently,
	// you can only specify one resource ID.
	ResourceIds []*string `min:"1" type:"list"`

	// The type of resource from which to get compliance information. Currently,
	// the only supported resource type is ManagedInstance.
	ResourceTypes []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListComplianceItemsInput) GoString added in v1.10.25

func (s ListComplianceItemsInput) GoString() string

GoString returns the string representation

func (*ListComplianceItemsInput) SetFilters added in v1.10.25

SetFilters sets the Filters field's value.

func (*ListComplianceItemsInput) SetMaxResults added in v1.10.25

SetMaxResults sets the MaxResults field's value.

func (*ListComplianceItemsInput) SetNextToken added in v1.10.25

SetNextToken sets the NextToken field's value.

func (*ListComplianceItemsInput) SetResourceIds added in v1.10.25

func (s *ListComplianceItemsInput) SetResourceIds(v []*string) *ListComplianceItemsInput

SetResourceIds sets the ResourceIds field's value.

func (*ListComplianceItemsInput) SetResourceTypes added in v1.10.25

func (s *ListComplianceItemsInput) SetResourceTypes(v []*string) *ListComplianceItemsInput

SetResourceTypes sets the ResourceTypes field's value.

func (ListComplianceItemsInput) String added in v1.10.25

func (s ListComplianceItemsInput) String() string

String returns the string representation

func (*ListComplianceItemsInput) Validate added in v1.10.25

func (s *ListComplianceItemsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComplianceItemsOutput added in v1.10.25

type ListComplianceItemsOutput struct {

	// A list of compliance information for the specified resource ID.
	ComplianceItems []*ComplianceItem `type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListComplianceItemsOutput) GoString added in v1.10.25

func (s ListComplianceItemsOutput) GoString() string

GoString returns the string representation

func (*ListComplianceItemsOutput) SetComplianceItems added in v1.10.25

SetComplianceItems sets the ComplianceItems field's value.

func (*ListComplianceItemsOutput) SetNextToken added in v1.10.25

SetNextToken sets the NextToken field's value.

func (ListComplianceItemsOutput) String added in v1.10.25

func (s ListComplianceItemsOutput) String() string

String returns the string representation

type ListComplianceSummariesInput added in v1.10.25

type ListComplianceSummariesInput struct {

	// One or more compliance or inventory filters. Use a filter to return a more
	// specific list of results.
	Filters []*ComplianceStringFilter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListComplianceSummariesInput) GoString added in v1.10.25

func (s ListComplianceSummariesInput) GoString() string

GoString returns the string representation

func (*ListComplianceSummariesInput) SetFilters added in v1.10.25

SetFilters sets the Filters field's value.

func (*ListComplianceSummariesInput) SetMaxResults added in v1.10.25

SetMaxResults sets the MaxResults field's value.

func (*ListComplianceSummariesInput) SetNextToken added in v1.10.25

SetNextToken sets the NextToken field's value.

func (ListComplianceSummariesInput) String added in v1.10.25

String returns the string representation

func (*ListComplianceSummariesInput) Validate added in v1.10.25

func (s *ListComplianceSummariesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListComplianceSummariesOutput added in v1.10.25

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 []*ComplianceSummaryItem `type:"list"`

	// The token for the next set of items to return. Use this token to get the
	// next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListComplianceSummariesOutput) GoString added in v1.10.25

GoString returns the string representation

func (*ListComplianceSummariesOutput) SetComplianceSummaryItems added in v1.10.25

SetComplianceSummaryItems sets the ComplianceSummaryItems field's value.

func (*ListComplianceSummariesOutput) SetNextToken added in v1.10.25

SetNextToken sets the NextToken field's value.

func (ListComplianceSummariesOutput) String added in v1.10.25

String returns the string representation

type ListDocumentVersionsInput added in v1.5.13

type ListDocumentVersionsInput struct {

	// The maximum number of items to return for this call. The call also returns
	// a token that you can specify in a subsequent call to get the next set of
	// results.
	MaxResults *int64 `min:"1" type:"integer"`

	// The name of the document about which you want version information.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentVersionsInput) GoString added in v1.5.13

func (s ListDocumentVersionsInput) GoString() string

GoString returns the string representation

func (*ListDocumentVersionsInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentVersionsInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*ListDocumentVersionsInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (ListDocumentVersionsInput) String added in v1.5.13

func (s ListDocumentVersionsInput) String() string

String returns the string representation

func (*ListDocumentVersionsInput) Validate added in v1.5.13

func (s *ListDocumentVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDocumentVersionsOutput added in v1.5.13

type ListDocumentVersionsOutput struct {

	// The document versions.
	DocumentVersions []*DocumentVersionInfo `min:"1" type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentVersionsOutput) GoString added in v1.5.13

func (s ListDocumentVersionsOutput) GoString() string

GoString returns the string representation

func (*ListDocumentVersionsOutput) SetDocumentVersions added in v1.5.13

SetDocumentVersions sets the DocumentVersions field's value.

func (*ListDocumentVersionsOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (ListDocumentVersionsOutput) String added in v1.5.13

String returns the string representation

type ListDocumentsInput

type ListDocumentsInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	DocumentFilterList []*DocumentFilter `min:"1" type:"list"`

	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*DocumentKeyValuesFilter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentsInput) GoString added in v0.6.5

func (s ListDocumentsInput) GoString() string

GoString returns the string representation

func (*ListDocumentsInput) SetDocumentFilterList added in v1.5.0

func (s *ListDocumentsInput) SetDocumentFilterList(v []*DocumentFilter) *ListDocumentsInput

SetDocumentFilterList sets the DocumentFilterList field's value.

func (*ListDocumentsInput) SetFilters added in v1.12.4

SetFilters sets the Filters field's value.

func (*ListDocumentsInput) SetMaxResults added in v1.5.0

func (s *ListDocumentsInput) SetMaxResults(v int64) *ListDocumentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentsInput) SetNextToken added in v1.5.0

func (s *ListDocumentsInput) SetNextToken(v string) *ListDocumentsInput

SetNextToken sets the NextToken field's value.

func (ListDocumentsInput) String added in v0.6.5

func (s ListDocumentsInput) String() string

String returns the string representation

func (*ListDocumentsInput) Validate added in v1.1.21

func (s *ListDocumentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDocumentsOutput

type ListDocumentsOutput struct {

	// The names of the Systems Manager documents.
	DocumentIdentifiers []*DocumentIdentifier `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentsOutput) GoString added in v0.6.5

func (s ListDocumentsOutput) GoString() string

GoString returns the string representation

func (*ListDocumentsOutput) SetDocumentIdentifiers added in v1.5.0

func (s *ListDocumentsOutput) SetDocumentIdentifiers(v []*DocumentIdentifier) *ListDocumentsOutput

SetDocumentIdentifiers sets the DocumentIdentifiers field's value.

func (*ListDocumentsOutput) SetNextToken added in v1.5.0

func (s *ListDocumentsOutput) SetNextToken(v string) *ListDocumentsOutput

SetNextToken sets the NextToken field's value.

func (ListDocumentsOutput) String added in v0.6.5

func (s ListDocumentsOutput) String() string

String returns the string representation

type ListInventoryEntriesInput added in v1.5.13

type ListInventoryEntriesInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*InventoryFilter `min:"1" type:"list"`

	// The instance ID for which you want inventory information.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// 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 *int64 `min:"1" type:"integer"`

	// The token for the next set of items to return. (You received this token from
	// a previous call.)
	NextToken *string `type:"string"`

	// The type of inventory item for which you want information.
	//
	// TypeName is a required field
	TypeName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListInventoryEntriesInput) GoString added in v1.5.13

func (s ListInventoryEntriesInput) GoString() string

GoString returns the string representation

func (*ListInventoryEntriesInput) SetFilters added in v1.5.13

SetFilters sets the Filters field's value.

func (*ListInventoryEntriesInput) SetInstanceId added in v1.5.13

SetInstanceId sets the InstanceId field's value.

func (*ListInventoryEntriesInput) SetMaxResults added in v1.5.13

SetMaxResults sets the MaxResults field's value.

func (*ListInventoryEntriesInput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*ListInventoryEntriesInput) SetTypeName added in v1.5.13

SetTypeName sets the TypeName field's value.

func (ListInventoryEntriesInput) String added in v1.5.13

func (s ListInventoryEntriesInput) String() string

String returns the string representation

func (*ListInventoryEntriesInput) Validate added in v1.5.13

func (s *ListInventoryEntriesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListInventoryEntriesOutput added in v1.5.13

type ListInventoryEntriesOutput struct {

	// The time that inventory information was collected for the instance(s).
	CaptureTime *string `type:"string"`

	// A list of inventory items on the instance(s).
	Entries []map[string]*string `type:"list"`

	// The instance ID targeted by the request to query inventory information.
	InstanceId *string `type:"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 `type:"string"`

	// The inventory schema version used by the instance(s).
	SchemaVersion *string `type:"string"`

	// The type of inventory item returned by the request.
	TypeName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListInventoryEntriesOutput) GoString added in v1.5.13

func (s ListInventoryEntriesOutput) GoString() string

GoString returns the string representation

func (*ListInventoryEntriesOutput) SetCaptureTime added in v1.5.13

SetCaptureTime sets the CaptureTime field's value.

func (*ListInventoryEntriesOutput) SetEntries added in v1.5.13

SetEntries sets the Entries field's value.

func (*ListInventoryEntriesOutput) SetInstanceId added in v1.5.13

SetInstanceId sets the InstanceId field's value.

func (*ListInventoryEntriesOutput) SetNextToken added in v1.5.13

SetNextToken sets the NextToken field's value.

func (*ListInventoryEntriesOutput) SetSchemaVersion added in v1.5.13

SetSchemaVersion sets the SchemaVersion field's value.

func (*ListInventoryEntriesOutput) SetTypeName added in v1.5.13

SetTypeName sets the TypeName field's value.

func (ListInventoryEntriesOutput) String added in v1.5.13

String returns the string representation

type ListResourceComplianceSummariesInput added in v1.10.25

type ListResourceComplianceSummariesInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	Filters []*ComplianceStringFilter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListResourceComplianceSummariesInput) GoString added in v1.10.25

GoString returns the string representation

func (*ListResourceComplianceSummariesInput) SetFilters added in v1.10.25

SetFilters sets the Filters field's value.

func (*ListResourceComplianceSummariesInput) SetMaxResults added in v1.10.25

SetMaxResults sets the MaxResults field's value.

func (*ListResourceComplianceSummariesInput) SetNextToken added in v1.10.25

SetNextToken sets the NextToken field's value.

func (ListResourceComplianceSummariesInput) String added in v1.10.25

String returns the string representation

func (*ListResourceComplianceSummariesInput) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type ListResourceComplianceSummariesOutput added in v1.10.25

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 `type:"string"`

	// A summary count for specified or targeted managed instances. Summary count
	// includes information about compliant and non-compliant State Manager associations,
	// patch status, or custom items according to the filter criteria that you specify.
	ResourceComplianceSummaryItems []*ResourceComplianceSummaryItem `type:"list"`
	// contains filtered or unexported fields
}

func (ListResourceComplianceSummariesOutput) GoString added in v1.10.25

GoString returns the string representation

func (*ListResourceComplianceSummariesOutput) SetNextToken added in v1.10.25

SetNextToken sets the NextToken field's value.

func (*ListResourceComplianceSummariesOutput) SetResourceComplianceSummaryItems added in v1.10.25

SetResourceComplianceSummaryItems sets the ResourceComplianceSummaryItems field's value.

func (ListResourceComplianceSummariesOutput) String added in v1.10.25

String returns the string representation

type ListResourceDataSyncInput added in v1.10.5

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 *int64 `min:"1" type:"integer"`

	// A token to start the list. Use this token to get the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListResourceDataSyncInput) GoString added in v1.10.5

func (s ListResourceDataSyncInput) GoString() string

GoString returns the string representation

func (*ListResourceDataSyncInput) SetMaxResults added in v1.10.5

SetMaxResults sets the MaxResults field's value.

func (*ListResourceDataSyncInput) SetNextToken added in v1.10.5

SetNextToken sets the NextToken field's value.

func (ListResourceDataSyncInput) String added in v1.10.5

func (s ListResourceDataSyncInput) String() string

String returns the string representation

func (*ListResourceDataSyncInput) Validate added in v1.10.5

func (s *ListResourceDataSyncInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListResourceDataSyncOutput added in v1.10.5

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 `type:"string"`

	// A list of your current Resource Data Sync configurations and their statuses.
	ResourceDataSyncItems []*ResourceDataSyncItem `type:"list"`
	// contains filtered or unexported fields
}

func (ListResourceDataSyncOutput) GoString added in v1.10.5

func (s ListResourceDataSyncOutput) GoString() string

GoString returns the string representation

func (*ListResourceDataSyncOutput) SetNextToken added in v1.10.5

SetNextToken sets the NextToken field's value.

func (*ListResourceDataSyncOutput) SetResourceDataSyncItems added in v1.10.5

SetResourceDataSyncItems sets the ResourceDataSyncItems field's value.

func (ListResourceDataSyncOutput) String added in v1.10.5

String returns the string representation

type ListTagsForResourceInput added in v1.2.2

type ListTagsForResourceInput struct {

	// The resource ID for which you want to see a list of tags.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// Returns a list of tags for a specific resource type.
	//
	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true" enum:"ResourceTypeForTagging"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.2.2

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*ListTagsForResourceInput) SetResourceType added in v1.5.0

SetResourceType sets the ResourceType field's value.

func (ListTagsForResourceInput) String added in v1.2.2

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.2.2

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.2.2

type ListTagsForResourceOutput struct {

	// A list of tags.
	TagList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.2.2

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (ListTagsForResourceOutput) String added in v1.2.2

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type LoggingInfo added in v1.5.13

type LoggingInfo struct {

	// The name of an Amazon S3 bucket where execution logs are stored .
	//
	// S3BucketName is a required field
	S3BucketName *string `min:"3" type:"string" required:"true"`

	// (Optional) The Amazon S3 bucket subfolder.
	S3KeyPrefix *string `type:"string"`

	// The region where the Amazon S3 bucket is located.
	//
	// S3Region is a required field
	S3Region *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about an Amazon S3 bucket to write instance-level logs to.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

func (LoggingInfo) GoString added in v1.5.13

func (s LoggingInfo) GoString() string

GoString returns the string representation

func (*LoggingInfo) SetS3BucketName added in v1.5.13

func (s *LoggingInfo) SetS3BucketName(v string) *LoggingInfo

SetS3BucketName sets the S3BucketName field's value.

func (*LoggingInfo) SetS3KeyPrefix added in v1.5.13

func (s *LoggingInfo) SetS3KeyPrefix(v string) *LoggingInfo

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*LoggingInfo) SetS3Region added in v1.5.13

func (s *LoggingInfo) SetS3Region(v string) *LoggingInfo

SetS3Region sets the S3Region field's value.

func (LoggingInfo) String added in v1.5.13

func (s LoggingInfo) String() string

String returns the string representation

func (*LoggingInfo) Validate added in v1.5.13

func (s *LoggingInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MaintenanceWindowAutomationParameters added in v1.10.25

type MaintenanceWindowAutomationParameters struct {

	// The version of an Automation document to use during task execution.
	DocumentVersion *string `type:"string"`

	// The parameters for the AUTOMATION task.
	//
	// For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow
	// and UpdateMaintenanceWindowTask.
	//
	// LoggingInfo has been deprecated. To specify an S3 bucket to contain logs,
	// instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	//
	// 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.
	//
	// For AUTOMATION task types, Systems Manager ignores any values specified for
	// these parameters.
	Parameters map[string][]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

The parameters for an AUTOMATION task type.

func (MaintenanceWindowAutomationParameters) GoString added in v1.10.25

GoString returns the string representation

func (*MaintenanceWindowAutomationParameters) SetDocumentVersion added in v1.10.25

SetDocumentVersion sets the DocumentVersion field's value.

func (*MaintenanceWindowAutomationParameters) SetParameters added in v1.10.25

SetParameters sets the Parameters field's value.

func (MaintenanceWindowAutomationParameters) String added in v1.10.25

String returns the string representation

func (*MaintenanceWindowAutomationParameters) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type MaintenanceWindowExecution added in v1.5.13

type MaintenanceWindowExecution struct {

	// The time the execution finished.
	EndTime *time.Time `type:"timestamp"`

	// The time the execution started.
	StartTime *time.Time `type:"timestamp"`

	// The status of the execution.
	Status *string `type:"string" enum:"MaintenanceWindowExecutionStatus"`

	// The details explaining the Status. Only available for certain status values.
	StatusDetails *string `type:"string"`

	// The ID of the maintenance window execution.
	WindowExecutionId *string `min:"36" type:"string"`

	// The ID of the maintenance window.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

Describes the information about an execution of a maintenance window.

func (MaintenanceWindowExecution) GoString added in v1.5.13

func (s MaintenanceWindowExecution) GoString() string

GoString returns the string representation

func (*MaintenanceWindowExecution) SetEndTime added in v1.5.13

SetEndTime sets the EndTime field's value.

func (*MaintenanceWindowExecution) SetStartTime added in v1.5.13

SetStartTime sets the StartTime field's value.

func (*MaintenanceWindowExecution) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (*MaintenanceWindowExecution) SetStatusDetails added in v1.5.13

SetStatusDetails sets the StatusDetails field's value.

func (*MaintenanceWindowExecution) SetWindowExecutionId added in v1.5.13

func (s *MaintenanceWindowExecution) SetWindowExecutionId(v string) *MaintenanceWindowExecution

SetWindowExecutionId sets the WindowExecutionId field's value.

func (*MaintenanceWindowExecution) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (MaintenanceWindowExecution) String added in v1.5.13

String returns the string representation

type MaintenanceWindowExecutionTaskIdentity added in v1.5.13

type MaintenanceWindowExecutionTaskIdentity struct {

	// The time the task execution finished.
	EndTime *time.Time `type:"timestamp"`

	// The time the task execution started.
	StartTime *time.Time `type:"timestamp"`

	// The status of the task execution.
	Status *string `type:"string" enum:"MaintenanceWindowExecutionStatus"`

	// The details explaining the status of the task execution. Only available for
	// certain status values.
	StatusDetails *string `type:"string"`

	// The ARN of the task that ran.
	TaskArn *string `min:"1" type:"string"`

	// The ID of the specific task execution in the maintenance window execution.
	TaskExecutionId *string `min:"36" type:"string"`

	// The type of task that ran.
	TaskType *string `type:"string" enum:"MaintenanceWindowTaskType"`

	// The ID of the maintenance window execution that ran the task.
	WindowExecutionId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

Information about a task execution performed as part of a maintenance window execution.

func (MaintenanceWindowExecutionTaskIdentity) GoString added in v1.5.13

GoString returns the string representation

func (*MaintenanceWindowExecutionTaskIdentity) SetEndTime added in v1.5.13

SetEndTime sets the EndTime field's value.

func (*MaintenanceWindowExecutionTaskIdentity) SetStartTime added in v1.5.13

SetStartTime sets the StartTime field's value.

func (*MaintenanceWindowExecutionTaskIdentity) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (*MaintenanceWindowExecutionTaskIdentity) SetStatusDetails added in v1.5.13

SetStatusDetails sets the StatusDetails field's value.

func (*MaintenanceWindowExecutionTaskIdentity) SetTaskArn added in v1.5.13

SetTaskArn sets the TaskArn field's value.

func (*MaintenanceWindowExecutionTaskIdentity) SetTaskExecutionId added in v1.5.13

SetTaskExecutionId sets the TaskExecutionId field's value.

func (*MaintenanceWindowExecutionTaskIdentity) SetTaskType added in v1.5.13

SetTaskType sets the TaskType field's value.

func (*MaintenanceWindowExecutionTaskIdentity) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (MaintenanceWindowExecutionTaskIdentity) String added in v1.5.13

String returns the string representation

type MaintenanceWindowExecutionTaskInvocationIdentity added in v1.5.13

type MaintenanceWindowExecutionTaskInvocationIdentity struct {

	// The time the invocation finished.
	EndTime *time.Time `type:"timestamp"`

	// The ID of the action performed in the service that actually handled the task
	// invocation. If the task type is RUN_COMMAND, this value is the command ID.
	ExecutionId *string `type:"string"`

	// The ID of the task invocation.
	InvocationId *string `min:"36" type:"string"`

	// User-provided value that was specified when the target was registered with
	// the maintenance window. This was also included in any CloudWatch events raised
	// during the task invocation.
	OwnerInformation *string `min:"1" type:"string" sensitive:"true"`

	// The parameters that were provided for the invocation when it was run.
	Parameters *string `type:"string" sensitive:"true"`

	// The time the invocation started.
	StartTime *time.Time `type:"timestamp"`

	// The status of the task invocation.
	Status *string `type:"string" enum:"MaintenanceWindowExecutionStatus"`

	// The details explaining the status of the task invocation. Only available
	// for certain Status values.
	StatusDetails *string `type:"string"`

	// The ID of the specific task execution in the maintenance window execution.
	TaskExecutionId *string `min:"36" type:"string"`

	// The task type.
	TaskType *string `type:"string" enum:"MaintenanceWindowTaskType"`

	// The ID of the maintenance window execution that ran the task.
	WindowExecutionId *string `min:"36" type:"string"`

	// The ID of the target definition in this maintenance window the invocation
	// was performed for.
	WindowTargetId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the information about a task invocation for a particular target as part of a task execution performed as part of a maintenance window execution.

func (MaintenanceWindowExecutionTaskInvocationIdentity) GoString added in v1.5.13

GoString returns the string representation

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetEndTime added in v1.5.13

SetEndTime sets the EndTime field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetExecutionId added in v1.5.13

SetExecutionId sets the ExecutionId field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetInvocationId added in v1.5.13

SetInvocationId sets the InvocationId field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetOwnerInformation added in v1.5.13

SetOwnerInformation sets the OwnerInformation field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetParameters added in v1.5.13

SetParameters sets the Parameters field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetStartTime added in v1.5.13

SetStartTime sets the StartTime field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetStatus added in v1.5.13

SetStatus sets the Status field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetStatusDetails added in v1.5.13

SetStatusDetails sets the StatusDetails field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetTaskExecutionId added in v1.5.13

SetTaskExecutionId sets the TaskExecutionId field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetTaskType added in v1.10.25

SetTaskType sets the TaskType field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetWindowExecutionId added in v1.5.13

SetWindowExecutionId sets the WindowExecutionId field's value.

func (*MaintenanceWindowExecutionTaskInvocationIdentity) SetWindowTargetId added in v1.5.13

SetWindowTargetId sets the WindowTargetId field's value.

func (MaintenanceWindowExecutionTaskInvocationIdentity) String added in v1.5.13

String returns the string representation

type MaintenanceWindowFilter added in v1.5.13

type MaintenanceWindowFilter struct {

	// The name of the filter.
	Key *string `min:"1" type:"string"`

	// The filter values.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Filter used in the request. Supported filter keys are Name and Enabled.

func (MaintenanceWindowFilter) GoString added in v1.5.13

func (s MaintenanceWindowFilter) GoString() string

GoString returns the string representation

func (*MaintenanceWindowFilter) SetKey added in v1.5.13

SetKey sets the Key field's value.

func (*MaintenanceWindowFilter) SetValues added in v1.5.13

SetValues sets the Values field's value.

func (MaintenanceWindowFilter) String added in v1.5.13

func (s MaintenanceWindowFilter) String() string

String returns the string representation

func (*MaintenanceWindowFilter) Validate added in v1.5.13

func (s *MaintenanceWindowFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MaintenanceWindowIdentity added in v1.5.13

type MaintenanceWindowIdentity struct {

	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int64 `type:"integer"`

	// A description of the maintenance window.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The duration of the maintenance window in hours.
	Duration *int64 `min:"1" type:"integer"`

	// Indicates whether the maintenance window is enabled.
	Enabled *bool `type:"boolean"`

	// The date and time, in ISO-8601 Extended format, for when the maintenance
	// window is scheduled to become inactive.
	EndDate *string `type:"string"`

	// The name of the maintenance window.
	Name *string `min:"3" type:"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 `type:"string"`

	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string `min:"1" type:"string"`

	// The time zone that the scheduled maintenance window executions are based
	// on, in Internet Assigned Numbers Authority (IANA) format.
	ScheduleTimezone *string `type:"string"`

	// The date and time, in ISO-8601 Extended format, for when the maintenance
	// window is scheduled to become active.
	StartDate *string `type:"string"`

	// The ID of the maintenance window.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

Information about the maintenance window.

func (MaintenanceWindowIdentity) GoString added in v1.5.13

func (s MaintenanceWindowIdentity) GoString() string

GoString returns the string representation

func (*MaintenanceWindowIdentity) SetCutoff added in v1.5.13

SetCutoff sets the Cutoff field's value.

func (*MaintenanceWindowIdentity) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*MaintenanceWindowIdentity) SetDuration added in v1.5.13

SetDuration sets the Duration field's value.

func (*MaintenanceWindowIdentity) SetEnabled added in v1.5.13

SetEnabled sets the Enabled field's value.

func (*MaintenanceWindowIdentity) SetEndDate added in v1.99.0

SetEndDate sets the EndDate field's value.

func (*MaintenanceWindowIdentity) SetName added in v1.5.13

SetName sets the Name field's value.

func (*MaintenanceWindowIdentity) SetNextExecutionTime added in v1.99.0

func (s *MaintenanceWindowIdentity) SetNextExecutionTime(v string) *MaintenanceWindowIdentity

SetNextExecutionTime sets the NextExecutionTime field's value.

func (*MaintenanceWindowIdentity) SetSchedule added in v1.99.0

SetSchedule sets the Schedule field's value.

func (*MaintenanceWindowIdentity) SetScheduleTimezone added in v1.99.0

func (s *MaintenanceWindowIdentity) SetScheduleTimezone(v string) *MaintenanceWindowIdentity

SetScheduleTimezone sets the ScheduleTimezone field's value.

func (*MaintenanceWindowIdentity) SetStartDate added in v1.99.0

SetStartDate sets the StartDate field's value.

func (*MaintenanceWindowIdentity) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (MaintenanceWindowIdentity) String added in v1.5.13

func (s MaintenanceWindowIdentity) String() string

String returns the string representation

type MaintenanceWindowIdentityForTarget added in v1.99.0

type MaintenanceWindowIdentityForTarget struct {

	// The name of the maintenance window.
	Name *string `min:"3" type:"string"`

	// The ID of the maintenance window.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

The maintenance window to which the specified target belongs.

func (MaintenanceWindowIdentityForTarget) GoString added in v1.99.0

GoString returns the string representation

func (*MaintenanceWindowIdentityForTarget) SetName added in v1.99.0

SetName sets the Name field's value.

func (*MaintenanceWindowIdentityForTarget) SetWindowId added in v1.99.0

SetWindowId sets the WindowId field's value.

func (MaintenanceWindowIdentityForTarget) String added in v1.99.0

String returns the string representation

type MaintenanceWindowLambdaParameters added in v1.10.25

type MaintenanceWindowLambdaParameters struct {

	// Pass client-specific information to the Lambda function that you are invoking.
	// You can then process the client information in your Lambda function as you
	// choose through the context variable.
	ClientContext *string `min:"1" type:"string"`

	// JSON to provide to your Lambda function as input.
	//
	// Payload is automatically base64 encoded/decoded by the SDK.
	Payload []byte `type:"blob" sensitive:"true"`

	// (Optional) Specify a Lambda function version or alias name. If you specify
	// a function version, the action uses the qualified function ARN to invoke
	// a specific Lambda function. If you specify an alias name, the action uses
	// the alias ARN to invoke the Lambda function version to which the alias points.
	Qualifier *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The parameters for a LAMBDA task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

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.

For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

func (MaintenanceWindowLambdaParameters) GoString added in v1.10.25

GoString returns the string representation

func (*MaintenanceWindowLambdaParameters) SetClientContext added in v1.10.25

SetClientContext sets the ClientContext field's value.

func (*MaintenanceWindowLambdaParameters) SetPayload added in v1.10.25

SetPayload sets the Payload field's value.

func (*MaintenanceWindowLambdaParameters) SetQualifier added in v1.10.25

SetQualifier sets the Qualifier field's value.

func (MaintenanceWindowLambdaParameters) String added in v1.10.25

String returns the string representation

func (*MaintenanceWindowLambdaParameters) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type MaintenanceWindowRunCommandParameters added in v1.10.25

type MaintenanceWindowRunCommandParameters struct {

	// Information about the commands to run.
	Comment *string `type:"string"`

	// The SHA-256 or SHA-1 hash created by the system when the document was created.
	// SHA-1 hashes have been deprecated.
	DocumentHash *string `type:"string"`

	// SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
	DocumentHashType *string `type:"string" enum:"DocumentHashType"`

	// Configurations for sending notifications about command status changes on
	// a per-instance basis.
	NotificationConfig *NotificationConfig `type:"structure"`

	// The name of the Amazon S3 bucket.
	OutputS3BucketName *string `min:"3" type:"string"`

	// The Amazon S3 bucket subfolder.
	OutputS3KeyPrefix *string `type:"string"`

	// The parameters for the RUN_COMMAND task execution.
	Parameters map[string][]*string `type:"map"`

	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for maintenance window Run Command tasks.
	ServiceRoleArn *string `type:"string"`

	// If this time is reached and the command has not already started running,
	// it doesn't run.
	TimeoutSeconds *int64 `min:"30" type:"integer"`
	// contains filtered or unexported fields
}

The parameters for a RUN_COMMAND task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

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.

For Run Command tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

func (MaintenanceWindowRunCommandParameters) GoString added in v1.10.25

GoString returns the string representation

func (*MaintenanceWindowRunCommandParameters) SetComment added in v1.10.25

SetComment sets the Comment field's value.

func (*MaintenanceWindowRunCommandParameters) SetDocumentHash added in v1.10.25

SetDocumentHash sets the DocumentHash field's value.

func (*MaintenanceWindowRunCommandParameters) SetDocumentHashType added in v1.10.25

SetDocumentHashType sets the DocumentHashType field's value.

func (*MaintenanceWindowRunCommandParameters) SetNotificationConfig added in v1.10.25

SetNotificationConfig sets the NotificationConfig field's value.

func (*MaintenanceWindowRunCommandParameters) SetOutputS3BucketName added in v1.10.25

SetOutputS3BucketName sets the OutputS3BucketName field's value.

func (*MaintenanceWindowRunCommandParameters) SetOutputS3KeyPrefix added in v1.10.25

SetOutputS3KeyPrefix sets the OutputS3KeyPrefix field's value.

func (*MaintenanceWindowRunCommandParameters) SetParameters added in v1.10.25

SetParameters sets the Parameters field's value.

func (*MaintenanceWindowRunCommandParameters) SetServiceRoleArn added in v1.10.25

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*MaintenanceWindowRunCommandParameters) SetTimeoutSeconds added in v1.10.25

SetTimeoutSeconds sets the TimeoutSeconds field's value.

func (MaintenanceWindowRunCommandParameters) String added in v1.10.25

String returns the string representation

func (*MaintenanceWindowRunCommandParameters) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type MaintenanceWindowStepFunctionsParameters added in v1.10.25

type MaintenanceWindowStepFunctionsParameters struct {

	// The inputs for the STEP_FUNCTIONS task.
	Input *string `type:"string" sensitive:"true"`

	// The name of the STEP_FUNCTIONS task.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The parameters for a STEP_FUNCTIONS task.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

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.

For Step Functions tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

func (MaintenanceWindowStepFunctionsParameters) GoString added in v1.10.25

GoString returns the string representation

func (*MaintenanceWindowStepFunctionsParameters) SetInput added in v1.10.25

SetInput sets the Input field's value.

func (*MaintenanceWindowStepFunctionsParameters) SetName added in v1.10.25

SetName sets the Name field's value.

func (MaintenanceWindowStepFunctionsParameters) String added in v1.10.25

String returns the string representation

func (*MaintenanceWindowStepFunctionsParameters) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type MaintenanceWindowTarget added in v1.5.13

type MaintenanceWindowTarget struct {

	// A description for the target.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The name for the maintenance window target.
	Name *string `min:"3" type:"string"`

	// A user-provided value that will be included in any CloudWatch events that
	// are raised while running tasks for these targets in this maintenance window.
	OwnerInformation *string `min:"1" type:"string" sensitive:"true"`

	// The type of target that is being registered with the maintenance window.
	ResourceType *string `type:"string" enum:"MaintenanceWindowResourceType"`

	// The targets, either instances or tags.
	//
	// Specify instances using the following format:
	//
	// Key=instanceids,Values=<instanceid1>,<instanceid2>
	//
	// Tags are specified using the following format:
	//
	// Key=<tag name>,Values=<tag value>.
	Targets []*Target `type:"list"`

	// The ID of the maintenance window to register the target with.
	WindowId *string `min:"20" type:"string"`

	// The ID of the target.
	WindowTargetId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

The target registered with the maintenance window.

func (MaintenanceWindowTarget) GoString added in v1.5.13

func (s MaintenanceWindowTarget) GoString() string

GoString returns the string representation

func (*MaintenanceWindowTarget) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*MaintenanceWindowTarget) SetName added in v1.10.25

SetName sets the Name field's value.

func (*MaintenanceWindowTarget) SetOwnerInformation added in v1.5.13

func (s *MaintenanceWindowTarget) SetOwnerInformation(v string) *MaintenanceWindowTarget

SetOwnerInformation sets the OwnerInformation field's value.

func (*MaintenanceWindowTarget) SetResourceType added in v1.5.13

SetResourceType sets the ResourceType field's value.

func (*MaintenanceWindowTarget) SetTargets added in v1.5.13

SetTargets sets the Targets field's value.

func (*MaintenanceWindowTarget) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (*MaintenanceWindowTarget) SetWindowTargetId added in v1.5.13

func (s *MaintenanceWindowTarget) SetWindowTargetId(v string) *MaintenanceWindowTarget

SetWindowTargetId sets the WindowTargetId field's value.

func (MaintenanceWindowTarget) String added in v1.5.13

func (s MaintenanceWindowTarget) String() string

String returns the string representation

type MaintenanceWindowTask added in v1.5.13

type MaintenanceWindowTask struct {

	// A description of the task.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// Information about an Amazon S3 bucket to write task-level logs to.
	//
	// LoggingInfo has been deprecated. To specify an S3 bucket to contain logs,
	// instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	LoggingInfo *LoggingInfo `type:"structure"`

	// The maximum number of targets this task can be run for, in parallel.
	MaxConcurrency *string `min:"1" type:"string"`

	// The maximum number of errors allowed before this task stops being scheduled.
	MaxErrors *string `min:"1" type:"string"`

	// The task name.
	Name *string `min:"3" type:"string"`

	// The priority of the task in the maintenance window. The lower the number,
	// the higher the priority. Tasks that have the same priority are scheduled
	// in parallel.
	Priority *int64 `type:"integer"`

	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for maintenance window Run Command tasks.
	ServiceRoleArn *string `type:"string"`

	// The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>.
	// Tags are specified using Key=<tag name>,Values=<tag value>.
	Targets []*Target `type:"list"`

	// The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION
	// task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA
	// tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the
	// state machine ARN.
	TaskArn *string `min:"1" type:"string"`

	// The parameters that should be passed to the task when it is run.
	//
	// TaskParameters has been deprecated. To specify parameters to pass to a task
	// when it runs, instead use the Parameters option in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	TaskParameters map[string]*MaintenanceWindowTaskParameterValueExpression `type:"map" sensitive:"true"`

	// The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION,
	// LAMBDA, or STEP_FUNCTIONS.
	Type *string `type:"string" enum:"MaintenanceWindowTaskType"`

	// The ID of the maintenance window where the task is registered.
	WindowId *string `min:"20" type:"string"`

	// The task ID.
	WindowTaskId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

Information about a task defined for a maintenance window.

func (MaintenanceWindowTask) GoString added in v1.5.13

func (s MaintenanceWindowTask) GoString() string

GoString returns the string representation

func (*MaintenanceWindowTask) SetDescription added in v1.10.25

func (s *MaintenanceWindowTask) SetDescription(v string) *MaintenanceWindowTask

SetDescription sets the Description field's value.

func (*MaintenanceWindowTask) SetLoggingInfo added in v1.5.13

SetLoggingInfo sets the LoggingInfo field's value.

func (*MaintenanceWindowTask) SetMaxConcurrency added in v1.5.13

func (s *MaintenanceWindowTask) SetMaxConcurrency(v string) *MaintenanceWindowTask

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*MaintenanceWindowTask) SetMaxErrors added in v1.5.13

SetMaxErrors sets the MaxErrors field's value.

func (*MaintenanceWindowTask) SetName added in v1.10.25

SetName sets the Name field's value.

func (*MaintenanceWindowTask) SetPriority added in v1.5.13

SetPriority sets the Priority field's value.

func (*MaintenanceWindowTask) SetServiceRoleArn added in v1.5.13

func (s *MaintenanceWindowTask) SetServiceRoleArn(v string) *MaintenanceWindowTask

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*MaintenanceWindowTask) SetTargets added in v1.5.13

func (s *MaintenanceWindowTask) SetTargets(v []*Target) *MaintenanceWindowTask

SetTargets sets the Targets field's value.

func (*MaintenanceWindowTask) SetTaskArn added in v1.5.13

SetTaskArn sets the TaskArn field's value.

func (*MaintenanceWindowTask) SetTaskParameters added in v1.5.13

SetTaskParameters sets the TaskParameters field's value.

func (*MaintenanceWindowTask) SetType added in v1.5.13

SetType sets the Type field's value.

func (*MaintenanceWindowTask) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (*MaintenanceWindowTask) SetWindowTaskId added in v1.5.13

func (s *MaintenanceWindowTask) SetWindowTaskId(v string) *MaintenanceWindowTask

SetWindowTaskId sets the WindowTaskId field's value.

func (MaintenanceWindowTask) String added in v1.5.13

func (s MaintenanceWindowTask) String() string

String returns the string representation

type MaintenanceWindowTaskInvocationParameters added in v1.10.25

type MaintenanceWindowTaskInvocationParameters struct {

	// The parameters for an AUTOMATION task type.
	Automation *MaintenanceWindowAutomationParameters `type:"structure"`

	// The parameters for a LAMBDA task type.
	Lambda *MaintenanceWindowLambdaParameters `type:"structure"`

	// The parameters for a RUN_COMMAND task type.
	RunCommand *MaintenanceWindowRunCommandParameters `type:"structure"`

	// The parameters for a STEP_FUNCTIONS task type.
	StepFunctions *MaintenanceWindowStepFunctionsParameters `type:"structure"`
	// contains filtered or unexported fields
}

The parameters for task execution.

func (MaintenanceWindowTaskInvocationParameters) GoString added in v1.10.25

GoString returns the string representation

func (*MaintenanceWindowTaskInvocationParameters) SetAutomation added in v1.10.25

SetAutomation sets the Automation field's value.

func (*MaintenanceWindowTaskInvocationParameters) SetLambda added in v1.10.25

SetLambda sets the Lambda field's value.

func (*MaintenanceWindowTaskInvocationParameters) SetRunCommand added in v1.10.25

SetRunCommand sets the RunCommand field's value.

func (*MaintenanceWindowTaskInvocationParameters) SetStepFunctions added in v1.10.25

SetStepFunctions sets the StepFunctions field's value.

func (MaintenanceWindowTaskInvocationParameters) String added in v1.10.25

String returns the string representation

func (*MaintenanceWindowTaskInvocationParameters) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type MaintenanceWindowTaskParameterValueExpression added in v1.5.13

type MaintenanceWindowTaskParameterValueExpression struct {

	// This field contains an array of 0 or more strings, each 1 to 255 characters
	// in length.
	Values []*string `type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

Defines the values for a task parameter.

func (MaintenanceWindowTaskParameterValueExpression) GoString added in v1.5.13

GoString returns the string representation

func (*MaintenanceWindowTaskParameterValueExpression) SetValues added in v1.5.13

SetValues sets the Values field's value.

func (MaintenanceWindowTaskParameterValueExpression) String added in v1.5.13

String returns the string representation

type ModifyDocumentPermissionInput added in v1.1.26

type ModifyDocumentPermissionInput struct {

	// The AWS user accounts that should have access to the document. The account
	// IDs can either be a group of account IDs or All.
	AccountIdsToAdd []*string `type:"list"`

	// The AWS user accounts that should no longer have access to the document.
	// The AWS user account can either be a group of account IDs or All. This action
	// has a higher priority than AccountIdsToAdd. If you specify an account ID
	// to add and the same ID to remove, the system removes access to the document.
	AccountIdsToRemove []*string `type:"list"`

	// The name of the document that you want to share.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The permission type for the document. The permission type can be Share.
	//
	// PermissionType is a required field
	PermissionType *string `type:"string" required:"true" enum:"DocumentPermissionType"`
	// contains filtered or unexported fields
}

func (ModifyDocumentPermissionInput) GoString added in v1.1.26

GoString returns the string representation

func (*ModifyDocumentPermissionInput) SetAccountIdsToAdd added in v1.5.0

SetAccountIdsToAdd sets the AccountIdsToAdd field's value.

func (*ModifyDocumentPermissionInput) SetAccountIdsToRemove added in v1.5.0

func (s *ModifyDocumentPermissionInput) SetAccountIdsToRemove(v []*string) *ModifyDocumentPermissionInput

SetAccountIdsToRemove sets the AccountIdsToRemove field's value.

func (*ModifyDocumentPermissionInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*ModifyDocumentPermissionInput) SetPermissionType added in v1.5.0

SetPermissionType sets the PermissionType field's value.

func (ModifyDocumentPermissionInput) String added in v1.1.26

String returns the string representation

func (*ModifyDocumentPermissionInput) Validate added in v1.1.26

func (s *ModifyDocumentPermissionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ModifyDocumentPermissionOutput added in v1.1.26

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

func (ModifyDocumentPermissionOutput) GoString added in v1.1.26

GoString returns the string representation

func (ModifyDocumentPermissionOutput) String added in v1.1.26

String returns the string representation

type NonCompliantSummary added in v1.10.25

type NonCompliantSummary struct {

	// The total number of compliance items that are not compliant.
	NonCompliantCount *int64 `type:"integer"`

	// A summary of the non-compliance severity by compliance type
	SeveritySummary *SeveritySummary `type:"structure"`
	// contains filtered or unexported fields
}

A summary of resources that are not compliant. The summary is organized according to resource type.

func (NonCompliantSummary) GoString added in v1.10.25

func (s NonCompliantSummary) GoString() string

GoString returns the string representation

func (*NonCompliantSummary) SetNonCompliantCount added in v1.10.25

func (s *NonCompliantSummary) SetNonCompliantCount(v int64) *NonCompliantSummary

SetNonCompliantCount sets the NonCompliantCount field's value.

func (*NonCompliantSummary) SetSeveritySummary added in v1.10.25

func (s *NonCompliantSummary) SetSeveritySummary(v *SeveritySummary) *NonCompliantSummary

SetSeveritySummary sets the SeveritySummary field's value.

func (NonCompliantSummary) String added in v1.10.25

func (s NonCompliantSummary) String() string

String returns the string representation

type NotificationConfig added in v1.2.6

type NotificationConfig struct {

	// An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon
	// SNS) topic. Run Command pushes notifications about command status changes
	// to this topic.
	NotificationArn *string `type:"string"`

	// The different events for which you can receive notifications. These events
	// include the following: All (events), InProgress, Success, TimedOut, Cancelled,
	// Failed. To learn more about these events, see Configuring Amazon SNS Notifications
	// for AWS Systems Manager (http://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html)
	// in the AWS Systems Manager User Guide.
	NotificationEvents []*string `type:"list"`

	// Command: Receive notification when the status of a command changes. Invocation:
	// For commands sent to multiple instances, receive notification on a per-instance
	// basis when the status of a command changes.
	NotificationType *string `type:"string" enum:"NotificationType"`
	// contains filtered or unexported fields
}

Configurations for sending notifications.

func (NotificationConfig) GoString added in v1.2.6

func (s NotificationConfig) GoString() string

GoString returns the string representation

func (*NotificationConfig) SetNotificationArn added in v1.5.0

func (s *NotificationConfig) SetNotificationArn(v string) *NotificationConfig

SetNotificationArn sets the NotificationArn field's value.

func (*NotificationConfig) SetNotificationEvents added in v1.5.0

func (s *NotificationConfig) SetNotificationEvents(v []*string) *NotificationConfig

SetNotificationEvents sets the NotificationEvents field's value.

func (*NotificationConfig) SetNotificationType added in v1.5.0

func (s *NotificationConfig) SetNotificationType(v string) *NotificationConfig

SetNotificationType sets the NotificationType field's value.

func (NotificationConfig) String added in v1.2.6

func (s NotificationConfig) String() string

String returns the string representation

type OpsAggregator added in v1.99.0

type OpsAggregator struct {

	// Either a Range or Count aggregator for limiting an OpsItem summary.
	AggregatorType *string `min:"1" type:"string"`

	// A nested aggregator for viewing counts of OpsItems.
	Aggregators []*OpsAggregator `min:"1" type:"list"`

	// The name of an OpsItem attribute on which to limit the count of OpsItems.
	AttributeName *string `type:"string"`

	// The aggregator filters.
	Filters []*OpsFilter `min:"1" type:"list"`

	// The data type name to use for viewing counts of OpsItems.
	TypeName *string `min:"1" type:"string"`

	// The aggregator value.
	Values map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

One or more aggregators for viewing counts of OpsItems using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.

func (OpsAggregator) GoString added in v1.99.0

func (s OpsAggregator) GoString() string

GoString returns the string representation

func (*OpsAggregator) SetAggregatorType added in v1.99.0

func (s *OpsAggregator) SetAggregatorType(v string) *OpsAggregator

SetAggregatorType sets the AggregatorType field's value.

func (*OpsAggregator) SetAggregators added in v1.99.0

func (s *OpsAggregator) SetAggregators(v []*OpsAggregator) *OpsAggregator

SetAggregators sets the Aggregators field's value.

func (*OpsAggregator) SetAttributeName added in v1.99.0

func (s *OpsAggregator) SetAttributeName(v string) *OpsAggregator

SetAttributeName sets the AttributeName field's value.

func (*OpsAggregator) SetFilters added in v1.99.0

func (s *OpsAggregator) SetFilters(v []*OpsFilter) *OpsAggregator

SetFilters sets the Filters field's value.

func (*OpsAggregator) SetTypeName added in v1.99.0

func (s *OpsAggregator) SetTypeName(v string) *OpsAggregator

SetTypeName sets the TypeName field's value.

func (*OpsAggregator) SetValues added in v1.99.0

func (s *OpsAggregator) SetValues(v map[string]*string) *OpsAggregator

SetValues sets the Values field's value.

func (OpsAggregator) String added in v1.99.0

func (s OpsAggregator) String() string

String returns the string representation

func (*OpsAggregator) Validate added in v1.99.0

func (s *OpsAggregator) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OpsEntity added in v1.99.0

type OpsEntity struct {

	// The data returned by the query.
	Data map[string]*OpsEntityItem `type:"map"`

	// The query ID.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

The result of the query.

func (OpsEntity) GoString added in v1.99.0

func (s OpsEntity) GoString() string

GoString returns the string representation

func (*OpsEntity) SetData added in v1.99.0

func (s *OpsEntity) SetData(v map[string]*OpsEntityItem) *OpsEntity

SetData sets the Data field's value.

func (*OpsEntity) SetId added in v1.99.0

func (s *OpsEntity) SetId(v string) *OpsEntity

SetId sets the Id field's value.

func (OpsEntity) String added in v1.99.0

func (s OpsEntity) String() string

String returns the string representation

type OpsEntityItem added in v1.99.0

type OpsEntityItem struct {

	// The detailed data content for an OpsItem summaries result item.
	Content []map[string]*string `type:"list"`
	// contains filtered or unexported fields
}

The OpsItem summaries result item.

func (OpsEntityItem) GoString added in v1.99.0

func (s OpsEntityItem) GoString() string

GoString returns the string representation

func (*OpsEntityItem) SetContent added in v1.99.0

func (s *OpsEntityItem) SetContent(v []map[string]*string) *OpsEntityItem

SetContent sets the Content field's value.

func (OpsEntityItem) String added in v1.99.0

func (s OpsEntityItem) String() string

String returns the string representation

type OpsFilter added in v1.99.0

type OpsFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The type of filter.
	Type *string `type:"string" enum:"OpsFilterOperatorType"`

	// The filter value.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter for viewing OpsItem summaries.

func (OpsFilter) GoString added in v1.99.0

func (s OpsFilter) GoString() string

GoString returns the string representation

func (*OpsFilter) SetKey added in v1.99.0

func (s *OpsFilter) SetKey(v string) *OpsFilter

SetKey sets the Key field's value.

func (*OpsFilter) SetType added in v1.99.0

func (s *OpsFilter) SetType(v string) *OpsFilter

SetType sets the Type field's value.

func (*OpsFilter) SetValues added in v1.99.0

func (s *OpsFilter) SetValues(v []*string) *OpsFilter

SetValues sets the Values field's value.

func (OpsFilter) String added in v1.99.0

func (s OpsFilter) String() string

String returns the string representation

func (*OpsFilter) Validate added in v1.99.0

func (s *OpsFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OpsItem added in v1.99.0

type OpsItem struct {

	// The ARN of the AWS account that created the OpsItem.
	CreatedBy *string `type:"string"`

	// The date and time the OpsItem was created.
	CreatedTime *time.Time `type:"timestamp"`

	// The OpsItem description.
	Description *string `min:"1" type:"string"`

	// The ARN of the AWS account that last updated the OpsItem.
	LastModifiedBy *string `type:"string"`

	// The date and time the OpsItem was last updated.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of an SNS topic where notifications are sent
	// when this OpsItem is edited or changed.
	Notifications []*OpsItemNotification `type:"list"`

	// Operational data is custom data that provides useful reference details about
	// the OpsItem. For example, you can specify log files, error strings, license
	// keys, troubleshooting tips, or other relevant data. You enter operational
	// data as key-value pairs. The key has a maximum length of 128 characters.
	// The value has a maximum size of 20 KB.
	//
	// Operational data keys can't begin with the following: amazon, aws, amzn,
	// ssm, /amazon, /aws, /amzn, /ssm.
	//
	// You can choose to make the data searchable by other users in the account
	// or you can restrict search access. Searchable data means that all users with
	// access to the OpsItem Overview page (as provided by the DescribeOpsItems
	// API action) can view and search on the specified data. Operational data that
	// is not searchable is only viewable by users who have access to the OpsItem
	// (as provided by the GetOpsItem API action).
	//
	// Use the /aws/resources key in OperationalData to specify a related resource
	// in the request. Use the /aws/automations key in OperationalData to associate
	// an Automation runbook with the OpsItem. To view AWS CLI example commands
	// that use these keys, see Creating OpsItems Manually (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems)
	// in the AWS Systems Manager User Guide.
	OperationalData map[string]*OpsItemDataValue `type:"map"`

	// The ID of the OpsItem.
	OpsItemId *string `type:"string"`

	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int64 `min:"1" type:"integer"`

	// One or more OpsItems that share something in common with the current OpsItem.
	// For example, related OpsItems can include OpsItems with similar error messages,
	// impacted resources, or statuses for the impacted resource.
	RelatedOpsItems []*RelatedOpsItem `type:"list"`

	// The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The
	// impacted resource is a subset of source.
	Source *string `min:"1" type:"string"`

	// The OpsItem status. Status can be Open, In Progress, or Resolved. For more
	// information, see Editing OpsItem Details (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html)
	// in the AWS Systems Manager User Guide.
	Status *string `type:"string" enum:"OpsItemStatus"`

	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	Title *string `min:"1" type:"string"`

	// The version of this OpsItem. Each time the OpsItem is edited the version
	// number increments by one.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

func (OpsItem) GoString added in v1.99.0

func (s OpsItem) GoString() string

GoString returns the string representation

func (*OpsItem) SetCreatedBy added in v1.99.0

func (s *OpsItem) SetCreatedBy(v string) *OpsItem

SetCreatedBy sets the CreatedBy field's value.

func (*OpsItem) SetCreatedTime added in v1.99.0

func (s *OpsItem) SetCreatedTime(v time.Time) *OpsItem

SetCreatedTime sets the CreatedTime field's value.

func (*OpsItem) SetDescription added in v1.99.0

func (s *OpsItem) SetDescription(v string) *OpsItem

SetDescription sets the Description field's value.

func (*OpsItem) SetLastModifiedBy added in v1.99.0

func (s *OpsItem) SetLastModifiedBy(v string) *OpsItem

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*OpsItem) SetLastModifiedTime added in v1.99.0

func (s *OpsItem) SetLastModifiedTime(v time.Time) *OpsItem

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*OpsItem) SetNotifications added in v1.99.0

func (s *OpsItem) SetNotifications(v []*OpsItemNotification) *OpsItem

SetNotifications sets the Notifications field's value.

func (*OpsItem) SetOperationalData added in v1.99.0

func (s *OpsItem) SetOperationalData(v map[string]*OpsItemDataValue) *OpsItem

SetOperationalData sets the OperationalData field's value.

func (*OpsItem) SetOpsItemId added in v1.99.0

func (s *OpsItem) SetOpsItemId(v string) *OpsItem

SetOpsItemId sets the OpsItemId field's value.

func (*OpsItem) SetPriority added in v1.99.0

func (s *OpsItem) SetPriority(v int64) *OpsItem

SetPriority sets the Priority field's value.

func (*OpsItem) SetRelatedOpsItems added in v1.99.0

func (s *OpsItem) SetRelatedOpsItems(v []*RelatedOpsItem) *OpsItem

SetRelatedOpsItems sets the RelatedOpsItems field's value.

func (*OpsItem) SetSource added in v1.99.0

func (s *OpsItem) SetSource(v string) *OpsItem

SetSource sets the Source field's value.

func (*OpsItem) SetStatus added in v1.99.0

func (s *OpsItem) SetStatus(v string) *OpsItem

SetStatus sets the Status field's value.

func (*OpsItem) SetTitle added in v1.99.0

func (s *OpsItem) SetTitle(v string) *OpsItem

SetTitle sets the Title field's value.

func (*OpsItem) SetVersion added in v1.99.0

func (s *OpsItem) SetVersion(v string) *OpsItem

SetVersion sets the Version field's value.

func (OpsItem) String added in v1.99.0

func (s OpsItem) String() string

String returns the string representation

type OpsItemDataValue added in v1.99.0

type OpsItemDataValue struct {

	// The type of key-value pair. Valid types include SearchableString and String.
	Type *string `type:"string" enum:"OpsItemDataType"`

	// The value of the OperationalData key.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

An object that defines the value of the key and its type in the OperationalData map.

func (OpsItemDataValue) GoString added in v1.99.0

func (s OpsItemDataValue) GoString() string

GoString returns the string representation

func (*OpsItemDataValue) SetType added in v1.99.0

func (s *OpsItemDataValue) SetType(v string) *OpsItemDataValue

SetType sets the Type field's value.

func (*OpsItemDataValue) SetValue added in v1.99.0

func (s *OpsItemDataValue) SetValue(v string) *OpsItemDataValue

SetValue sets the Value field's value.

func (OpsItemDataValue) String added in v1.99.0

func (s OpsItemDataValue) String() string

String returns the string representation

type OpsItemFilter added in v1.99.0

type OpsItemFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"OpsItemFilterKey"`

	// The operator used by the filter call.
	//
	// Operator is a required field
	Operator *string `type:"string" required:"true" enum:"OpsItemFilterOperator"`

	// The filter value.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Describes an OpsItem filter.

func (OpsItemFilter) GoString added in v1.99.0

func (s OpsItemFilter) GoString() string

GoString returns the string representation

func (*OpsItemFilter) SetKey added in v1.99.0

func (s *OpsItemFilter) SetKey(v string) *OpsItemFilter

SetKey sets the Key field's value.

func (*OpsItemFilter) SetOperator added in v1.99.0

func (s *OpsItemFilter) SetOperator(v string) *OpsItemFilter

SetOperator sets the Operator field's value.

func (*OpsItemFilter) SetValues added in v1.99.0

func (s *OpsItemFilter) SetValues(v []*string) *OpsItemFilter

SetValues sets the Values field's value.

func (OpsItemFilter) String added in v1.99.0

func (s OpsItemFilter) String() string

String returns the string representation

func (*OpsItemFilter) Validate added in v1.99.0

func (s *OpsItemFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OpsItemNotification added in v1.99.0

type OpsItemNotification struct {

	// The Amazon Resource Name (ARN) of an SNS topic where notifications are sent
	// when this OpsItem is edited or changed.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

A notification about the OpsItem.

func (OpsItemNotification) GoString added in v1.99.0

func (s OpsItemNotification) GoString() string

GoString returns the string representation

func (*OpsItemNotification) SetArn added in v1.99.0

SetArn sets the Arn field's value.

func (OpsItemNotification) String added in v1.99.0

func (s OpsItemNotification) String() string

String returns the string representation

type OpsItemSummary added in v1.99.0

type OpsItemSummary struct {

	// The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
	CreatedBy *string `type:"string"`

	// The date and time the OpsItem was created.
	CreatedTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
	LastModifiedBy *string `type:"string"`

	// The date and time the OpsItem was last updated.
	LastModifiedTime *time.Time `type:"timestamp"`

	// Operational data is custom data that provides useful reference details about
	// the OpsItem.
	OperationalData map[string]*OpsItemDataValue `type:"map"`

	// The ID of the OpsItem.
	OpsItemId *string `type:"string"`

	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int64 `min:"1" type:"integer"`

	// The impacted AWS resource.
	Source *string `min:"1" type:"string"`

	// The OpsItem status. Status can be Open, In Progress, or Resolved.
	Status *string `type:"string" enum:"OpsItemStatus"`

	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	Title *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A count of OpsItems.

func (OpsItemSummary) GoString added in v1.99.0

func (s OpsItemSummary) GoString() string

GoString returns the string representation

func (*OpsItemSummary) SetCreatedBy added in v1.99.0

func (s *OpsItemSummary) SetCreatedBy(v string) *OpsItemSummary

SetCreatedBy sets the CreatedBy field's value.

func (*OpsItemSummary) SetCreatedTime added in v1.99.0

func (s *OpsItemSummary) SetCreatedTime(v time.Time) *OpsItemSummary

SetCreatedTime sets the CreatedTime field's value.

func (*OpsItemSummary) SetLastModifiedBy added in v1.99.0

func (s *OpsItemSummary) SetLastModifiedBy(v string) *OpsItemSummary

SetLastModifiedBy sets the LastModifiedBy field's value.

func (*OpsItemSummary) SetLastModifiedTime added in v1.99.0

func (s *OpsItemSummary) SetLastModifiedTime(v time.Time) *OpsItemSummary

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*OpsItemSummary) SetOperationalData added in v1.99.0

func (s *OpsItemSummary) SetOperationalData(v map[string]*OpsItemDataValue) *OpsItemSummary

SetOperationalData sets the OperationalData field's value.

func (*OpsItemSummary) SetOpsItemId added in v1.99.0

func (s *OpsItemSummary) SetOpsItemId(v string) *OpsItemSummary

SetOpsItemId sets the OpsItemId field's value.

func (*OpsItemSummary) SetPriority added in v1.99.0

func (s *OpsItemSummary) SetPriority(v int64) *OpsItemSummary

SetPriority sets the Priority field's value.

func (*OpsItemSummary) SetSource added in v1.99.0

func (s *OpsItemSummary) SetSource(v string) *OpsItemSummary

SetSource sets the Source field's value.

func (*OpsItemSummary) SetStatus added in v1.99.0

func (s *OpsItemSummary) SetStatus(v string) *OpsItemSummary

SetStatus sets the Status field's value.

func (*OpsItemSummary) SetTitle added in v1.99.0

func (s *OpsItemSummary) SetTitle(v string) *OpsItemSummary

SetTitle sets the Title field's value.

func (OpsItemSummary) String added in v1.99.0

func (s OpsItemSummary) String() string

String returns the string representation

type OutputSource added in v1.14.18

type OutputSource struct {

	// The ID of the output source, for example the URL of an Amazon S3 bucket.
	OutputSourceId *string `min:"36" type:"string"`

	// The type of source where the association execution details are stored, for
	// example, Amazon S3.
	OutputSourceType *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the source where the association execution details are stored.

func (OutputSource) GoString added in v1.14.18

func (s OutputSource) GoString() string

GoString returns the string representation

func (*OutputSource) SetOutputSourceId added in v1.14.18

func (s *OutputSource) SetOutputSourceId(v string) *OutputSource

SetOutputSourceId sets the OutputSourceId field's value.

func (*OutputSource) SetOutputSourceType added in v1.14.18

func (s *OutputSource) SetOutputSourceType(v string) *OutputSource

SetOutputSourceType sets the OutputSourceType field's value.

func (OutputSource) String added in v1.14.18

func (s OutputSource) String() string

String returns the string representation

type Parameter added in v1.5.13

type Parameter struct {

	// The Amazon Resource Name (ARN) of the parameter.
	ARN *string `type:"string"`

	// Date the parameter was last changed or updated and the parameter version
	// was created.
	LastModifiedDate *time.Time `type:"timestamp"`

	// The name of the parameter.
	Name *string `min:"1" type:"string"`

	// Either the version number or the label used to retrieve the parameter value.
	// Specify selectors by using one of the following formats:
	//
	// parameter_name:version
	//
	// parameter_name:label
	Selector *string `type:"string"`

	// Applies to parameters that reference information in other AWS services. SourceResult
	// is the raw result or response from the source.
	SourceResult *string `type:"string"`

	// The type of parameter. Valid values include the following: String, String
	// list, Secure string.
	Type *string `type:"string" enum:"ParameterType"`

	// The parameter value.
	Value *string `type:"string"`

	// The parameter version.
	Version *int64 `type:"long"`
	// contains filtered or unexported fields
}

An Amazon EC2 Systems Manager parameter in Parameter Store.

func (Parameter) GoString added in v1.5.13

func (s Parameter) GoString() string

GoString returns the string representation

func (*Parameter) SetARN added in v1.99.0

func (s *Parameter) SetARN(v string) *Parameter

SetARN sets the ARN field's value.

func (*Parameter) SetLastModifiedDate added in v1.99.0

func (s *Parameter) SetLastModifiedDate(v time.Time) *Parameter

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*Parameter) SetName added in v1.5.13

func (s *Parameter) SetName(v string) *Parameter

SetName sets the Name field's value.

func (*Parameter) SetSelector added in v1.99.0

func (s *Parameter) SetSelector(v string) *Parameter

SetSelector sets the Selector field's value.

func (*Parameter) SetSourceResult added in v1.99.0

func (s *Parameter) SetSourceResult(v string) *Parameter

SetSourceResult sets the SourceResult field's value.

func (*Parameter) SetType added in v1.5.13

func (s *Parameter) SetType(v string) *Parameter

SetType sets the Type field's value.

func (*Parameter) SetValue added in v1.5.13

func (s *Parameter) SetValue(v string) *Parameter

SetValue sets the Value field's value.

func (*Parameter) SetVersion added in v1.12.14

func (s *Parameter) SetVersion(v int64) *Parameter

SetVersion sets the Version field's value.

func (Parameter) String added in v1.5.13

func (s Parameter) String() string

String returns the string representation

type ParameterHistory added in v1.5.13

type ParameterHistory struct {

	// Parameter names can include the following letters and symbols.
	//
	// a-zA-Z0-9_.-
	AllowedPattern *string `type:"string"`

	// Information about the parameter.
	Description *string `type:"string"`

	// The ID of the query key used for this parameter.
	KeyId *string `min:"1" type:"string"`

	// Labels assigned to the parameter version.
	Labels []*string `min:"1" type:"list"`

	// Date the parameter was last changed or updated.
	LastModifiedDate *time.Time `type:"timestamp"`

	// Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
	LastModifiedUser *string `type:"string"`

	// The name of the parameter.
	Name *string `min:"1" type:"string"`

	// Information about the policies assigned to a parameter.
	//
	// Working with Parameter Policies (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html)
	// in the AWS Systems Manager User Guide.
	Policies []*ParameterInlinePolicy `type:"list"`

	// The parameter tier.
	Tier *string `type:"string" enum:"ParameterTier"`

	// The type of parameter used.
	Type *string `type:"string" enum:"ParameterType"`

	// The parameter value.
	Value *string `type:"string"`

	// The parameter version.
	Version *int64 `type:"long"`
	// contains filtered or unexported fields
}

Information about parameter usage.

func (ParameterHistory) GoString added in v1.5.13

func (s ParameterHistory) GoString() string

GoString returns the string representation

func (*ParameterHistory) SetAllowedPattern added in v1.10.1

func (s *ParameterHistory) SetAllowedPattern(v string) *ParameterHistory

SetAllowedPattern sets the AllowedPattern field's value.

func (*ParameterHistory) SetDescription added in v1.5.13

func (s *ParameterHistory) SetDescription(v string) *ParameterHistory

SetDescription sets the Description field's value.

func (*ParameterHistory) SetKeyId added in v1.5.13

func (s *ParameterHistory) SetKeyId(v string) *ParameterHistory

SetKeyId sets the KeyId field's value.

func (*ParameterHistory) SetLabels added in v1.99.0

func (s *ParameterHistory) SetLabels(v []*string) *ParameterHistory

SetLabels sets the Labels field's value.

func (*ParameterHistory) SetLastModifiedDate added in v1.5.13

func (s *ParameterHistory) SetLastModifiedDate(v time.Time) *ParameterHistory

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ParameterHistory) SetLastModifiedUser added in v1.5.13

func (s *ParameterHistory) SetLastModifiedUser(v string) *ParameterHistory

SetLastModifiedUser sets the LastModifiedUser field's value.

func (*ParameterHistory) SetName added in v1.5.13

func (s *ParameterHistory) SetName(v string) *ParameterHistory

SetName sets the Name field's value.

func (*ParameterHistory) SetPolicies added in v1.99.0

SetPolicies sets the Policies field's value.

func (*ParameterHistory) SetTier added in v1.99.0

func (s *ParameterHistory) SetTier(v string) *ParameterHistory

SetTier sets the Tier field's value.

func (*ParameterHistory) SetType added in v1.5.13

func (s *ParameterHistory) SetType(v string) *ParameterHistory

SetType sets the Type field's value.

func (*ParameterHistory) SetValue added in v1.5.13

func (s *ParameterHistory) SetValue(v string) *ParameterHistory

SetValue sets the Value field's value.

func (*ParameterHistory) SetVersion added in v1.12.14

func (s *ParameterHistory) SetVersion(v int64) *ParameterHistory

SetVersion sets the Version field's value.

func (ParameterHistory) String added in v1.5.13

func (s ParameterHistory) String() string

String returns the string representation

type ParameterInlinePolicy added in v1.99.0

type ParameterInlinePolicy struct {

	// The status of the policy. Policies report the following statuses: Pending
	// (the policy has not been enforced or applied yet), Finished (the policy was
	// applied), Failed (the policy was not applied), or InProgress (the policy
	// is being applied now).
	PolicyStatus *string `type:"string"`

	// The JSON text of the policy.
	PolicyText *string `type:"string"`

	// The type of policy. Parameter Store supports the following policy types:
	// Expiration, ExpirationNotification, and NoChangeNotification.
	PolicyType *string `type:"string"`
	// contains filtered or unexported fields
}

One or more policies assigned to a parameter.

func (ParameterInlinePolicy) GoString added in v1.99.0

func (s ParameterInlinePolicy) GoString() string

GoString returns the string representation

func (*ParameterInlinePolicy) SetPolicyStatus added in v1.99.0

func (s *ParameterInlinePolicy) SetPolicyStatus(v string) *ParameterInlinePolicy

SetPolicyStatus sets the PolicyStatus field's value.

func (*ParameterInlinePolicy) SetPolicyText added in v1.99.0

func (s *ParameterInlinePolicy) SetPolicyText(v string) *ParameterInlinePolicy

SetPolicyText sets the PolicyText field's value.

func (*ParameterInlinePolicy) SetPolicyType added in v1.99.0

func (s *ParameterInlinePolicy) SetPolicyType(v string) *ParameterInlinePolicy

SetPolicyType sets the PolicyType field's value.

func (ParameterInlinePolicy) String added in v1.99.0

func (s ParameterInlinePolicy) String() string

String returns the string representation

type ParameterMetadata added in v1.5.13

type ParameterMetadata struct {

	// A parameter name can include only the following letters and symbols.
	//
	// a-zA-Z0-9_.-
	AllowedPattern *string `type:"string"`

	// Description of the parameter actions.
	Description *string `type:"string"`

	// The ID of the query key used for this parameter.
	KeyId *string `min:"1" type:"string"`

	// Date the parameter was last changed or updated.
	LastModifiedDate *time.Time `type:"timestamp"`

	// Amazon Resource Name (ARN) of the AWS user who last changed the parameter.
	LastModifiedUser *string `type:"string"`

	// The parameter name.
	Name *string `min:"1" type:"string"`

	// A list of policies associated with a parameter.
	Policies []*ParameterInlinePolicy `type:"list"`

	// The parameter tier.
	Tier *string `type:"string" enum:"ParameterTier"`

	// The type of parameter. Valid parameter types include the following: String,
	// String list, Secure string.
	Type *string `type:"string" enum:"ParameterType"`

	// The parameter version.
	Version *int64 `type:"long"`
	// contains filtered or unexported fields
}

Metadata includes information like the ARN of the last user and the date/time the parameter was last used.

func (ParameterMetadata) GoString added in v1.5.13

func (s ParameterMetadata) GoString() string

GoString returns the string representation

func (*ParameterMetadata) SetAllowedPattern added in v1.10.1

func (s *ParameterMetadata) SetAllowedPattern(v string) *ParameterMetadata

SetAllowedPattern sets the AllowedPattern field's value.

func (*ParameterMetadata) SetDescription added in v1.5.13

func (s *ParameterMetadata) SetDescription(v string) *ParameterMetadata

SetDescription sets the Description field's value.

func (*ParameterMetadata) SetKeyId added in v1.5.13

func (s *ParameterMetadata) SetKeyId(v string) *ParameterMetadata

SetKeyId sets the KeyId field's value.

func (*ParameterMetadata) SetLastModifiedDate added in v1.5.13

func (s *ParameterMetadata) SetLastModifiedDate(v time.Time) *ParameterMetadata

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ParameterMetadata) SetLastModifiedUser added in v1.5.13

func (s *ParameterMetadata) SetLastModifiedUser(v string) *ParameterMetadata

SetLastModifiedUser sets the LastModifiedUser field's value.

func (*ParameterMetadata) SetName added in v1.5.13

SetName sets the Name field's value.

func (*ParameterMetadata) SetPolicies added in v1.99.0

SetPolicies sets the Policies field's value.

func (*ParameterMetadata) SetTier added in v1.99.0

SetTier sets the Tier field's value.

func (*ParameterMetadata) SetType added in v1.5.13

SetType sets the Type field's value.

func (*ParameterMetadata) SetVersion added in v1.12.14

func (s *ParameterMetadata) SetVersion(v int64) *ParameterMetadata

SetVersion sets the Version field's value.

func (ParameterMetadata) String added in v1.5.13

func (s ParameterMetadata) String() string

String returns the string representation

type ParameterStringFilter added in v1.10.1

type ParameterStringFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Valid options are Equals and BeginsWith. For Path filter, valid options are
	// Recursive and OneLevel.
	Option *string `min:"1" type:"string"`

	// The value you want to search for.
	Values []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

One or more filters. Use a filter to return a more specific list of results.

The Name and Tier filter keys can't be used with the GetParametersByPath API action. Also, the Label filter key can't be used with the DescribeParameters API action.

func (ParameterStringFilter) GoString added in v1.10.1

func (s ParameterStringFilter) GoString() string

GoString returns the string representation

func (*ParameterStringFilter) SetKey added in v1.10.1

SetKey sets the Key field's value.

func (*ParameterStringFilter) SetOption added in v1.10.1

SetOption sets the Option field's value.

func (*ParameterStringFilter) SetValues added in v1.10.1

SetValues sets the Values field's value.

func (ParameterStringFilter) String added in v1.10.1

func (s ParameterStringFilter) String() string

String returns the string representation

func (*ParameterStringFilter) Validate added in v1.10.1

func (s *ParameterStringFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ParametersFilter added in v1.5.13

type ParametersFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"ParametersFilterKey"`

	// The filter values.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

This data type is deprecated. Instead, use ParameterStringFilter.

func (ParametersFilter) GoString added in v1.5.13

func (s ParametersFilter) GoString() string

GoString returns the string representation

func (*ParametersFilter) SetKey added in v1.5.13

SetKey sets the Key field's value.

func (*ParametersFilter) SetValues added in v1.5.13

func (s *ParametersFilter) SetValues(v []*string) *ParametersFilter

SetValues sets the Values field's value.

func (ParametersFilter) String added in v1.5.13

func (s ParametersFilter) String() string

String returns the string representation

func (*ParametersFilter) Validate added in v1.5.13

func (s *ParametersFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Patch added in v1.6.4

type Patch struct {

	// The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
	Classification *string `type:"string"`

	// The URL where more information can be obtained about the patch.
	ContentUrl *string `type:"string"`

	// The description of the patch.
	Description *string `type:"string"`

	// The ID of the patch (this is different than the Microsoft Knowledge Base
	// ID).
	Id *string `min:"1" type:"string"`

	// The Microsoft Knowledge Base ID of the patch.
	KbNumber *string `type:"string"`

	// The language of the patch if it's language-specific.
	Language *string `type:"string"`

	// The ID of the MSRC bulletin the patch is related to.
	MsrcNumber *string `type:"string"`

	// The severity of the patch (for example Critical, Important, Moderate).
	MsrcSeverity *string `type:"string"`

	// The specific product the patch is applicable for (for example, WindowsServer2016).
	Product *string `type:"string"`

	// The product family the patch is applicable for (for example, Windows).
	ProductFamily *string `type:"string"`

	// The date the patch was released.
	ReleaseDate *time.Time `type:"timestamp"`

	// The title of the patch.
	Title *string `type:"string"`

	// The name of the vendor providing the patch.
	Vendor *string `type:"string"`
	// contains filtered or unexported fields
}

Represents metadata about a patch.

func (Patch) GoString added in v1.6.4

func (s Patch) GoString() string

GoString returns the string representation

func (*Patch) SetClassification added in v1.6.4

func (s *Patch) SetClassification(v string) *Patch

SetClassification sets the Classification field's value.

func (*Patch) SetContentUrl added in v1.6.4

func (s *Patch) SetContentUrl(v string) *Patch

SetContentUrl sets the ContentUrl field's value.

func (*Patch) SetDescription added in v1.6.4

func (s *Patch) SetDescription(v string) *Patch

SetDescription sets the Description field's value.

func (*Patch) SetId added in v1.6.4

func (s *Patch) SetId(v string) *Patch

SetId sets the Id field's value.

func (*Patch) SetKbNumber added in v1.6.4

func (s *Patch) SetKbNumber(v string) *Patch

SetKbNumber sets the KbNumber field's value.

func (*Patch) SetLanguage added in v1.6.4

func (s *Patch) SetLanguage(v string) *Patch

SetLanguage sets the Language field's value.

func (*Patch) SetMsrcNumber added in v1.6.4

func (s *Patch) SetMsrcNumber(v string) *Patch

SetMsrcNumber sets the MsrcNumber field's value.

func (*Patch) SetMsrcSeverity added in v1.6.4

func (s *Patch) SetMsrcSeverity(v string) *Patch

SetMsrcSeverity sets the MsrcSeverity field's value.

func (*Patch) SetProduct added in v1.6.4

func (s *Patch) SetProduct(v string) *Patch

SetProduct sets the Product field's value.

func (*Patch) SetProductFamily added in v1.6.4

func (s *Patch) SetProductFamily(v string) *Patch

SetProductFamily sets the ProductFamily field's value.

func (*Patch) SetReleaseDate added in v1.6.4

func (s *Patch) SetReleaseDate(v time.Time) *Patch

SetReleaseDate sets the ReleaseDate field's value.

func (*Patch) SetTitle added in v1.6.4

func (s *Patch) SetTitle(v string) *Patch

SetTitle sets the Title field's value.

func (*Patch) SetVendor added in v1.6.4

func (s *Patch) SetVendor(v string) *Patch

SetVendor sets the Vendor field's value.

func (Patch) String added in v1.6.4

func (s Patch) String() string

String returns the string representation

type PatchBaselineIdentity added in v1.6.4

type PatchBaselineIdentity struct {

	// The description of the patch baseline.
	BaselineDescription *string `min:"1" type:"string"`

	// The ID of the patch baseline.
	BaselineId *string `min:"20" type:"string"`

	// The name of the patch baseline.
	BaselineName *string `min:"3" type:"string"`

	// Whether this is the default baseline. Note that Systems Manager supports
	// creating multiple default patch baselines. For example, you can create a
	// default patch baseline for each operating system.
	DefaultBaseline *bool `type:"boolean"`

	// Defines the operating system the patch baseline applies to. The Default value
	// is WINDOWS.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`
	// contains filtered or unexported fields
}

Defines the basic information about a patch baseline.

func (PatchBaselineIdentity) GoString added in v1.6.4

func (s PatchBaselineIdentity) GoString() string

GoString returns the string representation

func (*PatchBaselineIdentity) SetBaselineDescription added in v1.6.4

func (s *PatchBaselineIdentity) SetBaselineDescription(v string) *PatchBaselineIdentity

SetBaselineDescription sets the BaselineDescription field's value.

func (*PatchBaselineIdentity) SetBaselineId added in v1.6.4

func (s *PatchBaselineIdentity) SetBaselineId(v string) *PatchBaselineIdentity

SetBaselineId sets the BaselineId field's value.

func (*PatchBaselineIdentity) SetBaselineName added in v1.6.4

func (s *PatchBaselineIdentity) SetBaselineName(v string) *PatchBaselineIdentity

SetBaselineName sets the BaselineName field's value.

func (*PatchBaselineIdentity) SetDefaultBaseline added in v1.6.4

func (s *PatchBaselineIdentity) SetDefaultBaseline(v bool) *PatchBaselineIdentity

SetDefaultBaseline sets the DefaultBaseline field's value.

func (*PatchBaselineIdentity) SetOperatingSystem added in v1.10.8

func (s *PatchBaselineIdentity) SetOperatingSystem(v string) *PatchBaselineIdentity

SetOperatingSystem sets the OperatingSystem field's value.

func (PatchBaselineIdentity) String added in v1.6.4

func (s PatchBaselineIdentity) String() string

String returns the string representation

type PatchComplianceData added in v1.6.4

type PatchComplianceData struct {

	// The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).
	//
	// Classification is a required field
	Classification *string `type:"string" required:"true"`

	// The date/time the patch was installed on the instance. Note that not all
	// operating systems provide this level of information.
	//
	// InstalledTime is a required field
	InstalledTime *time.Time `type:"timestamp" required:"true"`

	// The operating system-specific ID of the patch.
	//
	// KBId is a required field
	KBId *string `type:"string" required:"true"`

	// The severity of the patch (for example, Critical, Important, Moderate).
	//
	// Severity is a required field
	Severity *string `type:"string" required:"true"`

	// The state of the patch on the instance, such as INSTALLED or FAILED.
	//
	// For descriptions of each patch state, see About Patch Compliance (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch)
	// in the AWS Systems Manager User Guide.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"PatchComplianceDataState"`

	// The title of the patch.
	//
	// Title is a required field
	Title *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the state of a patch on a particular instance as it relates to the patch baseline used to patch the instance.

func (PatchComplianceData) GoString added in v1.6.4

func (s PatchComplianceData) GoString() string

GoString returns the string representation

func (*PatchComplianceData) SetClassification added in v1.6.4

func (s *PatchComplianceData) SetClassification(v string) *PatchComplianceData

SetClassification sets the Classification field's value.

func (*PatchComplianceData) SetInstalledTime added in v1.6.4

func (s *PatchComplianceData) SetInstalledTime(v time.Time) *PatchComplianceData

SetInstalledTime sets the InstalledTime field's value.

func (*PatchComplianceData) SetKBId added in v1.6.4

SetKBId sets the KBId field's value.

func (*PatchComplianceData) SetSeverity added in v1.6.4

func (s *PatchComplianceData) SetSeverity(v string) *PatchComplianceData

SetSeverity sets the Severity field's value.

func (*PatchComplianceData) SetState added in v1.6.4

SetState sets the State field's value.

func (*PatchComplianceData) SetTitle added in v1.6.4

SetTitle sets the Title field's value.

func (PatchComplianceData) String added in v1.6.4

func (s PatchComplianceData) String() string

String returns the string representation

type PatchFilter added in v1.6.4

type PatchFilter struct {

	// The key for the filter.
	//
	// Run the DescribePatchProperties command to view lists of valid keys for each
	// operating system type.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"PatchFilterKey"`

	// The value for the filter key.
	//
	// Run the DescribePatchProperties command to view lists of valid values for
	// each key based on operating system type.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Defines which patches should be included in a patch baseline.

A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are ["Office 2013", "Office 2016"], then the filter accepts all patches where product name is either "Office 2013" or "Office 2016". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.

You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.

func (PatchFilter) GoString added in v1.6.4

func (s PatchFilter) GoString() string

GoString returns the string representation

func (*PatchFilter) SetKey added in v1.6.4

func (s *PatchFilter) SetKey(v string) *PatchFilter

SetKey sets the Key field's value.

func (*PatchFilter) SetValues added in v1.6.4

func (s *PatchFilter) SetValues(v []*string) *PatchFilter

SetValues sets the Values field's value.

func (PatchFilter) String added in v1.6.4

func (s PatchFilter) String() string

String returns the string representation

func (*PatchFilter) Validate added in v1.6.4

func (s *PatchFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PatchFilterGroup added in v1.6.4

type PatchFilterGroup struct {

	// The set of patch filters that make up the group.
	//
	// PatchFilters is a required field
	PatchFilters []*PatchFilter `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A set of patch filters, typically used for approval rules.

func (PatchFilterGroup) GoString added in v1.6.4

func (s PatchFilterGroup) GoString() string

GoString returns the string representation

func (*PatchFilterGroup) SetPatchFilters added in v1.6.4

func (s *PatchFilterGroup) SetPatchFilters(v []*PatchFilter) *PatchFilterGroup

SetPatchFilters sets the PatchFilters field's value.

func (PatchFilterGroup) String added in v1.6.4

func (s PatchFilterGroup) String() string

String returns the string representation

func (*PatchFilterGroup) Validate added in v1.6.4

func (s *PatchFilterGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PatchGroupPatchBaselineMapping added in v1.6.4

type PatchGroupPatchBaselineMapping struct {

	// The patch baseline the patch group is registered with.
	BaselineIdentity *PatchBaselineIdentity `type:"structure"`

	// The name of the patch group registered with the patch baseline.
	PatchGroup *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The mapping between a patch group and the patch baseline the patch group is registered with.

func (PatchGroupPatchBaselineMapping) GoString added in v1.6.4

GoString returns the string representation

func (*PatchGroupPatchBaselineMapping) SetBaselineIdentity added in v1.6.4

SetBaselineIdentity sets the BaselineIdentity field's value.

func (*PatchGroupPatchBaselineMapping) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (PatchGroupPatchBaselineMapping) String added in v1.6.4

String returns the string representation

type PatchOrchestratorFilter added in v1.6.4

type PatchOrchestratorFilter struct {

	// The key for the filter.
	Key *string `min:"1" type:"string"`

	// The value for the filter.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

Defines a filter used in Patch Manager APIs.

func (PatchOrchestratorFilter) GoString added in v1.6.4

func (s PatchOrchestratorFilter) GoString() string

GoString returns the string representation

func (*PatchOrchestratorFilter) SetKey added in v1.6.4

SetKey sets the Key field's value.

func (*PatchOrchestratorFilter) SetValues added in v1.6.4

SetValues sets the Values field's value.

func (PatchOrchestratorFilter) String added in v1.6.4

func (s PatchOrchestratorFilter) String() string

String returns the string representation

func (*PatchOrchestratorFilter) Validate added in v1.6.4

func (s *PatchOrchestratorFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PatchRule added in v1.6.4

type PatchRule struct {

	// The number of days after the release date of each patch matched by the rule
	// that the patch is marked as approved in the patch baseline. For example,
	// a value of 7 means that patches are approved seven days after they are released.
	//
	// ApproveAfterDays is a required field
	ApproveAfterDays *int64 `type:"integer" required:"true"`

	// A compliance severity level for all approved patches in a patch baseline.
	// Valid compliance severity levels include the following: Unspecified, Critical,
	// High, Medium, Low, and Informational.
	ComplianceLevel *string `type:"string" enum:"PatchComplianceLevel"`

	// For instances identified by the approval rule filters, enables a patch baseline
	// to apply non-security updates available in the specified repository. The
	// default value is 'false'. Applies to Linux instances only.
	EnableNonSecurity *bool `type:"boolean"`

	// The patch filter group that defines the criteria for the rule.
	//
	// PatchFilterGroup is a required field
	PatchFilterGroup *PatchFilterGroup `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Defines an approval rule for a patch baseline.

func (PatchRule) GoString added in v1.6.4

func (s PatchRule) GoString() string

GoString returns the string representation

func (*PatchRule) SetApproveAfterDays added in v1.6.4

func (s *PatchRule) SetApproveAfterDays(v int64) *PatchRule

SetApproveAfterDays sets the ApproveAfterDays field's value.

func (*PatchRule) SetComplianceLevel added in v1.10.8

func (s *PatchRule) SetComplianceLevel(v string) *PatchRule

SetComplianceLevel sets the ComplianceLevel field's value.

func (*PatchRule) SetEnableNonSecurity added in v1.12.72

func (s *PatchRule) SetEnableNonSecurity(v bool) *PatchRule

SetEnableNonSecurity sets the EnableNonSecurity field's value.

func (*PatchRule) SetPatchFilterGroup added in v1.6.4

func (s *PatchRule) SetPatchFilterGroup(v *PatchFilterGroup) *PatchRule

SetPatchFilterGroup sets the PatchFilterGroup field's value.

func (PatchRule) String added in v1.6.4

func (s PatchRule) String() string

String returns the string representation

func (*PatchRule) Validate added in v1.6.4

func (s *PatchRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PatchRuleGroup added in v1.6.4

type PatchRuleGroup struct {

	// The rules that make up the rule group.
	//
	// PatchRules is a required field
	PatchRules []*PatchRule `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A set of rules defining the approval rules for a patch baseline.

func (PatchRuleGroup) GoString added in v1.6.4

func (s PatchRuleGroup) GoString() string

GoString returns the string representation

func (*PatchRuleGroup) SetPatchRules added in v1.6.4

func (s *PatchRuleGroup) SetPatchRules(v []*PatchRule) *PatchRuleGroup

SetPatchRules sets the PatchRules field's value.

func (PatchRuleGroup) String added in v1.6.4

func (s PatchRuleGroup) String() string

String returns the string representation

func (*PatchRuleGroup) Validate added in v1.6.4

func (s *PatchRuleGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PatchSource added in v1.12.72

type PatchSource struct {

	// The value of the yum repo configuration. For example:
	//
	// [main]
	//
	// cachedir=/var/cache/yum/$basesearch$releasever
	//
	// keepcache=0
	//
	// debuglevel=2
	//
	// Configuration is a required field
	Configuration *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The name specified to identify the patch source.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The specific operating system versions a patch repository applies to, such
	// as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7".
	// For lists of supported product values, see PatchFilter.
	//
	// Products is a required field
	Products []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.

func (PatchSource) GoString added in v1.12.72

func (s PatchSource) GoString() string

GoString returns the string representation

func (*PatchSource) SetConfiguration added in v1.12.72

func (s *PatchSource) SetConfiguration(v string) *PatchSource

SetConfiguration sets the Configuration field's value.

func (*PatchSource) SetName added in v1.12.72

func (s *PatchSource) SetName(v string) *PatchSource

SetName sets the Name field's value.

func (*PatchSource) SetProducts added in v1.12.72

func (s *PatchSource) SetProducts(v []*string) *PatchSource

SetProducts sets the Products field's value.

func (PatchSource) String added in v1.12.72

func (s PatchSource) String() string

String returns the string representation

func (*PatchSource) Validate added in v1.12.72

func (s *PatchSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PatchStatus added in v1.6.4

type PatchStatus struct {

	// The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).
	ApprovalDate *time.Time `type:"timestamp"`

	// The compliance severity level for a patch.
	ComplianceLevel *string `type:"string" enum:"PatchComplianceLevel"`

	// The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED,
	// EXPLICIT_REJECTED).
	DeploymentStatus *string `type:"string" enum:"PatchDeploymentStatus"`
	// contains filtered or unexported fields
}

Information about the approval status of a patch.

func (PatchStatus) GoString added in v1.6.4

func (s PatchStatus) GoString() string

GoString returns the string representation

func (*PatchStatus) SetApprovalDate added in v1.6.4

func (s *PatchStatus) SetApprovalDate(v time.Time) *PatchStatus

SetApprovalDate sets the ApprovalDate field's value.

func (*PatchStatus) SetComplianceLevel added in v1.10.8

func (s *PatchStatus) SetComplianceLevel(v string) *PatchStatus

SetComplianceLevel sets the ComplianceLevel field's value.

func (*PatchStatus) SetDeploymentStatus added in v1.6.4

func (s *PatchStatus) SetDeploymentStatus(v string) *PatchStatus

SetDeploymentStatus sets the DeploymentStatus field's value.

func (PatchStatus) String added in v1.6.4

func (s PatchStatus) String() string

String returns the string representation

type ProgressCounters added in v1.99.0

type ProgressCounters struct {

	// The total number of steps that the system cancelled in all specified AWS
	// Regions and accounts for the current Automation execution.
	CancelledSteps *int64 `type:"integer"`

	// The total number of steps that failed to run in all specified AWS Regions
	// and accounts for the current Automation execution.
	FailedSteps *int64 `type:"integer"`

	// The total number of steps that successfully completed in all specified AWS
	// Regions and accounts for the current Automation execution.
	SuccessSteps *int64 `type:"integer"`

	// The total number of steps that timed out in all specified AWS Regions and
	// accounts for the current Automation execution.
	TimedOutSteps *int64 `type:"integer"`

	// The total number of steps run in all specified AWS Regions and accounts for
	// the current Automation execution.
	TotalSteps *int64 `type:"integer"`
	// contains filtered or unexported fields
}

An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

func (ProgressCounters) GoString added in v1.99.0

func (s ProgressCounters) GoString() string

GoString returns the string representation

func (*ProgressCounters) SetCancelledSteps added in v1.99.0

func (s *ProgressCounters) SetCancelledSteps(v int64) *ProgressCounters

SetCancelledSteps sets the CancelledSteps field's value.

func (*ProgressCounters) SetFailedSteps added in v1.99.0

func (s *ProgressCounters) SetFailedSteps(v int64) *ProgressCounters

SetFailedSteps sets the FailedSteps field's value.

func (*ProgressCounters) SetSuccessSteps added in v1.99.0

func (s *ProgressCounters) SetSuccessSteps(v int64) *ProgressCounters

SetSuccessSteps sets the SuccessSteps field's value.

func (*ProgressCounters) SetTimedOutSteps added in v1.99.0

func (s *ProgressCounters) SetTimedOutSteps(v int64) *ProgressCounters

SetTimedOutSteps sets the TimedOutSteps field's value.

func (*ProgressCounters) SetTotalSteps added in v1.99.0

func (s *ProgressCounters) SetTotalSteps(v int64) *ProgressCounters

SetTotalSteps sets the TotalSteps field's value.

func (ProgressCounters) String added in v1.99.0

func (s ProgressCounters) String() string

String returns the string representation

type PutComplianceItemsInput added in v1.10.25

type PutComplianceItemsInput struct {

	// Specify the compliance type. For example, specify Association (for a State
	// Manager association), Patch, or Custom:string.
	//
	// ComplianceType is a required field
	ComplianceType *string `min:"1" type:"string" required:"true"`

	// A summary of the call execution that includes an execution ID, the type of
	// execution (for example, Command), and the date/time of the execution using
	// a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
	//
	// ExecutionSummary is a required field
	ExecutionSummary *ComplianceExecutionSummary `type:"structure" required:"true"`

	// 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 `type:"string"`

	// Information about the compliance as defined by the resource type. For example,
	// for a patch compliance type, Items includes information about the PatchSeverity,
	// Classification, etc.
	//
	// Items is a required field
	Items []*ComplianceItemEntry `type:"list" required:"true"`

	// Specify an ID for this resource. For a managed instance, this is the instance
	// ID.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// Specify the type of resource. ManagedInstance is currently the only supported
	// resource type.
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutComplianceItemsInput) GoString added in v1.10.25

func (s PutComplianceItemsInput) GoString() string

GoString returns the string representation

func (*PutComplianceItemsInput) SetComplianceType added in v1.10.25

func (s *PutComplianceItemsInput) SetComplianceType(v string) *PutComplianceItemsInput

SetComplianceType sets the ComplianceType field's value.

func (*PutComplianceItemsInput) SetExecutionSummary added in v1.10.25

SetExecutionSummary sets the ExecutionSummary field's value.

func (*PutComplianceItemsInput) SetItemContentHash added in v1.10.25

func (s *PutComplianceItemsInput) SetItemContentHash(v string) *PutComplianceItemsInput

SetItemContentHash sets the ItemContentHash field's value.

func (*PutComplianceItemsInput) SetItems added in v1.10.25

SetItems sets the Items field's value.

func (*PutComplianceItemsInput) SetResourceId added in v1.10.25

SetResourceId sets the ResourceId field's value.

func (*PutComplianceItemsInput) SetResourceType added in v1.10.25

SetResourceType sets the ResourceType field's value.

func (PutComplianceItemsInput) String added in v1.10.25

func (s PutComplianceItemsInput) String() string

String returns the string representation

func (*PutComplianceItemsInput) Validate added in v1.10.25

func (s *PutComplianceItemsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutComplianceItemsOutput added in v1.10.25

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

func (PutComplianceItemsOutput) GoString added in v1.10.25

func (s PutComplianceItemsOutput) GoString() string

GoString returns the string representation

func (PutComplianceItemsOutput) String added in v1.10.25

func (s PutComplianceItemsOutput) String() string

String returns the string representation

type PutInventoryInput added in v1.5.13

type PutInventoryInput struct {

	// One or more instance IDs where you want to add or update inventory items.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The inventory items that you want to add or update on instances.
	//
	// Items is a required field
	Items []*InventoryItem `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutInventoryInput) GoString added in v1.5.13

func (s PutInventoryInput) GoString() string

GoString returns the string representation

func (*PutInventoryInput) SetInstanceId added in v1.5.13

func (s *PutInventoryInput) SetInstanceId(v string) *PutInventoryInput

SetInstanceId sets the InstanceId field's value.

func (*PutInventoryInput) SetItems added in v1.5.13

SetItems sets the Items field's value.

func (PutInventoryInput) String added in v1.5.13

func (s PutInventoryInput) String() string

String returns the string representation

func (*PutInventoryInput) Validate added in v1.5.13

func (s *PutInventoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutInventoryOutput added in v1.5.13

type PutInventoryOutput struct {

	// Information about the request.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutInventoryOutput) GoString added in v1.5.13

func (s PutInventoryOutput) GoString() string

GoString returns the string representation

func (*PutInventoryOutput) SetMessage added in v1.13.33

func (s *PutInventoryOutput) SetMessage(v string) *PutInventoryOutput

SetMessage sets the Message field's value.

func (PutInventoryOutput) String added in v1.5.13

func (s PutInventoryOutput) String() string

String returns the string representation

type PutParameterInput added in v1.5.13

type PutParameterInput struct {

	// 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 `type:"string"`

	// Information about the parameter that you want to add to the system. Optional
	// but recommended.
	//
	// Do not enter personally identifiable information in this field.
	Description *string `type:"string"`

	// The KMS Key ID that you want to use to encrypt a parameter. Either the default
	// AWS Key Management Service (AWS KMS) key automatically assigned to your AWS
	// account or a custom key. Required for parameters that use the SecureString
	// data type.
	//
	// If you don't specify a key ID, the system uses the default key associated
	// with your AWS account.
	//
	//    * To use your default AWS KMS key, choose the SecureString data type,
	//    and do not specify the Key ID when you create the parameter. The system
	//    automatically populates Key ID with your default KMS key.
	//
	//    * To use a custom KMS key, choose the SecureString data type with the
	//    Key ID parameter.
	KeyId *string `min:"1" type:"string"`

	// The fully qualified name of the parameter that you want to add to the system.
	// The fully qualified name includes the complete hierarchy of the parameter
	// path and name. For example: /Dev/DBServer/MySQL/db-string13
	//
	// Naming Constraints:
	//
	//    * Parameter names are case sensitive.
	//
	//    * A parameter name must be unique within an AWS Region
	//
	//    * A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).
	//
	//    * Parameter names can include only the following symbols and letters:
	//    a-zA-Z0-9_.-/
	//
	//    * A parameter name can't include spaces.
	//
	//    * Parameter hierarchies are limited to a maximum depth of fifteen levels.
	//
	// For additional information about valid values for parameter names, see Requirements
	// and Constraints for Parameter Names (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html)
	// in the AWS Systems Manager User Guide.
	//
	// The maximum length constraint listed below includes capacity for additional
	// system attributes that are not part of the name. The maximum length for the
	// fully qualified parameter name is 1011 characters.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Overwrite an existing parameter. If not specified, will default to "false".
	Overwrite *bool `type:"boolean"`

	// One or more policies to apply to a parameter. This action takes a JSON array.
	// Parameter Store 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 does not affect
	// the expiration date and time. When the expiration time is reached, Parameter
	// Store deletes the parameter.
	//
	// ExpirationNotification: This policy triggers an event in Amazon CloudWatch
	// Events that notifies you about the expiration. By using this policy, you
	// can receive notification before or after the expiration time is reached,
	// in units of days or hours.
	//
	// NoChangeNotification: This policy triggers a CloudWatch event if a parameter
	// has not been modified for a specified period of time. This policy type is
	// useful when, for example, a secret needs to be changed within a period of
	// time, but it has not been changed.
	//
	// All existing policies are preserved until you send new policies or an empty
	// policy. For more information about parameter policies, see Working with Parameter
	// Policies (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-policies.html).
	Policies *string `min:"1" type:"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 name/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
	// action.
	Tags []*Tag `type:"list"`

	// Parameter Store offers a standard tier and an advanced tier for parameters.
	// Standard parameters have a value limit of 4 KB and can't be configured to
	// use parameter policies. You can create a maximum of 10,000 standard parameters
	// per account and per Region. Standard parameters are offered at no additional
	// cost.
	//
	// Advanced parameters have a value limit of 8 KB and can be configured to use
	// parameter policies. You can create a maximum of 100,000 advanced parameters
	// per account and per Region. Advanced parameters incur a charge.
	//
	// If you don't specify a parameter tier when you create a new parameter, the
	// parameter defaults to using the standard tier. You can change a standard
	// parameter to an advanced parameter at 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. For more information, see About Advanced
	// Parameters (http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html)
	// in the AWS Systems Manager User Guide.
	Tier *string `type:"string" enum:"ParameterTier"`

	// The type of parameter that you want to add to the system.
	//
	// 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.
	//
	// SecureString is not currently supported for AWS CloudFormation templates
	// or in the China Regions.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ParameterType"`

	// The parameter value that you want to add to the system. Standard parameters
	// have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutParameterInput) GoString added in v1.5.13

func (s PutParameterInput) GoString() string

GoString returns the string representation

func (*PutParameterInput) SetAllowedPattern added in v1.10.1

func (s *PutParameterInput) SetAllowedPattern(v string) *PutParameterInput

SetAllowedPattern sets the AllowedPattern field's value.

func (*PutParameterInput) SetDescription added in v1.5.13

func (s *PutParameterInput) SetDescription(v string) *PutParameterInput

SetDescription sets the Description field's value.

func (*PutParameterInput) SetKeyId added in v1.5.13

func (s *PutParameterInput) SetKeyId(v string) *PutParameterInput

SetKeyId sets the KeyId field's value.

func (*PutParameterInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*PutParameterInput) SetOverwrite added in v1.5.13

func (s *PutParameterInput) SetOverwrite(v bool) *PutParameterInput

SetOverwrite sets the Overwrite field's value.

func (*PutParameterInput) SetPolicies added in v1.99.0

func (s *PutParameterInput) SetPolicies(v string) *PutParameterInput

SetPolicies sets the Policies field's value.

func (*PutParameterInput) SetTags added in v1.99.0

func (s *PutParameterInput) SetTags(v []*Tag) *PutParameterInput

SetTags sets the Tags field's value.

func (*PutParameterInput) SetTier added in v1.99.0

SetTier sets the Tier field's value.

func (*PutParameterInput) SetType added in v1.5.13

SetType sets the Type field's value.

func (*PutParameterInput) SetValue added in v1.5.13

func (s *PutParameterInput) SetValue(v string) *PutParameterInput

SetValue sets the Value field's value.

func (PutParameterInput) String added in v1.5.13

func (s PutParameterInput) String() string

String returns the string representation

func (*PutParameterInput) Validate added in v1.5.13

func (s *PutParameterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutParameterOutput added in v1.5.13

type PutParameterOutput struct {

	// The new version number of a parameter. If you edit a parameter value, Parameter
	// Store automatically creates a new version and assigns this new version a
	// unique ID. You can reference a parameter version ID in API actions or in
	// Systems Manager documents (SSM documents). By default, if you don't specify
	// a specific version, the system returns the latest parameter value when a
	// parameter is called.
	Version *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (PutParameterOutput) GoString added in v1.5.13

func (s PutParameterOutput) GoString() string

GoString returns the string representation

func (*PutParameterOutput) SetVersion added in v1.12.14

func (s *PutParameterOutput) SetVersion(v int64) *PutParameterOutput

SetVersion sets the Version field's value.

func (PutParameterOutput) String added in v1.5.13

func (s PutParameterOutput) String() string

String returns the string representation

type RegisterDefaultPatchBaselineInput added in v1.6.4

type RegisterDefaultPatchBaselineInput struct {

	// The ID of the patch baseline that should be the default patch baseline.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterDefaultPatchBaselineInput) GoString added in v1.6.4

GoString returns the string representation

func (*RegisterDefaultPatchBaselineInput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (RegisterDefaultPatchBaselineInput) String added in v1.6.4

String returns the string representation

func (*RegisterDefaultPatchBaselineInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type RegisterDefaultPatchBaselineOutput added in v1.6.4

type RegisterDefaultPatchBaselineOutput struct {

	// The ID of the default patch baseline.
	BaselineId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterDefaultPatchBaselineOutput) GoString added in v1.6.4

GoString returns the string representation

func (*RegisterDefaultPatchBaselineOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (RegisterDefaultPatchBaselineOutput) String added in v1.6.4

String returns the string representation

type RegisterPatchBaselineForPatchGroupInput added in v1.6.4

type RegisterPatchBaselineForPatchGroupInput struct {

	// The ID of the patch baseline to register the patch group with.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`

	// The name of the patch group that should be registered with the patch baseline.
	//
	// PatchGroup is a required field
	PatchGroup *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterPatchBaselineForPatchGroupInput) GoString added in v1.6.4

GoString returns the string representation

func (*RegisterPatchBaselineForPatchGroupInput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*RegisterPatchBaselineForPatchGroupInput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (RegisterPatchBaselineForPatchGroupInput) String added in v1.6.4

String returns the string representation

func (*RegisterPatchBaselineForPatchGroupInput) Validate added in v1.6.4

Validate inspects the fields of the type to determine if they are valid.

type RegisterPatchBaselineForPatchGroupOutput added in v1.6.4

type RegisterPatchBaselineForPatchGroupOutput struct {

	// The ID of the patch baseline the patch group was registered with.
	BaselineId *string `min:"20" type:"string"`

	// The name of the patch group registered with the patch baseline.
	PatchGroup *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterPatchBaselineForPatchGroupOutput) GoString added in v1.6.4

GoString returns the string representation

func (*RegisterPatchBaselineForPatchGroupOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*RegisterPatchBaselineForPatchGroupOutput) SetPatchGroup added in v1.6.4

SetPatchGroup sets the PatchGroup field's value.

func (RegisterPatchBaselineForPatchGroupOutput) String added in v1.6.4

String returns the string representation

type RegisterTargetWithMaintenanceWindowInput added in v1.5.13

type RegisterTargetWithMaintenanceWindowInput struct {

	// User-provided idempotency token.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// An optional description for the target.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// An optional name for the target.
	Name *string `min:"3" type:"string"`

	// User-provided value that will be included in any CloudWatch events raised
	// while running tasks for these targets in this maintenance window.
	OwnerInformation *string `min:"1" type:"string" sensitive:"true"`

	// The type of target being registered with the maintenance window.
	//
	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true" enum:"MaintenanceWindowResourceType"`

	// The targets to register with the maintenance window. In other words, the
	// instances to run commands on when the maintenance window runs.
	//
	// You can specify targets using instance IDs, resource group names, or tags
	// that have been applied to instances.
	//
	// Example 1: Specify instance IDs
	//
	// Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
	//
	// Example 2: Use tag key-pairs applied to instances
	//
	// Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2
	//
	// Example 3: Use tag-keys applied to instances
	//
	// Key=tag-key,Values=my-tag-key-1,my-tag-key-2
	//
	// Example 4: Use resource group names
	//
	// Key=resource-groups:Name,Values=resource-group-name
	//
	// Example 5: Use filters for resource group types
	//
	// Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
	//
	// 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 AWS Systems Manager User Guide.
	//
	// Targets is a required field
	Targets []*Target `type:"list" required:"true"`

	// The ID of the maintenance window the target should be registered with.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterTargetWithMaintenanceWindowInput) GoString added in v1.5.13

GoString returns the string representation

func (*RegisterTargetWithMaintenanceWindowInput) SetClientToken added in v1.5.13

SetClientToken sets the ClientToken field's value.

func (*RegisterTargetWithMaintenanceWindowInput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*RegisterTargetWithMaintenanceWindowInput) SetName added in v1.10.25

SetName sets the Name field's value.

func (*RegisterTargetWithMaintenanceWindowInput) SetOwnerInformation added in v1.5.13

SetOwnerInformation sets the OwnerInformation field's value.

func (*RegisterTargetWithMaintenanceWindowInput) SetResourceType added in v1.5.13

SetResourceType sets the ResourceType field's value.

func (*RegisterTargetWithMaintenanceWindowInput) SetTargets added in v1.5.13

SetTargets sets the Targets field's value.

func (*RegisterTargetWithMaintenanceWindowInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (RegisterTargetWithMaintenanceWindowInput) String added in v1.5.13

String returns the string representation

func (*RegisterTargetWithMaintenanceWindowInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type RegisterTargetWithMaintenanceWindowOutput added in v1.5.13

type RegisterTargetWithMaintenanceWindowOutput struct {

	// The ID of the target definition in this maintenance window.
	WindowTargetId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterTargetWithMaintenanceWindowOutput) GoString added in v1.5.13

GoString returns the string representation

func (*RegisterTargetWithMaintenanceWindowOutput) SetWindowTargetId added in v1.5.13

SetWindowTargetId sets the WindowTargetId field's value.

func (RegisterTargetWithMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type RegisterTaskWithMaintenanceWindowInput added in v1.5.13

type RegisterTaskWithMaintenanceWindowInput struct {

	// User-provided idempotency token.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// An optional description for the task.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// A structure containing information about an Amazon S3 bucket to write instance-level
	// logs to.
	//
	// LoggingInfo has been deprecated. To specify an S3 bucket to contain logs,
	// instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	LoggingInfo *LoggingInfo `type:"structure"`

	// The maximum number of targets this task can be run for in parallel.
	//
	// MaxConcurrency is a required field
	MaxConcurrency *string `min:"1" type:"string" required:"true"`

	// The maximum number of errors allowed before this task stops being scheduled.
	//
	// MaxErrors is a required field
	MaxErrors *string `min:"1" type:"string" required:"true"`

	// An optional name for the task.
	Name *string `min:"3" type:"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 *int64 `type:"integer"`

	// The ARN of the IAM service role for Systems Manager to assume when running
	// a maintenance window task. If you do not specify a service role ARN, Systems
	// Manager uses your account's service-linked role. If no service-linked role
	// for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
	//
	// For more information, see the following topics in the in the AWS Systems
	// Manager User Guide:
	//
	//    * Service-Linked Role Permissions for Systems Manager (http://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? (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role)
	ServiceRoleArn *string `type:"string"`

	// The targets (either instances or maintenance window targets).
	//
	// Specify instances using the following format:
	//
	// Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
	//
	// Specify maintenance window targets using the following format:
	//
	// Key=WindowTargetIds;,Values=<window-target-id-1>,<window-target-id-2>
	//
	// Targets is a required field
	Targets []*Target `type:"list" required:"true"`

	// The ARN of the task to run.
	//
	// TaskArn is a required field
	TaskArn *string `min:"1" type:"string" required:"true"`

	// 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 *MaintenanceWindowTaskInvocationParameters `type:"structure"`

	// 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]*MaintenanceWindowTaskParameterValueExpression `type:"map" sensitive:"true"`

	// The type of task being registered.
	//
	// TaskType is a required field
	TaskType *string `type:"string" required:"true" enum:"MaintenanceWindowTaskType"`

	// The ID of the maintenance window the task should be added to.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterTaskWithMaintenanceWindowInput) GoString added in v1.5.13

GoString returns the string representation

func (*RegisterTaskWithMaintenanceWindowInput) SetClientToken added in v1.5.13

SetClientToken sets the ClientToken field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetLoggingInfo added in v1.5.13

SetLoggingInfo sets the LoggingInfo field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetMaxConcurrency added in v1.5.13

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetMaxErrors added in v1.5.13

SetMaxErrors sets the MaxErrors field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetName added in v1.10.25

SetName sets the Name field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetPriority added in v1.5.13

SetPriority sets the Priority field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetServiceRoleArn added in v1.5.13

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetTargets added in v1.5.13

SetTargets sets the Targets field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetTaskArn added in v1.5.13

SetTaskArn sets the TaskArn field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetTaskInvocationParameters added in v1.10.25

SetTaskInvocationParameters sets the TaskInvocationParameters field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetTaskParameters added in v1.5.13

SetTaskParameters sets the TaskParameters field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetTaskType added in v1.5.13

SetTaskType sets the TaskType field's value.

func (*RegisterTaskWithMaintenanceWindowInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (RegisterTaskWithMaintenanceWindowInput) String added in v1.5.13

String returns the string representation

func (*RegisterTaskWithMaintenanceWindowInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type RegisterTaskWithMaintenanceWindowOutput added in v1.5.13

type RegisterTaskWithMaintenanceWindowOutput struct {

	// The ID of the task in the maintenance window.
	WindowTaskId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterTaskWithMaintenanceWindowOutput) GoString added in v1.5.13

GoString returns the string representation

func (*RegisterTaskWithMaintenanceWindowOutput) SetWindowTaskId added in v1.5.13

SetWindowTaskId sets the WindowTaskId field's value.

func (RegisterTaskWithMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type RelatedOpsItem added in v1.99.0

type RelatedOpsItem struct {

	// The ID of an OpsItem related to the current OpsItem.
	//
	// OpsItemId is a required field
	OpsItemId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An OpsItems that shares something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

func (RelatedOpsItem) GoString added in v1.99.0

func (s RelatedOpsItem) GoString() string

GoString returns the string representation

func (*RelatedOpsItem) SetOpsItemId added in v1.99.0

func (s *RelatedOpsItem) SetOpsItemId(v string) *RelatedOpsItem

SetOpsItemId sets the OpsItemId field's value.

func (RelatedOpsItem) String added in v1.99.0

func (s RelatedOpsItem) String() string

String returns the string representation

func (*RelatedOpsItem) Validate added in v1.99.0

func (s *RelatedOpsItem) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsFromResourceInput added in v1.2.2

type RemoveTagsFromResourceInput struct {

	// The ID of the resource from which you want to remove tags. For example:
	//
	// ManagedInstance: mi-012345abcde
	//
	// MaintenanceWindow: mw-012345abcde
	//
	// PatchBaseline: pb-012345abcde
	//
	// For the Document and Parameter values, use the name of the resource.
	//
	// The ManagedInstance type for this API action is only for on-premises managed
	// instances. Specify the name of the managed instance in the following format:
	// mi-ID_number. For example, mi-1a2b3c4d5e6f.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// The type of resource from which you want to remove a tag.
	//
	// The ManagedInstance type for this API action is only for on-premises managed
	// instances. Specify the name of the managed instance in the following format:
	// mi-ID_number. For example, mi-1a2b3c4d5e6f.
	//
	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true" enum:"ResourceTypeForTagging"`

	// Tag keys that you want to remove from the specified resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTagsFromResourceInput) GoString added in v1.2.2

func (s RemoveTagsFromResourceInput) GoString() string

GoString returns the string representation

func (*RemoveTagsFromResourceInput) SetResourceId added in v1.5.0

SetResourceId sets the ResourceId field's value.

func (*RemoveTagsFromResourceInput) SetResourceType added in v1.5.0

SetResourceType sets the ResourceType field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys added in v1.5.0

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String added in v1.2.2

String returns the string representation

func (*RemoveTagsFromResourceInput) Validate added in v1.2.2

func (s *RemoveTagsFromResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTagsFromResourceOutput added in v1.2.2

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

func (RemoveTagsFromResourceOutput) GoString added in v1.2.2

func (s RemoveTagsFromResourceOutput) GoString() string

GoString returns the string representation

func (RemoveTagsFromResourceOutput) String added in v1.2.2

String returns the string representation

type ResetServiceSettingInput added in v1.99.0

type ResetServiceSettingInput struct {

	// The ID of the service setting to reset.
	//
	// SettingId is a required field
	SettingId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request body of the ResetServiceSetting API action.

func (ResetServiceSettingInput) GoString added in v1.99.0

func (s ResetServiceSettingInput) GoString() string

GoString returns the string representation

func (*ResetServiceSettingInput) SetSettingId added in v1.99.0

SetSettingId sets the SettingId field's value.

func (ResetServiceSettingInput) String added in v1.99.0

func (s ResetServiceSettingInput) String() string

String returns the string representation

func (*ResetServiceSettingInput) Validate added in v1.99.0

func (s *ResetServiceSettingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResetServiceSettingOutput added in v1.99.0

type ResetServiceSettingOutput struct {

	// The current, effective service setting after calling the ResetServiceSetting
	// API action.
	ServiceSetting *ServiceSetting `type:"structure"`
	// contains filtered or unexported fields
}

The result body of the ResetServiceSetting API action.

func (ResetServiceSettingOutput) GoString added in v1.99.0

func (s ResetServiceSettingOutput) GoString() string

GoString returns the string representation

func (*ResetServiceSettingOutput) SetServiceSetting added in v1.99.0

SetServiceSetting sets the ServiceSetting field's value.

func (ResetServiceSettingOutput) String added in v1.99.0

func (s ResetServiceSettingOutput) String() string

String returns the string representation

type ResolvedTargets added in v1.12.37

type ResolvedTargets struct {

	// A list of parameter values sent to targets that resolved during the Automation
	// execution.
	ParameterValues []*string `type:"list"`

	// A boolean value indicating whether the resolved target list is truncated.
	Truncated *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Information about targets that resolved during the Automation execution.

func (ResolvedTargets) GoString added in v1.12.37

func (s ResolvedTargets) GoString() string

GoString returns the string representation

func (*ResolvedTargets) SetParameterValues added in v1.12.37

func (s *ResolvedTargets) SetParameterValues(v []*string) *ResolvedTargets

SetParameterValues sets the ParameterValues field's value.

func (*ResolvedTargets) SetTruncated added in v1.12.37

func (s *ResolvedTargets) SetTruncated(v bool) *ResolvedTargets

SetTruncated sets the Truncated field's value.

func (ResolvedTargets) String added in v1.12.37

func (s ResolvedTargets) String() string

String returns the string representation

type ResourceComplianceSummaryItem added in v1.10.25

type ResourceComplianceSummaryItem struct {

	// The compliance type.
	ComplianceType *string `min:"1" type:"string"`

	// A list of items that are compliant for the resource.
	CompliantSummary *CompliantSummary `type:"structure"`

	// Information about the execution.
	ExecutionSummary *ComplianceExecutionSummary `type:"structure"`

	// A list of items that aren't compliant for the resource.
	NonCompliantSummary *NonCompliantSummary `type:"structure"`

	// The highest severity item found for the resource. The resource is compliant
	// for this item.
	OverallSeverity *string `type:"string" enum:"ComplianceSeverity"`

	// The resource ID.
	ResourceId *string `min:"1" type:"string"`

	// The resource type.
	ResourceType *string `min:"1" type:"string"`

	// The compliance status for the resource.
	Status *string `type:"string" enum:"ComplianceStatus"`
	// contains filtered or unexported fields
}

Compliance summary information for a specific resource.

func (ResourceComplianceSummaryItem) GoString added in v1.10.25

GoString returns the string representation

func (*ResourceComplianceSummaryItem) SetComplianceType added in v1.10.25

SetComplianceType sets the ComplianceType field's value.

func (*ResourceComplianceSummaryItem) SetCompliantSummary added in v1.10.25

SetCompliantSummary sets the CompliantSummary field's value.

func (*ResourceComplianceSummaryItem) SetExecutionSummary added in v1.10.25

SetExecutionSummary sets the ExecutionSummary field's value.

func (*ResourceComplianceSummaryItem) SetNonCompliantSummary added in v1.10.25

SetNonCompliantSummary sets the NonCompliantSummary field's value.

func (*ResourceComplianceSummaryItem) SetOverallSeverity added in v1.10.25

SetOverallSeverity sets the OverallSeverity field's value.

func (*ResourceComplianceSummaryItem) SetResourceId added in v1.10.25

SetResourceId sets the ResourceId field's value.

func (*ResourceComplianceSummaryItem) SetResourceType added in v1.10.25

SetResourceType sets the ResourceType field's value.

func (*ResourceComplianceSummaryItem) SetStatus added in v1.10.25

SetStatus sets the Status field's value.

func (ResourceComplianceSummaryItem) String added in v1.10.25

String returns the string representation

type ResourceDataSyncItem added in v1.10.5

type ResourceDataSyncItem struct {

	// The status reported by the last sync.
	LastStatus *string `type:"string" enum:"LastResourceDataSyncStatus"`

	// The last time the sync operations returned a status of SUCCESSFUL (UTC).
	LastSuccessfulSyncTime *time.Time `type:"timestamp"`

	// The status message details reported by the last sync.
	LastSyncStatusMessage *string `type:"string"`

	// The last time the configuration attempted to sync (UTC).
	LastSyncTime *time.Time `type:"timestamp"`

	// Configuration information for the target Amazon S3 bucket.
	S3Destination *ResourceDataSyncS3Destination `type:"structure"`

	// The date and time the configuration was created (UTC).
	SyncCreatedTime *time.Time `type:"timestamp"`

	// The name of the Resource Data Sync.
	SyncName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about a Resource Data Sync configuration, including its current status and last successful sync.

func (ResourceDataSyncItem) GoString added in v1.10.5

func (s ResourceDataSyncItem) GoString() string

GoString returns the string representation

func (*ResourceDataSyncItem) SetLastStatus added in v1.10.5

func (s *ResourceDataSyncItem) SetLastStatus(v string) *ResourceDataSyncItem

SetLastStatus sets the LastStatus field's value.

func (*ResourceDataSyncItem) SetLastSuccessfulSyncTime added in v1.10.5

func (s *ResourceDataSyncItem) SetLastSuccessfulSyncTime(v time.Time) *ResourceDataSyncItem

SetLastSuccessfulSyncTime sets the LastSuccessfulSyncTime field's value.

func (*ResourceDataSyncItem) SetLastSyncStatusMessage added in v1.13.8

func (s *ResourceDataSyncItem) SetLastSyncStatusMessage(v string) *ResourceDataSyncItem

SetLastSyncStatusMessage sets the LastSyncStatusMessage field's value.

func (*ResourceDataSyncItem) SetLastSyncTime added in v1.10.5

func (s *ResourceDataSyncItem) SetLastSyncTime(v time.Time) *ResourceDataSyncItem

SetLastSyncTime sets the LastSyncTime field's value.

func (*ResourceDataSyncItem) SetS3Destination added in v1.10.5

SetS3Destination sets the S3Destination field's value.

func (*ResourceDataSyncItem) SetSyncCreatedTime added in v1.10.5

func (s *ResourceDataSyncItem) SetSyncCreatedTime(v time.Time) *ResourceDataSyncItem

SetSyncCreatedTime sets the SyncCreatedTime field's value.

func (*ResourceDataSyncItem) SetSyncName added in v1.10.5

SetSyncName sets the SyncName field's value.

func (ResourceDataSyncItem) String added in v1.10.5

func (s ResourceDataSyncItem) String() string

String returns the string representation

type ResourceDataSyncS3Destination added in v1.10.5

type ResourceDataSyncS3Destination struct {

	// The ARN of an encryption key for a destination in Amazon S3. Must belong
	// to the same Region as the destination Amazon S3 bucket.
	AWSKMSKeyARN *string `min:"1" type:"string"`

	// The name of the Amazon S3 bucket where the aggregated data is stored.
	//
	// BucketName is a required field
	BucketName *string `min:"1" type:"string" required:"true"`

	// An Amazon S3 prefix for the bucket.
	Prefix *string `min:"1" type:"string"`

	// The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.
	//
	// Region is a required field
	Region *string `min:"1" type:"string" required:"true"`

	// A supported sync format. The following format is currently supported: JsonSerDe
	//
	// SyncFormat is a required field
	SyncFormat *string `type:"string" required:"true" enum:"ResourceDataSyncS3Format"`
	// contains filtered or unexported fields
}

Information about the target Amazon S3 bucket for the Resource Data Sync.

func (ResourceDataSyncS3Destination) GoString added in v1.10.5

GoString returns the string representation

func (*ResourceDataSyncS3Destination) SetAWSKMSKeyARN added in v1.10.37

SetAWSKMSKeyARN sets the AWSKMSKeyARN field's value.

func (*ResourceDataSyncS3Destination) SetBucketName added in v1.10.5

SetBucketName sets the BucketName field's value.

func (*ResourceDataSyncS3Destination) SetPrefix added in v1.10.5

SetPrefix sets the Prefix field's value.

func (*ResourceDataSyncS3Destination) SetRegion added in v1.10.5

SetRegion sets the Region field's value.

func (*ResourceDataSyncS3Destination) SetSyncFormat added in v1.10.5

SetSyncFormat sets the SyncFormat field's value.

func (ResourceDataSyncS3Destination) String added in v1.10.5

String returns the string representation

func (*ResourceDataSyncS3Destination) Validate added in v1.10.5

func (s *ResourceDataSyncS3Destination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResultAttribute added in v1.5.13

type ResultAttribute struct {

	// Name of the inventory item type. Valid value: AWS:InstanceInformation. Default
	// Value: AWS:InstanceInformation.
	//
	// TypeName is a required field
	TypeName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The inventory item result attribute.

func (ResultAttribute) GoString added in v1.5.13

func (s ResultAttribute) GoString() string

GoString returns the string representation

func (*ResultAttribute) SetTypeName added in v1.5.13

func (s *ResultAttribute) SetTypeName(v string) *ResultAttribute

SetTypeName sets the TypeName field's value.

func (ResultAttribute) String added in v1.5.13

func (s ResultAttribute) String() string

String returns the string representation

func (*ResultAttribute) Validate added in v1.5.13

func (s *ResultAttribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResumeSessionInput added in v1.99.0

type ResumeSessionInput struct {

	// The ID of the disconnected session to resume.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResumeSessionInput) GoString added in v1.99.0

func (s ResumeSessionInput) GoString() string

GoString returns the string representation

func (*ResumeSessionInput) SetSessionId added in v1.99.0

func (s *ResumeSessionInput) SetSessionId(v string) *ResumeSessionInput

SetSessionId sets the SessionId field's value.

func (ResumeSessionInput) String added in v1.99.0

func (s ResumeSessionInput) String() string

String returns the string representation

func (*ResumeSessionInput) Validate added in v1.99.0

func (s *ResumeSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResumeSessionOutput added in v1.99.0

type ResumeSessionOutput struct {

	// The ID of the session.
	SessionId *string `min:"1" type:"string"`

	// A URL back to SSM Agent on the instance that the Session Manager client uses
	// to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).
	//
	// region represents the Region identifier for an AWS Region supported by AWS
	// Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list
	// of supported region values, see the Region column in the AWS Systems Manager
	// table of regions and endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#ssm_region)
	// in the AWS General Reference.
	//
	// session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
	StreamUrl *string `type:"string"`

	// An encrypted token value containing session and caller information. Used
	// to authenticate the connection to the instance.
	TokenValue *string `type:"string"`
	// contains filtered or unexported fields
}

func (ResumeSessionOutput) GoString added in v1.99.0

func (s ResumeSessionOutput) GoString() string

GoString returns the string representation

func (*ResumeSessionOutput) SetSessionId added in v1.99.0

func (s *ResumeSessionOutput) SetSessionId(v string) *ResumeSessionOutput

SetSessionId sets the SessionId field's value.

func (*ResumeSessionOutput) SetStreamUrl added in v1.99.0

func (s *ResumeSessionOutput) SetStreamUrl(v string) *ResumeSessionOutput

SetStreamUrl sets the StreamUrl field's value.

func (*ResumeSessionOutput) SetTokenValue added in v1.99.0

func (s *ResumeSessionOutput) SetTokenValue(v string) *ResumeSessionOutput

SetTokenValue sets the TokenValue field's value.

func (ResumeSessionOutput) String added in v1.99.0

func (s ResumeSessionOutput) String() string

String returns the string representation

type S3OutputLocation added in v1.5.13

type S3OutputLocation struct {

	// The name of the Amazon S3 bucket.
	OutputS3BucketName *string `min:"3" type:"string"`

	// The Amazon S3 bucket subfolder.
	OutputS3KeyPrefix *string `type:"string"`

	// (Deprecated) You can no longer specify this parameter. The system ignores
	// it. Instead, Systems Manager automatically determines the Amazon S3 bucket
	// region.
	OutputS3Region *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

An Amazon S3 bucket where you want to store the results of this request.

func (S3OutputLocation) GoString added in v1.5.13

func (s S3OutputLocation) GoString() string

GoString returns the string representation

func (*S3OutputLocation) SetOutputS3BucketName added in v1.5.13

func (s *S3OutputLocation) SetOutputS3BucketName(v string) *S3OutputLocation

SetOutputS3BucketName sets the OutputS3BucketName field's value.

func (*S3OutputLocation) SetOutputS3KeyPrefix added in v1.5.13

func (s *S3OutputLocation) SetOutputS3KeyPrefix(v string) *S3OutputLocation

SetOutputS3KeyPrefix sets the OutputS3KeyPrefix field's value.

func (*S3OutputLocation) SetOutputS3Region added in v1.5.13

func (s *S3OutputLocation) SetOutputS3Region(v string) *S3OutputLocation

SetOutputS3Region sets the OutputS3Region field's value.

func (S3OutputLocation) String added in v1.5.13

func (s S3OutputLocation) String() string

String returns the string representation

func (*S3OutputLocation) Validate added in v1.5.13

func (s *S3OutputLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3OutputUrl added in v1.5.13

type S3OutputUrl struct {

	// A URL for an Amazon S3 bucket where you want to store the results of this
	// request.
	OutputUrl *string `type:"string"`
	// contains filtered or unexported fields
}

A URL for the Amazon S3 bucket where you want to store the results of this request.

func (S3OutputUrl) GoString added in v1.5.13

func (s S3OutputUrl) GoString() string

GoString returns the string representation

func (*S3OutputUrl) SetOutputUrl added in v1.5.13

func (s *S3OutputUrl) SetOutputUrl(v string) *S3OutputUrl

SetOutputUrl sets the OutputUrl field's value.

func (S3OutputUrl) String added in v1.5.13

func (s S3OutputUrl) String() string

String returns the string representation

type SSM

type SSM struct {
	*client.Client
}

SSM provides the API operation methods for making requests to Amazon Simple Systems Manager (SSM). See this package's package overview docs for details on the service.

SSM methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SSM

New creates a new instance of the SSM client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a SSM client from just a session.
svc := ssm.New(mySession)

// Create a SSM client with additional configuration
svc := ssm.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SSM) AddTagsToResource added in v1.2.2

func (c *SSM) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)

AddTagsToResource API operation for Amazon Simple Systems Manager (SSM).

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.

Each resource can have a maximum of 50 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the Amazon EC2 User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidResourceType "InvalidResourceType" The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeTooManyTagsError "TooManyTagsError" The Targets parameter includes too many tags. Remove one or more tags and try the command again.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AddTagsToResource

func (*SSM) AddTagsToResourceRequest added in v1.2.2

func (c *SSM) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)

AddTagsToResourceRequest generates a "aws/request.Request" representing the client's request for the AddTagsToResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTagsToResource for more information on using the AddTagsToResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddTagsToResourceRequest method.
req, resp := client.AddTagsToResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/AddTagsToResource

func (*SSM) AddTagsToResourceWithContext added in v1.8.0

func (c *SSM) AddTagsToResourceWithContext(ctx aws.Context, input *AddTagsToResourceInput, opts ...request.Option) (*AddTagsToResourceOutput, error)

AddTagsToResourceWithContext is the same as AddTagsToResource with the addition of the ability to pass a context and additional request options.

See AddTagsToResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CancelCommand added in v0.9.17

func (c *SSM) CancelCommand(input *CancelCommandInput) (*CancelCommandOutput, error)

CancelCommand API operation for Amazon Simple Systems Manager (SSM).

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CancelCommand for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidCommandId "InvalidCommandId"

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeDuplicateInstanceId "DuplicateInstanceId" You cannot specify an instance ID in more than one association.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelCommand

func (*SSM) CancelCommandRequest added in v0.9.17

func (c *SSM) CancelCommandRequest(input *CancelCommandInput) (req *request.Request, output *CancelCommandOutput)

CancelCommandRequest generates a "aws/request.Request" representing the client's request for the CancelCommand operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelCommand for more information on using the CancelCommand API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelCommandRequest method.
req, resp := client.CancelCommandRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelCommand

func (*SSM) CancelCommandWithContext added in v1.8.0

func (c *SSM) CancelCommandWithContext(ctx aws.Context, input *CancelCommandInput, opts ...request.Option) (*CancelCommandOutput, error)

CancelCommandWithContext is the same as CancelCommand with the addition of the ability to pass a context and additional request options.

See CancelCommand for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CancelMaintenanceWindowExecution added in v1.99.0

func (c *SSM) CancelMaintenanceWindowExecution(input *CancelMaintenanceWindowExecutionInput) (*CancelMaintenanceWindowExecutionOutput, error)

CancelMaintenanceWindowExecution API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CancelMaintenanceWindowExecution for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelMaintenanceWindowExecution

func (*SSM) CancelMaintenanceWindowExecutionRequest added in v1.99.0

func (c *SSM) CancelMaintenanceWindowExecutionRequest(input *CancelMaintenanceWindowExecutionInput) (req *request.Request, output *CancelMaintenanceWindowExecutionOutput)

CancelMaintenanceWindowExecutionRequest generates a "aws/request.Request" representing the client's request for the CancelMaintenanceWindowExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelMaintenanceWindowExecution for more information on using the CancelMaintenanceWindowExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelMaintenanceWindowExecutionRequest method.
req, resp := client.CancelMaintenanceWindowExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CancelMaintenanceWindowExecution

func (*SSM) CancelMaintenanceWindowExecutionWithContext added in v1.99.0

func (c *SSM) CancelMaintenanceWindowExecutionWithContext(ctx aws.Context, input *CancelMaintenanceWindowExecutionInput, opts ...request.Option) (*CancelMaintenanceWindowExecutionOutput, error)

CancelMaintenanceWindowExecutionWithContext is the same as CancelMaintenanceWindowExecution with the addition of the ability to pass a context and additional request options.

See CancelMaintenanceWindowExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreateActivation added in v1.2.2

func (c *SSM) CreateActivation(input *CreateActivationInput) (*CreateActivationOutput, error)

CreateActivation API operation for Amazon Simple Systems Manager (SSM).

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up AWS Systems Manager for Hybrid Environments (http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreateActivation for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateActivation

func (*SSM) CreateActivationRequest added in v1.2.2

func (c *SSM) CreateActivationRequest(input *CreateActivationInput) (req *request.Request, output *CreateActivationOutput)

CreateActivationRequest generates a "aws/request.Request" representing the client's request for the CreateActivation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateActivation for more information on using the CreateActivation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateActivationRequest method.
req, resp := client.CreateActivationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateActivation

func (*SSM) CreateActivationWithContext added in v1.8.0

func (c *SSM) CreateActivationWithContext(ctx aws.Context, input *CreateActivationInput, opts ...request.Option) (*CreateActivationOutput, error)

CreateActivationWithContext is the same as CreateActivation with the addition of the ability to pass a context and additional request options.

See CreateActivation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreateAssociation

func (c *SSM) CreateAssociation(input *CreateAssociationInput) (*CreateAssociationOutput, error)

CreateAssociation API operation for Amazon Simple Systems Manager (SSM).

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreateAssociation for usage and error information.

Returned Error Codes:

  • ErrCodeAssociationAlreadyExists "AssociationAlreadyExists" The specified association already exists.

  • ErrCodeAssociationLimitExceeded "AssociationLimitExceeded" You can have at most 2,000 active associations.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeUnsupportedPlatformType "UnsupportedPlatformType" The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

  • ErrCodeInvalidOutputLocation "InvalidOutputLocation" The output location is not valid or does not exist.

  • ErrCodeInvalidParameters "InvalidParameters" You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

  • ErrCodeInvalidTarget "InvalidTarget" The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

  • ErrCodeInvalidSchedule "InvalidSchedule" The schedule is invalid. Verify your cron or rate expression and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociation

func (*SSM) CreateAssociationBatch

func (c *SSM) CreateAssociationBatch(input *CreateAssociationBatchInput) (*CreateAssociationBatchOutput, error)

CreateAssociationBatch API operation for Amazon Simple Systems Manager (SSM).

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreateAssociationBatch for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidParameters "InvalidParameters" You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

  • ErrCodeDuplicateInstanceId "DuplicateInstanceId" You cannot specify an instance ID in more than one association.

  • ErrCodeAssociationLimitExceeded "AssociationLimitExceeded" You can have at most 2,000 active associations.

  • ErrCodeUnsupportedPlatformType "UnsupportedPlatformType" The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

  • ErrCodeInvalidOutputLocation "InvalidOutputLocation" The output location is not valid or does not exist.

  • ErrCodeInvalidTarget "InvalidTarget" The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

  • ErrCodeInvalidSchedule "InvalidSchedule" The schedule is invalid. Verify your cron or rate expression and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationBatch

func (*SSM) CreateAssociationBatchRequest

func (c *SSM) CreateAssociationBatchRequest(input *CreateAssociationBatchInput) (req *request.Request, output *CreateAssociationBatchOutput)

CreateAssociationBatchRequest generates a "aws/request.Request" representing the client's request for the CreateAssociationBatch operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAssociationBatch for more information on using the CreateAssociationBatch API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAssociationBatchRequest method.
req, resp := client.CreateAssociationBatchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociationBatch

func (*SSM) CreateAssociationBatchWithContext added in v1.8.0

func (c *SSM) CreateAssociationBatchWithContext(ctx aws.Context, input *CreateAssociationBatchInput, opts ...request.Option) (*CreateAssociationBatchOutput, error)

CreateAssociationBatchWithContext is the same as CreateAssociationBatch with the addition of the ability to pass a context and additional request options.

See CreateAssociationBatch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreateAssociationRequest

func (c *SSM) CreateAssociationRequest(input *CreateAssociationInput) (req *request.Request, output *CreateAssociationOutput)

CreateAssociationRequest generates a "aws/request.Request" representing the client's request for the CreateAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAssociation for more information on using the CreateAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAssociationRequest method.
req, resp := client.CreateAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateAssociation

func (*SSM) CreateAssociationWithContext added in v1.8.0

func (c *SSM) CreateAssociationWithContext(ctx aws.Context, input *CreateAssociationInput, opts ...request.Option) (*CreateAssociationOutput, error)

CreateAssociationWithContext is the same as CreateAssociation with the addition of the ability to pass a context and additional request options.

See CreateAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreateDocument

func (c *SSM) CreateDocument(input *CreateDocumentInput) (*CreateDocumentOutput, error)

CreateDocument API operation for Amazon Simple Systems Manager (SSM).

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreateDocument for usage and error information.

Returned Error Codes:

  • ErrCodeDocumentAlreadyExists "DocumentAlreadyExists" The specified document already exists.

  • ErrCodeMaxDocumentSizeExceeded "MaxDocumentSizeExceeded" The size limit of a document is 64 KB.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocumentContent "InvalidDocumentContent" The content for the document is not valid.

  • ErrCodeDocumentLimitExceeded "DocumentLimitExceeded" You can have at most 500 active Systems Manager documents.

  • ErrCodeInvalidDocumentSchemaVersion "InvalidDocumentSchemaVersion" The version of the document schema is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateDocument

func (*SSM) CreateDocumentRequest

func (c *SSM) CreateDocumentRequest(input *CreateDocumentInput) (req *request.Request, output *CreateDocumentOutput)

CreateDocumentRequest generates a "aws/request.Request" representing the client's request for the CreateDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDocument for more information on using the CreateDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDocumentRequest method.
req, resp := client.CreateDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateDocument

func (*SSM) CreateDocumentWithContext added in v1.8.0

func (c *SSM) CreateDocumentWithContext(ctx aws.Context, input *CreateDocumentInput, opts ...request.Option) (*CreateDocumentOutput, error)

CreateDocumentWithContext is the same as CreateDocument with the addition of the ability to pass a context and additional request options.

See CreateDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreateMaintenanceWindow added in v1.5.13

func (c *SSM) CreateMaintenanceWindow(input *CreateMaintenanceWindowInput) (*CreateMaintenanceWindowOutput, error)

CreateMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Creates a new maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreateMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeIdempotentParameterMismatch "IdempotentParameterMismatch" Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

  • ErrCodeResourceLimitExceededException "ResourceLimitExceededException" Error returned when the caller has exceeded the default resource limits. For example, too many maintenance windows or patch baselines have been created.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateMaintenanceWindow

func (*SSM) CreateMaintenanceWindowRequest added in v1.5.13

func (c *SSM) CreateMaintenanceWindowRequest(input *CreateMaintenanceWindowInput) (req *request.Request, output *CreateMaintenanceWindowOutput)

CreateMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the CreateMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMaintenanceWindow for more information on using the CreateMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateMaintenanceWindowRequest method.
req, resp := client.CreateMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateMaintenanceWindow

func (*SSM) CreateMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) CreateMaintenanceWindowWithContext(ctx aws.Context, input *CreateMaintenanceWindowInput, opts ...request.Option) (*CreateMaintenanceWindowOutput, error)

CreateMaintenanceWindowWithContext is the same as CreateMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See CreateMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreateOpsItem added in v1.99.0

func (c *SSM) CreateOpsItem(input *CreateOpsItemInput) (*CreateOpsItemOutput, error)

CreateOpsItem API operation for Amazon Simple Systems Manager (SSM).

Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting Started with OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreateOpsItem for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeOpsItemAlreadyExistsException "OpsItemAlreadyExistsException" The OpsItem already exists.

  • ErrCodeOpsItemLimitExceededException "OpsItemLimitExceededException" The request caused OpsItems to exceed one or more limits. For information about OpsItem limits, see What are the resource limits for OpsCenter? (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits).

  • ErrCodeOpsItemInvalidParameterException "OpsItemInvalidParameterException" A specified parameter argument isn't valid. Verify the available arguments and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsItem

func (*SSM) CreateOpsItemRequest added in v1.99.0

func (c *SSM) CreateOpsItemRequest(input *CreateOpsItemInput) (req *request.Request, output *CreateOpsItemOutput)

CreateOpsItemRequest generates a "aws/request.Request" representing the client's request for the CreateOpsItem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateOpsItem for more information on using the CreateOpsItem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateOpsItemRequest method.
req, resp := client.CreateOpsItemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateOpsItem

func (*SSM) CreateOpsItemWithContext added in v1.99.0

func (c *SSM) CreateOpsItemWithContext(ctx aws.Context, input *CreateOpsItemInput, opts ...request.Option) (*CreateOpsItemOutput, error)

CreateOpsItemWithContext is the same as CreateOpsItem with the addition of the ability to pass a context and additional request options.

See CreateOpsItem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreatePatchBaseline added in v1.6.4

func (c *SSM) CreatePatchBaseline(input *CreatePatchBaselineInput) (*CreatePatchBaselineOutput, error)

CreatePatchBaseline API operation for Amazon Simple Systems Manager (SSM).

Creates a patch baseline.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreatePatchBaseline for usage and error information.

Returned Error Codes:

  • ErrCodeIdempotentParameterMismatch "IdempotentParameterMismatch" Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

  • ErrCodeResourceLimitExceededException "ResourceLimitExceededException" Error returned when the caller has exceeded the default resource limits. For example, too many maintenance windows or patch baselines have been created.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreatePatchBaseline

func (*SSM) CreatePatchBaselineRequest added in v1.6.4

func (c *SSM) CreatePatchBaselineRequest(input *CreatePatchBaselineInput) (req *request.Request, output *CreatePatchBaselineOutput)

CreatePatchBaselineRequest generates a "aws/request.Request" representing the client's request for the CreatePatchBaseline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePatchBaseline for more information on using the CreatePatchBaseline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreatePatchBaselineRequest method.
req, resp := client.CreatePatchBaselineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreatePatchBaseline

func (*SSM) CreatePatchBaselineWithContext added in v1.8.0

func (c *SSM) CreatePatchBaselineWithContext(ctx aws.Context, input *CreatePatchBaselineInput, opts ...request.Option) (*CreatePatchBaselineOutput, error)

CreatePatchBaselineWithContext is the same as CreatePatchBaseline with the addition of the ability to pass a context and additional request options.

See CreatePatchBaseline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) CreateResourceDataSync added in v1.10.5

func (c *SSM) CreateResourceDataSync(input *CreateResourceDataSyncInput) (*CreateResourceDataSyncOutput, error)

CreateResourceDataSync API operation for Amazon Simple Systems Manager (SSM).

Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html) in the AWS Systems Manager User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation CreateResourceDataSync for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeResourceDataSyncCountExceededException "ResourceDataSyncCountExceededException" You have exceeded the allowed maximum sync configurations.

  • ErrCodeResourceDataSyncAlreadyExistsException "ResourceDataSyncAlreadyExistsException" A sync configuration with the same name already exists.

  • ErrCodeResourceDataSyncInvalidConfigurationException "ResourceDataSyncInvalidConfigurationException" The specified sync configuration is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateResourceDataSync

func (*SSM) CreateResourceDataSyncRequest added in v1.10.5

func (c *SSM) CreateResourceDataSyncRequest(input *CreateResourceDataSyncInput) (req *request.Request, output *CreateResourceDataSyncOutput)

CreateResourceDataSyncRequest generates a "aws/request.Request" representing the client's request for the CreateResourceDataSync operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateResourceDataSync for more information on using the CreateResourceDataSync API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateResourceDataSyncRequest method.
req, resp := client.CreateResourceDataSyncRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/CreateResourceDataSync

func (*SSM) CreateResourceDataSyncWithContext added in v1.10.5

func (c *SSM) CreateResourceDataSyncWithContext(ctx aws.Context, input *CreateResourceDataSyncInput, opts ...request.Option) (*CreateResourceDataSyncOutput, error)

CreateResourceDataSyncWithContext is the same as CreateResourceDataSync with the addition of the ability to pass a context and additional request options.

See CreateResourceDataSync for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteActivation added in v1.2.2

func (c *SSM) DeleteActivation(input *DeleteActivationInput) (*DeleteActivationOutput, error)

DeleteActivation API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteActivation for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidActivationId "InvalidActivationId" The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.

  • ErrCodeInvalidActivation "InvalidActivation" The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteActivation

func (*SSM) DeleteActivationRequest added in v1.2.2

func (c *SSM) DeleteActivationRequest(input *DeleteActivationInput) (req *request.Request, output *DeleteActivationOutput)

DeleteActivationRequest generates a "aws/request.Request" representing the client's request for the DeleteActivation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteActivation for more information on using the DeleteActivation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteActivationRequest method.
req, resp := client.DeleteActivationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteActivation

func (*SSM) DeleteActivationWithContext added in v1.8.0

func (c *SSM) DeleteActivationWithContext(ctx aws.Context, input *DeleteActivationInput, opts ...request.Option) (*DeleteActivationOutput, error)

DeleteActivationWithContext is the same as DeleteActivation with the addition of the ability to pass a context and additional request options.

See DeleteActivation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteAssociation

func (c *SSM) DeleteAssociation(input *DeleteAssociationInput) (*DeleteAssociationOutput, error)

DeleteAssociation API operation for Amazon Simple Systems Manager (SSM).

Disassociates the specified Systems Manager document from the specified instance.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteAssociation for usage and error information.

Returned Error Codes:

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteAssociation

func (*SSM) DeleteAssociationRequest

func (c *SSM) DeleteAssociationRequest(input *DeleteAssociationInput) (req *request.Request, output *DeleteAssociationOutput)

DeleteAssociationRequest generates a "aws/request.Request" representing the client's request for the DeleteAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAssociation for more information on using the DeleteAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAssociationRequest method.
req, resp := client.DeleteAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteAssociation

func (*SSM) DeleteAssociationWithContext added in v1.8.0

func (c *SSM) DeleteAssociationWithContext(ctx aws.Context, input *DeleteAssociationInput, opts ...request.Option) (*DeleteAssociationOutput, error)

DeleteAssociationWithContext is the same as DeleteAssociation with the addition of the ability to pass a context and additional request options.

See DeleteAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteDocument

func (c *SSM) DeleteDocument(input *DeleteDocumentInput) (*DeleteDocumentOutput, error)

DeleteDocument API operation for Amazon Simple Systems Manager (SSM).

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteDocument for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentOperation "InvalidDocumentOperation" You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

  • ErrCodeAssociatedInstances "AssociatedInstances" You must disassociate a document from all instances before you can delete it.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteDocument

func (*SSM) DeleteDocumentRequest

func (c *SSM) DeleteDocumentRequest(input *DeleteDocumentInput) (req *request.Request, output *DeleteDocumentOutput)

DeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the DeleteDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDocument for more information on using the DeleteDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDocumentRequest method.
req, resp := client.DeleteDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteDocument

func (*SSM) DeleteDocumentWithContext added in v1.8.0

func (c *SSM) DeleteDocumentWithContext(ctx aws.Context, input *DeleteDocumentInput, opts ...request.Option) (*DeleteDocumentOutput, error)

DeleteDocumentWithContext is the same as DeleteDocument with the addition of the ability to pass a context and additional request options.

See DeleteDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteInventory added in v1.13.33

func (c *SSM) DeleteInventory(input *DeleteInventoryInput) (*DeleteInventoryOutput, error)

DeleteInventory API operation for Amazon Simple Systems Manager (SSM).

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteInventory for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidTypeNameException "InvalidTypeNameException" The parameter type name is not valid.

  • ErrCodeInvalidOptionException "InvalidOptionException" The delete inventory option specified is not valid. Verify the option and try again.

  • ErrCodeInvalidDeleteInventoryParametersException "InvalidDeleteInventoryParametersException" One or more of the parameters specified for the delete operation is not valid. Verify all parameters and try again.

  • ErrCodeInvalidInventoryRequestException "InvalidInventoryRequestException" The request is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteInventory

func (*SSM) DeleteInventoryRequest added in v1.13.33

func (c *SSM) DeleteInventoryRequest(input *DeleteInventoryInput) (req *request.Request, output *DeleteInventoryOutput)

DeleteInventoryRequest generates a "aws/request.Request" representing the client's request for the DeleteInventory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteInventory for more information on using the DeleteInventory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteInventoryRequest method.
req, resp := client.DeleteInventoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteInventory

func (*SSM) DeleteInventoryWithContext added in v1.13.33

func (c *SSM) DeleteInventoryWithContext(ctx aws.Context, input *DeleteInventoryInput, opts ...request.Option) (*DeleteInventoryOutput, error)

DeleteInventoryWithContext is the same as DeleteInventory with the addition of the ability to pass a context and additional request options.

See DeleteInventory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteMaintenanceWindow added in v1.5.13

func (c *SSM) DeleteMaintenanceWindow(input *DeleteMaintenanceWindowInput) (*DeleteMaintenanceWindowOutput, error)

DeleteMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Deletes a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteMaintenanceWindow

func (*SSM) DeleteMaintenanceWindowRequest added in v1.5.13

func (c *SSM) DeleteMaintenanceWindowRequest(input *DeleteMaintenanceWindowInput) (req *request.Request, output *DeleteMaintenanceWindowOutput)

DeleteMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the DeleteMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMaintenanceWindow for more information on using the DeleteMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteMaintenanceWindowRequest method.
req, resp := client.DeleteMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteMaintenanceWindow

func (*SSM) DeleteMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) DeleteMaintenanceWindowWithContext(ctx aws.Context, input *DeleteMaintenanceWindowInput, opts ...request.Option) (*DeleteMaintenanceWindowOutput, error)

DeleteMaintenanceWindowWithContext is the same as DeleteMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See DeleteMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteParameter added in v1.5.13

func (c *SSM) DeleteParameter(input *DeleteParameterInput) (*DeleteParameterOutput, error)

DeleteParameter API operation for Amazon Simple Systems Manager (SSM).

Delete a parameter from the system.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteParameter for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeParameterNotFound "ParameterNotFound" The parameter could not be found. Verify the name and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteParameter

func (*SSM) DeleteParameterRequest added in v1.5.13

func (c *SSM) DeleteParameterRequest(input *DeleteParameterInput) (req *request.Request, output *DeleteParameterOutput)

DeleteParameterRequest generates a "aws/request.Request" representing the client's request for the DeleteParameter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteParameter for more information on using the DeleteParameter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteParameterRequest method.
req, resp := client.DeleteParameterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteParameter

func (*SSM) DeleteParameterWithContext added in v1.8.0

func (c *SSM) DeleteParameterWithContext(ctx aws.Context, input *DeleteParameterInput, opts ...request.Option) (*DeleteParameterOutput, error)

DeleteParameterWithContext is the same as DeleteParameter with the addition of the ability to pass a context and additional request options.

See DeleteParameter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteParameters added in v1.10.1

func (c *SSM) DeleteParameters(input *DeleteParametersInput) (*DeleteParametersOutput, error)

DeleteParameters API operation for Amazon Simple Systems Manager (SSM).

Delete a list of parameters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteParameters for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteParameters

func (*SSM) DeleteParametersRequest added in v1.10.1

func (c *SSM) DeleteParametersRequest(input *DeleteParametersInput) (req *request.Request, output *DeleteParametersOutput)

DeleteParametersRequest generates a "aws/request.Request" representing the client's request for the DeleteParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteParameters for more information on using the DeleteParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteParametersRequest method.
req, resp := client.DeleteParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteParameters

func (*SSM) DeleteParametersWithContext added in v1.10.1

func (c *SSM) DeleteParametersWithContext(ctx aws.Context, input *DeleteParametersInput, opts ...request.Option) (*DeleteParametersOutput, error)

DeleteParametersWithContext is the same as DeleteParameters with the addition of the ability to pass a context and additional request options.

See DeleteParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeletePatchBaseline added in v1.6.4

func (c *SSM) DeletePatchBaseline(input *DeletePatchBaselineInput) (*DeletePatchBaselineOutput, error)

DeletePatchBaseline API operation for Amazon Simple Systems Manager (SSM).

Deletes a patch baseline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeletePatchBaseline for usage and error information.

Returned Error Codes:

  • ErrCodeResourceInUseException "ResourceInUseException" Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeletePatchBaseline

func (*SSM) DeletePatchBaselineRequest added in v1.6.4

func (c *SSM) DeletePatchBaselineRequest(input *DeletePatchBaselineInput) (req *request.Request, output *DeletePatchBaselineOutput)

DeletePatchBaselineRequest generates a "aws/request.Request" representing the client's request for the DeletePatchBaseline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePatchBaseline for more information on using the DeletePatchBaseline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeletePatchBaselineRequest method.
req, resp := client.DeletePatchBaselineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeletePatchBaseline

func (*SSM) DeletePatchBaselineWithContext added in v1.8.0

func (c *SSM) DeletePatchBaselineWithContext(ctx aws.Context, input *DeletePatchBaselineInput, opts ...request.Option) (*DeletePatchBaselineOutput, error)

DeletePatchBaselineWithContext is the same as DeletePatchBaseline with the addition of the ability to pass a context and additional request options.

See DeletePatchBaseline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeleteResourceDataSync added in v1.10.5

func (c *SSM) DeleteResourceDataSync(input *DeleteResourceDataSyncInput) (*DeleteResourceDataSyncOutput, error)

DeleteResourceDataSync API operation for Amazon Simple Systems Manager (SSM).

Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeleteResourceDataSync for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeResourceDataSyncNotFoundException "ResourceDataSyncNotFoundException" The specified sync name was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteResourceDataSync

func (*SSM) DeleteResourceDataSyncRequest added in v1.10.5

func (c *SSM) DeleteResourceDataSyncRequest(input *DeleteResourceDataSyncInput) (req *request.Request, output *DeleteResourceDataSyncOutput)

DeleteResourceDataSyncRequest generates a "aws/request.Request" representing the client's request for the DeleteResourceDataSync operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteResourceDataSync for more information on using the DeleteResourceDataSync API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteResourceDataSyncRequest method.
req, resp := client.DeleteResourceDataSyncRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeleteResourceDataSync

func (*SSM) DeleteResourceDataSyncWithContext added in v1.10.5

func (c *SSM) DeleteResourceDataSyncWithContext(ctx aws.Context, input *DeleteResourceDataSyncInput, opts ...request.Option) (*DeleteResourceDataSyncOutput, error)

DeleteResourceDataSyncWithContext is the same as DeleteResourceDataSync with the addition of the ability to pass a context and additional request options.

See DeleteResourceDataSync for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeregisterManagedInstance added in v1.2.2

func (c *SSM) DeregisterManagedInstance(input *DeregisterManagedInstanceInput) (*DeregisterManagedInstanceOutput, error)

DeregisterManagedInstance API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeregisterManagedInstance for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterManagedInstance

func (*SSM) DeregisterManagedInstanceRequest added in v1.2.2

func (c *SSM) DeregisterManagedInstanceRequest(input *DeregisterManagedInstanceInput) (req *request.Request, output *DeregisterManagedInstanceOutput)

DeregisterManagedInstanceRequest generates a "aws/request.Request" representing the client's request for the DeregisterManagedInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterManagedInstance for more information on using the DeregisterManagedInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterManagedInstanceRequest method.
req, resp := client.DeregisterManagedInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterManagedInstance

func (*SSM) DeregisterManagedInstanceWithContext added in v1.8.0

func (c *SSM) DeregisterManagedInstanceWithContext(ctx aws.Context, input *DeregisterManagedInstanceInput, opts ...request.Option) (*DeregisterManagedInstanceOutput, error)

DeregisterManagedInstanceWithContext is the same as DeregisterManagedInstance with the addition of the ability to pass a context and additional request options.

See DeregisterManagedInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeregisterPatchBaselineForPatchGroup added in v1.6.4

func (c *SSM) DeregisterPatchBaselineForPatchGroup(input *DeregisterPatchBaselineForPatchGroupInput) (*DeregisterPatchBaselineForPatchGroupOutput, error)

DeregisterPatchBaselineForPatchGroup API operation for Amazon Simple Systems Manager (SSM).

Removes a patch group from a patch baseline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeregisterPatchBaselineForPatchGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup

func (*SSM) DeregisterPatchBaselineForPatchGroupRequest added in v1.6.4

func (c *SSM) DeregisterPatchBaselineForPatchGroupRequest(input *DeregisterPatchBaselineForPatchGroupInput) (req *request.Request, output *DeregisterPatchBaselineForPatchGroupOutput)

DeregisterPatchBaselineForPatchGroupRequest generates a "aws/request.Request" representing the client's request for the DeregisterPatchBaselineForPatchGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterPatchBaselineForPatchGroup for more information on using the DeregisterPatchBaselineForPatchGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterPatchBaselineForPatchGroupRequest method.
req, resp := client.DeregisterPatchBaselineForPatchGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterPatchBaselineForPatchGroup

func (*SSM) DeregisterPatchBaselineForPatchGroupWithContext added in v1.8.0

func (c *SSM) DeregisterPatchBaselineForPatchGroupWithContext(ctx aws.Context, input *DeregisterPatchBaselineForPatchGroupInput, opts ...request.Option) (*DeregisterPatchBaselineForPatchGroupOutput, error)

DeregisterPatchBaselineForPatchGroupWithContext is the same as DeregisterPatchBaselineForPatchGroup with the addition of the ability to pass a context and additional request options.

See DeregisterPatchBaselineForPatchGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeregisterTargetFromMaintenanceWindow added in v1.5.13

func (c *SSM) DeregisterTargetFromMaintenanceWindow(input *DeregisterTargetFromMaintenanceWindowInput) (*DeregisterTargetFromMaintenanceWindowOutput, error)

DeregisterTargetFromMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Removes a target from a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeregisterTargetFromMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeTargetInUseException "TargetInUseException" You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow

func (*SSM) DeregisterTargetFromMaintenanceWindowRequest added in v1.5.13

func (c *SSM) DeregisterTargetFromMaintenanceWindowRequest(input *DeregisterTargetFromMaintenanceWindowInput) (req *request.Request, output *DeregisterTargetFromMaintenanceWindowOutput)

DeregisterTargetFromMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the DeregisterTargetFromMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterTargetFromMaintenanceWindow for more information on using the DeregisterTargetFromMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterTargetFromMaintenanceWindowRequest method.
req, resp := client.DeregisterTargetFromMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterTargetFromMaintenanceWindow

func (*SSM) DeregisterTargetFromMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) DeregisterTargetFromMaintenanceWindowWithContext(ctx aws.Context, input *DeregisterTargetFromMaintenanceWindowInput, opts ...request.Option) (*DeregisterTargetFromMaintenanceWindowOutput, error)

DeregisterTargetFromMaintenanceWindowWithContext is the same as DeregisterTargetFromMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See DeregisterTargetFromMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DeregisterTaskFromMaintenanceWindow added in v1.5.13

func (c *SSM) DeregisterTaskFromMaintenanceWindow(input *DeregisterTaskFromMaintenanceWindowInput) (*DeregisterTaskFromMaintenanceWindowOutput, error)

DeregisterTaskFromMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Removes a task from a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DeregisterTaskFromMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow

func (*SSM) DeregisterTaskFromMaintenanceWindowRequest added in v1.5.13

func (c *SSM) DeregisterTaskFromMaintenanceWindowRequest(input *DeregisterTaskFromMaintenanceWindowInput) (req *request.Request, output *DeregisterTaskFromMaintenanceWindowOutput)

DeregisterTaskFromMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the DeregisterTaskFromMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterTaskFromMaintenanceWindow for more information on using the DeregisterTaskFromMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterTaskFromMaintenanceWindowRequest method.
req, resp := client.DeregisterTaskFromMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DeregisterTaskFromMaintenanceWindow

func (*SSM) DeregisterTaskFromMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) DeregisterTaskFromMaintenanceWindowWithContext(ctx aws.Context, input *DeregisterTaskFromMaintenanceWindowInput, opts ...request.Option) (*DeregisterTaskFromMaintenanceWindowOutput, error)

DeregisterTaskFromMaintenanceWindowWithContext is the same as DeregisterTaskFromMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See DeregisterTaskFromMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeActivations added in v1.2.2

func (c *SSM) DescribeActivations(input *DescribeActivationsInput) (*DescribeActivationsOutput, error)

DescribeActivations API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeActivations for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeActivations

func (*SSM) DescribeActivationsPages added in v1.2.2

func (c *SSM) DescribeActivationsPages(input *DescribeActivationsInput, fn func(*DescribeActivationsOutput, bool) bool) error

DescribeActivationsPages iterates over the pages of a DescribeActivations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeActivations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeActivations operation.
pageNum := 0
err := client.DescribeActivationsPages(params,
    func(page *ssm.DescribeActivationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) DescribeActivationsPagesWithContext added in v1.8.0

func (c *SSM) DescribeActivationsPagesWithContext(ctx aws.Context, input *DescribeActivationsInput, fn func(*DescribeActivationsOutput, bool) bool, opts ...request.Option) error

DescribeActivationsPagesWithContext same as DescribeActivationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeActivationsRequest added in v1.2.2

func (c *SSM) DescribeActivationsRequest(input *DescribeActivationsInput) (req *request.Request, output *DescribeActivationsOutput)

DescribeActivationsRequest generates a "aws/request.Request" representing the client's request for the DescribeActivations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeActivations for more information on using the DescribeActivations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeActivationsRequest method.
req, resp := client.DescribeActivationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeActivations

func (*SSM) DescribeActivationsWithContext added in v1.8.0

func (c *SSM) DescribeActivationsWithContext(ctx aws.Context, input *DescribeActivationsInput, opts ...request.Option) (*DescribeActivationsOutput, error)

DescribeActivationsWithContext is the same as DescribeActivations with the addition of the ability to pass a context and additional request options.

See DescribeActivations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeAssociation

func (c *SSM) DescribeAssociation(input *DescribeAssociationInput) (*DescribeAssociationOutput, error)

DescribeAssociation API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeAssociation for usage and error information.

Returned Error Codes:

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

  • ErrCodeInvalidAssociationVersion "InvalidAssociationVersion" The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociation

func (*SSM) DescribeAssociationExecutionTargets added in v1.14.18

func (c *SSM) DescribeAssociationExecutionTargets(input *DescribeAssociationExecutionTargetsInput) (*DescribeAssociationExecutionTargetsOutput, error)

DescribeAssociationExecutionTargets API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeAssociationExecutionTargets for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeAssociationExecutionDoesNotExist "AssociationExecutionDoesNotExist" The specified execution ID does not exist. Verify the ID number and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociationExecutionTargets

func (*SSM) DescribeAssociationExecutionTargetsRequest added in v1.14.18

func (c *SSM) DescribeAssociationExecutionTargetsRequest(input *DescribeAssociationExecutionTargetsInput) (req *request.Request, output *DescribeAssociationExecutionTargetsOutput)

DescribeAssociationExecutionTargetsRequest generates a "aws/request.Request" representing the client's request for the DescribeAssociationExecutionTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAssociationExecutionTargets for more information on using the DescribeAssociationExecutionTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAssociationExecutionTargetsRequest method.
req, resp := client.DescribeAssociationExecutionTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociationExecutionTargets

func (*SSM) DescribeAssociationExecutionTargetsWithContext added in v1.14.18

func (c *SSM) DescribeAssociationExecutionTargetsWithContext(ctx aws.Context, input *DescribeAssociationExecutionTargetsInput, opts ...request.Option) (*DescribeAssociationExecutionTargetsOutput, error)

DescribeAssociationExecutionTargetsWithContext is the same as DescribeAssociationExecutionTargets with the addition of the ability to pass a context and additional request options.

See DescribeAssociationExecutionTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeAssociationExecutions added in v1.14.18

func (c *SSM) DescribeAssociationExecutions(input *DescribeAssociationExecutionsInput) (*DescribeAssociationExecutionsOutput, error)

DescribeAssociationExecutions API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeAssociationExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociationExecutions

func (*SSM) DescribeAssociationExecutionsRequest added in v1.14.18

func (c *SSM) DescribeAssociationExecutionsRequest(input *DescribeAssociationExecutionsInput) (req *request.Request, output *DescribeAssociationExecutionsOutput)

DescribeAssociationExecutionsRequest generates a "aws/request.Request" representing the client's request for the DescribeAssociationExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAssociationExecutions for more information on using the DescribeAssociationExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAssociationExecutionsRequest method.
req, resp := client.DescribeAssociationExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociationExecutions

func (*SSM) DescribeAssociationExecutionsWithContext added in v1.14.18

func (c *SSM) DescribeAssociationExecutionsWithContext(ctx aws.Context, input *DescribeAssociationExecutionsInput, opts ...request.Option) (*DescribeAssociationExecutionsOutput, error)

DescribeAssociationExecutionsWithContext is the same as DescribeAssociationExecutions with the addition of the ability to pass a context and additional request options.

See DescribeAssociationExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeAssociationRequest

func (c *SSM) DescribeAssociationRequest(input *DescribeAssociationInput) (req *request.Request, output *DescribeAssociationOutput)

DescribeAssociationRequest generates a "aws/request.Request" representing the client's request for the DescribeAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAssociation for more information on using the DescribeAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAssociationRequest method.
req, resp := client.DescribeAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAssociation

func (*SSM) DescribeAssociationWithContext added in v1.8.0

func (c *SSM) DescribeAssociationWithContext(ctx aws.Context, input *DescribeAssociationInput, opts ...request.Option) (*DescribeAssociationOutput, error)

DescribeAssociationWithContext is the same as DescribeAssociation with the addition of the ability to pass a context and additional request options.

See DescribeAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeAutomationExecutions added in v1.5.13

func (c *SSM) DescribeAutomationExecutions(input *DescribeAutomationExecutionsInput) (*DescribeAutomationExecutionsOutput, error)

DescribeAutomationExecutions API operation for Amazon Simple Systems Manager (SSM).

Provides details about all active and terminated Automation executions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeAutomationExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

  • ErrCodeInvalidFilterValue "InvalidFilterValue" The filter value is not valid. Verify the value and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationExecutions

func (*SSM) DescribeAutomationExecutionsRequest added in v1.5.13

func (c *SSM) DescribeAutomationExecutionsRequest(input *DescribeAutomationExecutionsInput) (req *request.Request, output *DescribeAutomationExecutionsOutput)

DescribeAutomationExecutionsRequest generates a "aws/request.Request" representing the client's request for the DescribeAutomationExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAutomationExecutions for more information on using the DescribeAutomationExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAutomationExecutionsRequest method.
req, resp := client.DescribeAutomationExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationExecutions

func (*SSM) DescribeAutomationExecutionsWithContext added in v1.8.0

func (c *SSM) DescribeAutomationExecutionsWithContext(ctx aws.Context, input *DescribeAutomationExecutionsInput, opts ...request.Option) (*DescribeAutomationExecutionsOutput, error)

DescribeAutomationExecutionsWithContext is the same as DescribeAutomationExecutions with the addition of the ability to pass a context and additional request options.

See DescribeAutomationExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeAutomationStepExecutions added in v1.12.37

func (c *SSM) DescribeAutomationStepExecutions(input *DescribeAutomationStepExecutionsInput) (*DescribeAutomationStepExecutionsOutput, error)

DescribeAutomationStepExecutions API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeAutomationStepExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeAutomationExecutionNotFoundException "AutomationExecutionNotFoundException" There is no automation execution information for the requested automation execution ID.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

  • ErrCodeInvalidFilterValue "InvalidFilterValue" The filter value is not valid. Verify the value and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationStepExecutions

func (*SSM) DescribeAutomationStepExecutionsRequest added in v1.12.37

func (c *SSM) DescribeAutomationStepExecutionsRequest(input *DescribeAutomationStepExecutionsInput) (req *request.Request, output *DescribeAutomationStepExecutionsOutput)

DescribeAutomationStepExecutionsRequest generates a "aws/request.Request" representing the client's request for the DescribeAutomationStepExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAutomationStepExecutions for more information on using the DescribeAutomationStepExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAutomationStepExecutionsRequest method.
req, resp := client.DescribeAutomationStepExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAutomationStepExecutions

func (*SSM) DescribeAutomationStepExecutionsWithContext added in v1.12.37

func (c *SSM) DescribeAutomationStepExecutionsWithContext(ctx aws.Context, input *DescribeAutomationStepExecutionsInput, opts ...request.Option) (*DescribeAutomationStepExecutionsOutput, error)

DescribeAutomationStepExecutionsWithContext is the same as DescribeAutomationStepExecutions with the addition of the ability to pass a context and additional request options.

See DescribeAutomationStepExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeAvailablePatches added in v1.6.4

func (c *SSM) DescribeAvailablePatches(input *DescribeAvailablePatchesInput) (*DescribeAvailablePatchesOutput, error)

DescribeAvailablePatches API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeAvailablePatches for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAvailablePatches

func (*SSM) DescribeAvailablePatchesRequest added in v1.6.4

func (c *SSM) DescribeAvailablePatchesRequest(input *DescribeAvailablePatchesInput) (req *request.Request, output *DescribeAvailablePatchesOutput)

DescribeAvailablePatchesRequest generates a "aws/request.Request" representing the client's request for the DescribeAvailablePatches operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAvailablePatches for more information on using the DescribeAvailablePatches API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAvailablePatchesRequest method.
req, resp := client.DescribeAvailablePatchesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeAvailablePatches

func (*SSM) DescribeAvailablePatchesWithContext added in v1.8.0

func (c *SSM) DescribeAvailablePatchesWithContext(ctx aws.Context, input *DescribeAvailablePatchesInput, opts ...request.Option) (*DescribeAvailablePatchesOutput, error)

DescribeAvailablePatchesWithContext is the same as DescribeAvailablePatches with the addition of the ability to pass a context and additional request options.

See DescribeAvailablePatches for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeDocument

func (c *SSM) DescribeDocument(input *DescribeDocumentInput) (*DescribeDocumentOutput, error)

DescribeDocument API operation for Amazon Simple Systems Manager (SSM).

Describes the specified Systems Manager document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeDocument for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocument

func (*SSM) DescribeDocumentPermission added in v1.1.26

func (c *SSM) DescribeDocumentPermission(input *DescribeDocumentPermissionInput) (*DescribeDocumentPermissionOutput, error)

DescribeDocumentPermission API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeDocumentPermission for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidPermissionType "InvalidPermissionType" The permission type is not supported. Share is the only supported permission type.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocumentPermission

func (*SSM) DescribeDocumentPermissionRequest added in v1.1.26

func (c *SSM) DescribeDocumentPermissionRequest(input *DescribeDocumentPermissionInput) (req *request.Request, output *DescribeDocumentPermissionOutput)

DescribeDocumentPermissionRequest generates a "aws/request.Request" representing the client's request for the DescribeDocumentPermission operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDocumentPermission for more information on using the DescribeDocumentPermission API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDocumentPermissionRequest method.
req, resp := client.DescribeDocumentPermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocumentPermission

func (*SSM) DescribeDocumentPermissionWithContext added in v1.8.0

func (c *SSM) DescribeDocumentPermissionWithContext(ctx aws.Context, input *DescribeDocumentPermissionInput, opts ...request.Option) (*DescribeDocumentPermissionOutput, error)

DescribeDocumentPermissionWithContext is the same as DescribeDocumentPermission with the addition of the ability to pass a context and additional request options.

See DescribeDocumentPermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeDocumentRequest

func (c *SSM) DescribeDocumentRequest(input *DescribeDocumentInput) (req *request.Request, output *DescribeDocumentOutput)

DescribeDocumentRequest generates a "aws/request.Request" representing the client's request for the DescribeDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDocument for more information on using the DescribeDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDocumentRequest method.
req, resp := client.DescribeDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeDocument

func (*SSM) DescribeDocumentWithContext added in v1.8.0

func (c *SSM) DescribeDocumentWithContext(ctx aws.Context, input *DescribeDocumentInput, opts ...request.Option) (*DescribeDocumentOutput, error)

DescribeDocumentWithContext is the same as DescribeDocument with the addition of the ability to pass a context and additional request options.

See DescribeDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeEffectiveInstanceAssociations added in v1.5.13

func (c *SSM) DescribeEffectiveInstanceAssociations(input *DescribeEffectiveInstanceAssociationsInput) (*DescribeEffectiveInstanceAssociationsOutput, error)

DescribeEffectiveInstanceAssociations API operation for Amazon Simple Systems Manager (SSM).

All associations for the instance(s).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeEffectiveInstanceAssociations for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeEffectiveInstanceAssociations

func (*SSM) DescribeEffectiveInstanceAssociationsRequest added in v1.5.13

func (c *SSM) DescribeEffectiveInstanceAssociationsRequest(input *DescribeEffectiveInstanceAssociationsInput) (req *request.Request, output *DescribeEffectiveInstanceAssociationsOutput)

DescribeEffectiveInstanceAssociationsRequest generates a "aws/request.Request" representing the client's request for the DescribeEffectiveInstanceAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEffectiveInstanceAssociations for more information on using the DescribeEffectiveInstanceAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEffectiveInstanceAssociationsRequest method.
req, resp := client.DescribeEffectiveInstanceAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeEffectiveInstanceAssociations

func (*SSM) DescribeEffectiveInstanceAssociationsWithContext added in v1.8.0

func (c *SSM) DescribeEffectiveInstanceAssociationsWithContext(ctx aws.Context, input *DescribeEffectiveInstanceAssociationsInput, opts ...request.Option) (*DescribeEffectiveInstanceAssociationsOutput, error)

DescribeEffectiveInstanceAssociationsWithContext is the same as DescribeEffectiveInstanceAssociations with the addition of the ability to pass a context and additional request options.

See DescribeEffectiveInstanceAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeEffectivePatchesForPatchBaseline added in v1.6.4

func (c *SSM) DescribeEffectivePatchesForPatchBaseline(input *DescribeEffectivePatchesForPatchBaselineInput) (*DescribeEffectivePatchesForPatchBaselineOutput, error)

DescribeEffectivePatchesForPatchBaseline API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeEffectivePatchesForPatchBaseline for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeUnsupportedOperatingSystem "UnsupportedOperatingSystem" The operating systems you specified is not supported, or the operation is not supported for the operating system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline

func (*SSM) DescribeEffectivePatchesForPatchBaselineRequest added in v1.6.4

func (c *SSM) DescribeEffectivePatchesForPatchBaselineRequest(input *DescribeEffectivePatchesForPatchBaselineInput) (req *request.Request, output *DescribeEffectivePatchesForPatchBaselineOutput)

DescribeEffectivePatchesForPatchBaselineRequest generates a "aws/request.Request" representing the client's request for the DescribeEffectivePatchesForPatchBaseline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEffectivePatchesForPatchBaseline for more information on using the DescribeEffectivePatchesForPatchBaseline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEffectivePatchesForPatchBaselineRequest method.
req, resp := client.DescribeEffectivePatchesForPatchBaselineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeEffectivePatchesForPatchBaseline

func (*SSM) DescribeEffectivePatchesForPatchBaselineWithContext added in v1.8.0

func (c *SSM) DescribeEffectivePatchesForPatchBaselineWithContext(ctx aws.Context, input *DescribeEffectivePatchesForPatchBaselineInput, opts ...request.Option) (*DescribeEffectivePatchesForPatchBaselineOutput, error)

DescribeEffectivePatchesForPatchBaselineWithContext is the same as DescribeEffectivePatchesForPatchBaseline with the addition of the ability to pass a context and additional request options.

See DescribeEffectivePatchesForPatchBaseline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeInstanceAssociationsStatus added in v1.5.13

func (c *SSM) DescribeInstanceAssociationsStatus(input *DescribeInstanceAssociationsStatusInput) (*DescribeInstanceAssociationsStatusOutput, error)

DescribeInstanceAssociationsStatus API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeInstanceAssociationsStatus for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceAssociationsStatus

func (*SSM) DescribeInstanceAssociationsStatusRequest added in v1.5.13

func (c *SSM) DescribeInstanceAssociationsStatusRequest(input *DescribeInstanceAssociationsStatusInput) (req *request.Request, output *DescribeInstanceAssociationsStatusOutput)

DescribeInstanceAssociationsStatusRequest generates a "aws/request.Request" representing the client's request for the DescribeInstanceAssociationsStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstanceAssociationsStatus for more information on using the DescribeInstanceAssociationsStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInstanceAssociationsStatusRequest method.
req, resp := client.DescribeInstanceAssociationsStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceAssociationsStatus

func (*SSM) DescribeInstanceAssociationsStatusWithContext added in v1.8.0

func (c *SSM) DescribeInstanceAssociationsStatusWithContext(ctx aws.Context, input *DescribeInstanceAssociationsStatusInput, opts ...request.Option) (*DescribeInstanceAssociationsStatusOutput, error)

DescribeInstanceAssociationsStatusWithContext is the same as DescribeInstanceAssociationsStatus with the addition of the ability to pass a context and additional request options.

See DescribeInstanceAssociationsStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeInstanceInformation added in v0.9.17

func (c *SSM) DescribeInstanceInformation(input *DescribeInstanceInformationInput) (*DescribeInstanceInformationOutput, error)

DescribeInstanceInformation API operation for Amazon Simple Systems Manager (SSM).

Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeInstanceInformation for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInvalidInstanceInformationFilterValue "InvalidInstanceInformationFilterValue" The specified filter value is not valid.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceInformation

func (*SSM) DescribeInstanceInformationPages added in v1.2.7

func (c *SSM) DescribeInstanceInformationPages(input *DescribeInstanceInformationInput, fn func(*DescribeInstanceInformationOutput, bool) bool) error

DescribeInstanceInformationPages iterates over the pages of a DescribeInstanceInformation operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeInstanceInformation method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeInstanceInformation operation.
pageNum := 0
err := client.DescribeInstanceInformationPages(params,
    func(page *ssm.DescribeInstanceInformationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) DescribeInstanceInformationPagesWithContext added in v1.8.0

func (c *SSM) DescribeInstanceInformationPagesWithContext(ctx aws.Context, input *DescribeInstanceInformationInput, fn func(*DescribeInstanceInformationOutput, bool) bool, opts ...request.Option) error

DescribeInstanceInformationPagesWithContext same as DescribeInstanceInformationPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeInstanceInformationRequest added in v0.9.17

func (c *SSM) DescribeInstanceInformationRequest(input *DescribeInstanceInformationInput) (req *request.Request, output *DescribeInstanceInformationOutput)

DescribeInstanceInformationRequest generates a "aws/request.Request" representing the client's request for the DescribeInstanceInformation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstanceInformation for more information on using the DescribeInstanceInformation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInstanceInformationRequest method.
req, resp := client.DescribeInstanceInformationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceInformation

func (*SSM) DescribeInstanceInformationWithContext added in v1.8.0

func (c *SSM) DescribeInstanceInformationWithContext(ctx aws.Context, input *DescribeInstanceInformationInput, opts ...request.Option) (*DescribeInstanceInformationOutput, error)

DescribeInstanceInformationWithContext is the same as DescribeInstanceInformation with the addition of the ability to pass a context and additional request options.

See DescribeInstanceInformation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeInstancePatchStates added in v1.6.4

func (c *SSM) DescribeInstancePatchStates(input *DescribeInstancePatchStatesInput) (*DescribeInstancePatchStatesOutput, error)

DescribeInstancePatchStates API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeInstancePatchStates for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatchStates

func (*SSM) DescribeInstancePatchStatesForPatchGroup added in v1.6.4

func (c *SSM) DescribeInstancePatchStatesForPatchGroup(input *DescribeInstancePatchStatesForPatchGroupInput) (*DescribeInstancePatchStatesForPatchGroupOutput, error)

DescribeInstancePatchStatesForPatchGroup API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeInstancePatchStatesForPatchGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup

func (*SSM) DescribeInstancePatchStatesForPatchGroupRequest added in v1.6.4

func (c *SSM) DescribeInstancePatchStatesForPatchGroupRequest(input *DescribeInstancePatchStatesForPatchGroupInput) (req *request.Request, output *DescribeInstancePatchStatesForPatchGroupOutput)

DescribeInstancePatchStatesForPatchGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeInstancePatchStatesForPatchGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstancePatchStatesForPatchGroup for more information on using the DescribeInstancePatchStatesForPatchGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInstancePatchStatesForPatchGroupRequest method.
req, resp := client.DescribeInstancePatchStatesForPatchGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatchStatesForPatchGroup

func (*SSM) DescribeInstancePatchStatesForPatchGroupWithContext added in v1.8.0

func (c *SSM) DescribeInstancePatchStatesForPatchGroupWithContext(ctx aws.Context, input *DescribeInstancePatchStatesForPatchGroupInput, opts ...request.Option) (*DescribeInstancePatchStatesForPatchGroupOutput, error)

DescribeInstancePatchStatesForPatchGroupWithContext is the same as DescribeInstancePatchStatesForPatchGroup with the addition of the ability to pass a context and additional request options.

See DescribeInstancePatchStatesForPatchGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeInstancePatchStatesRequest added in v1.6.4

func (c *SSM) DescribeInstancePatchStatesRequest(input *DescribeInstancePatchStatesInput) (req *request.Request, output *DescribeInstancePatchStatesOutput)

DescribeInstancePatchStatesRequest generates a "aws/request.Request" representing the client's request for the DescribeInstancePatchStates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstancePatchStates for more information on using the DescribeInstancePatchStates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInstancePatchStatesRequest method.
req, resp := client.DescribeInstancePatchStatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatchStates

func (*SSM) DescribeInstancePatchStatesWithContext added in v1.8.0

func (c *SSM) DescribeInstancePatchStatesWithContext(ctx aws.Context, input *DescribeInstancePatchStatesInput, opts ...request.Option) (*DescribeInstancePatchStatesOutput, error)

DescribeInstancePatchStatesWithContext is the same as DescribeInstancePatchStates with the addition of the ability to pass a context and additional request options.

See DescribeInstancePatchStates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeInstancePatches added in v1.6.4

func (c *SSM) DescribeInstancePatches(input *DescribeInstancePatchesInput) (*DescribeInstancePatchesOutput, error)

DescribeInstancePatches API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeInstancePatches for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatches

func (*SSM) DescribeInstancePatchesRequest added in v1.6.4

func (c *SSM) DescribeInstancePatchesRequest(input *DescribeInstancePatchesInput) (req *request.Request, output *DescribeInstancePatchesOutput)

DescribeInstancePatchesRequest generates a "aws/request.Request" representing the client's request for the DescribeInstancePatches operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInstancePatches for more information on using the DescribeInstancePatches API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInstancePatchesRequest method.
req, resp := client.DescribeInstancePatchesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstancePatches

func (*SSM) DescribeInstancePatchesWithContext added in v1.8.0

func (c *SSM) DescribeInstancePatchesWithContext(ctx aws.Context, input *DescribeInstancePatchesInput, opts ...request.Option) (*DescribeInstancePatchesOutput, error)

DescribeInstancePatchesWithContext is the same as DescribeInstancePatches with the addition of the ability to pass a context and additional request options.

See DescribeInstancePatches for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeInventoryDeletions added in v1.13.33

func (c *SSM) DescribeInventoryDeletions(input *DescribeInventoryDeletionsInput) (*DescribeInventoryDeletionsOutput, error)

DescribeInventoryDeletions API operation for Amazon Simple Systems Manager (SSM).

Describes a specific delete inventory operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeInventoryDeletions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDeletionIdException "InvalidDeletionIdException" The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInventoryDeletions

func (*SSM) DescribeInventoryDeletionsRequest added in v1.13.33

func (c *SSM) DescribeInventoryDeletionsRequest(input *DescribeInventoryDeletionsInput) (req *request.Request, output *DescribeInventoryDeletionsOutput)

DescribeInventoryDeletionsRequest generates a "aws/request.Request" representing the client's request for the DescribeInventoryDeletions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeInventoryDeletions for more information on using the DescribeInventoryDeletions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeInventoryDeletionsRequest method.
req, resp := client.DescribeInventoryDeletionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInventoryDeletions

func (*SSM) DescribeInventoryDeletionsWithContext added in v1.13.33

func (c *SSM) DescribeInventoryDeletionsWithContext(ctx aws.Context, input *DescribeInventoryDeletionsInput, opts ...request.Option) (*DescribeInventoryDeletionsOutput, error)

DescribeInventoryDeletionsWithContext is the same as DescribeInventoryDeletions with the addition of the ability to pass a context and additional request options.

See DescribeInventoryDeletions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindowExecutionTaskInvocations added in v1.5.13

DescribeMaintenanceWindowExecutionTaskInvocations API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindowExecutionTaskInvocations for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations

func (*SSM) DescribeMaintenanceWindowExecutionTaskInvocationsRequest added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowExecutionTaskInvocationsRequest(input *DescribeMaintenanceWindowExecutionTaskInvocationsInput) (req *request.Request, output *DescribeMaintenanceWindowExecutionTaskInvocationsOutput)

DescribeMaintenanceWindowExecutionTaskInvocationsRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindowExecutionTaskInvocations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindowExecutionTaskInvocations for more information on using the DescribeMaintenanceWindowExecutionTaskInvocations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowExecutionTaskInvocationsRequest method.
req, resp := client.DescribeMaintenanceWindowExecutionTaskInvocationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations

func (*SSM) DescribeMaintenanceWindowExecutionTaskInvocationsWithContext added in v1.8.0

func (c *SSM) DescribeMaintenanceWindowExecutionTaskInvocationsWithContext(ctx aws.Context, input *DescribeMaintenanceWindowExecutionTaskInvocationsInput, opts ...request.Option) (*DescribeMaintenanceWindowExecutionTaskInvocationsOutput, error)

DescribeMaintenanceWindowExecutionTaskInvocationsWithContext is the same as DescribeMaintenanceWindowExecutionTaskInvocations with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindowExecutionTaskInvocations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindowExecutionTasks added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowExecutionTasks(input *DescribeMaintenanceWindowExecutionTasksInput) (*DescribeMaintenanceWindowExecutionTasksOutput, error)

DescribeMaintenanceWindowExecutionTasks API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindowExecutionTasks for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks

func (*SSM) DescribeMaintenanceWindowExecutionTasksRequest added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowExecutionTasksRequest(input *DescribeMaintenanceWindowExecutionTasksInput) (req *request.Request, output *DescribeMaintenanceWindowExecutionTasksOutput)

DescribeMaintenanceWindowExecutionTasksRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindowExecutionTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindowExecutionTasks for more information on using the DescribeMaintenanceWindowExecutionTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowExecutionTasksRequest method.
req, resp := client.DescribeMaintenanceWindowExecutionTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTasks

func (*SSM) DescribeMaintenanceWindowExecutionTasksWithContext added in v1.8.0

func (c *SSM) DescribeMaintenanceWindowExecutionTasksWithContext(ctx aws.Context, input *DescribeMaintenanceWindowExecutionTasksInput, opts ...request.Option) (*DescribeMaintenanceWindowExecutionTasksOutput, error)

DescribeMaintenanceWindowExecutionTasksWithContext is the same as DescribeMaintenanceWindowExecutionTasks with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindowExecutionTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindowExecutions added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowExecutions(input *DescribeMaintenanceWindowExecutionsInput) (*DescribeMaintenanceWindowExecutionsOutput, error)

DescribeMaintenanceWindowExecutions API operation for Amazon Simple Systems Manager (SSM).

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindowExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowExecutions

func (*SSM) DescribeMaintenanceWindowExecutionsRequest added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowExecutionsRequest(input *DescribeMaintenanceWindowExecutionsInput) (req *request.Request, output *DescribeMaintenanceWindowExecutionsOutput)

DescribeMaintenanceWindowExecutionsRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindowExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindowExecutions for more information on using the DescribeMaintenanceWindowExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowExecutionsRequest method.
req, resp := client.DescribeMaintenanceWindowExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowExecutions

func (*SSM) DescribeMaintenanceWindowExecutionsWithContext added in v1.8.0

func (c *SSM) DescribeMaintenanceWindowExecutionsWithContext(ctx aws.Context, input *DescribeMaintenanceWindowExecutionsInput, opts ...request.Option) (*DescribeMaintenanceWindowExecutionsOutput, error)

DescribeMaintenanceWindowExecutionsWithContext is the same as DescribeMaintenanceWindowExecutions with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindowExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindowSchedule added in v1.99.0

func (c *SSM) DescribeMaintenanceWindowSchedule(input *DescribeMaintenanceWindowScheduleInput) (*DescribeMaintenanceWindowScheduleOutput, error)

DescribeMaintenanceWindowSchedule API operation for Amazon Simple Systems Manager (SSM).

Retrieves information about upcoming executions of a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindowSchedule for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowSchedule

func (*SSM) DescribeMaintenanceWindowScheduleRequest added in v1.99.0

func (c *SSM) DescribeMaintenanceWindowScheduleRequest(input *DescribeMaintenanceWindowScheduleInput) (req *request.Request, output *DescribeMaintenanceWindowScheduleOutput)

DescribeMaintenanceWindowScheduleRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindowSchedule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindowSchedule for more information on using the DescribeMaintenanceWindowSchedule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowScheduleRequest method.
req, resp := client.DescribeMaintenanceWindowScheduleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowSchedule

func (*SSM) DescribeMaintenanceWindowScheduleWithContext added in v1.99.0

func (c *SSM) DescribeMaintenanceWindowScheduleWithContext(ctx aws.Context, input *DescribeMaintenanceWindowScheduleInput, opts ...request.Option) (*DescribeMaintenanceWindowScheduleOutput, error)

DescribeMaintenanceWindowScheduleWithContext is the same as DescribeMaintenanceWindowSchedule with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindowSchedule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindowTargets added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowTargets(input *DescribeMaintenanceWindowTargetsInput) (*DescribeMaintenanceWindowTargetsOutput, error)

DescribeMaintenanceWindowTargets API operation for Amazon Simple Systems Manager (SSM).

Lists the targets registered with the maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindowTargets for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowTargets

func (*SSM) DescribeMaintenanceWindowTargetsRequest added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowTargetsRequest(input *DescribeMaintenanceWindowTargetsInput) (req *request.Request, output *DescribeMaintenanceWindowTargetsOutput)

DescribeMaintenanceWindowTargetsRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindowTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindowTargets for more information on using the DescribeMaintenanceWindowTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowTargetsRequest method.
req, resp := client.DescribeMaintenanceWindowTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowTargets

func (*SSM) DescribeMaintenanceWindowTargetsWithContext added in v1.8.0

func (c *SSM) DescribeMaintenanceWindowTargetsWithContext(ctx aws.Context, input *DescribeMaintenanceWindowTargetsInput, opts ...request.Option) (*DescribeMaintenanceWindowTargetsOutput, error)

DescribeMaintenanceWindowTargetsWithContext is the same as DescribeMaintenanceWindowTargets with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindowTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindowTasks added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowTasks(input *DescribeMaintenanceWindowTasksInput) (*DescribeMaintenanceWindowTasksOutput, error)

DescribeMaintenanceWindowTasks API operation for Amazon Simple Systems Manager (SSM).

Lists the tasks in a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindowTasks for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowTasks

func (*SSM) DescribeMaintenanceWindowTasksRequest added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowTasksRequest(input *DescribeMaintenanceWindowTasksInput) (req *request.Request, output *DescribeMaintenanceWindowTasksOutput)

DescribeMaintenanceWindowTasksRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindowTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindowTasks for more information on using the DescribeMaintenanceWindowTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowTasksRequest method.
req, resp := client.DescribeMaintenanceWindowTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowTasks

func (*SSM) DescribeMaintenanceWindowTasksWithContext added in v1.8.0

func (c *SSM) DescribeMaintenanceWindowTasksWithContext(ctx aws.Context, input *DescribeMaintenanceWindowTasksInput, opts ...request.Option) (*DescribeMaintenanceWindowTasksOutput, error)

DescribeMaintenanceWindowTasksWithContext is the same as DescribeMaintenanceWindowTasks with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindowTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindows added in v1.5.13

func (c *SSM) DescribeMaintenanceWindows(input *DescribeMaintenanceWindowsInput) (*DescribeMaintenanceWindowsOutput, error)

DescribeMaintenanceWindows API operation for Amazon Simple Systems Manager (SSM).

Retrieves the maintenance windows in an AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindows for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindows

func (*SSM) DescribeMaintenanceWindowsForTarget added in v1.99.0

func (c *SSM) DescribeMaintenanceWindowsForTarget(input *DescribeMaintenanceWindowsForTargetInput) (*DescribeMaintenanceWindowsForTargetOutput, error)

DescribeMaintenanceWindowsForTarget API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeMaintenanceWindowsForTarget for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget

func (*SSM) DescribeMaintenanceWindowsForTargetRequest added in v1.99.0

func (c *SSM) DescribeMaintenanceWindowsForTargetRequest(input *DescribeMaintenanceWindowsForTargetInput) (req *request.Request, output *DescribeMaintenanceWindowsForTargetOutput)

DescribeMaintenanceWindowsForTargetRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindowsForTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindowsForTarget for more information on using the DescribeMaintenanceWindowsForTarget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowsForTargetRequest method.
req, resp := client.DescribeMaintenanceWindowsForTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowsForTarget

func (*SSM) DescribeMaintenanceWindowsForTargetWithContext added in v1.99.0

func (c *SSM) DescribeMaintenanceWindowsForTargetWithContext(ctx aws.Context, input *DescribeMaintenanceWindowsForTargetInput, opts ...request.Option) (*DescribeMaintenanceWindowsForTargetOutput, error)

DescribeMaintenanceWindowsForTargetWithContext is the same as DescribeMaintenanceWindowsForTarget with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindowsForTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeMaintenanceWindowsRequest added in v1.5.13

func (c *SSM) DescribeMaintenanceWindowsRequest(input *DescribeMaintenanceWindowsInput) (req *request.Request, output *DescribeMaintenanceWindowsOutput)

DescribeMaintenanceWindowsRequest generates a "aws/request.Request" representing the client's request for the DescribeMaintenanceWindows operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMaintenanceWindows for more information on using the DescribeMaintenanceWindows API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeMaintenanceWindowsRequest method.
req, resp := client.DescribeMaintenanceWindowsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindows

func (*SSM) DescribeMaintenanceWindowsWithContext added in v1.8.0

func (c *SSM) DescribeMaintenanceWindowsWithContext(ctx aws.Context, input *DescribeMaintenanceWindowsInput, opts ...request.Option) (*DescribeMaintenanceWindowsOutput, error)

DescribeMaintenanceWindowsWithContext is the same as DescribeMaintenanceWindows with the addition of the ability to pass a context and additional request options.

See DescribeMaintenanceWindows for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeOpsItems added in v1.99.0

func (c *SSM) DescribeOpsItems(input *DescribeOpsItemsInput) (*DescribeOpsItemsOutput, error)

DescribeOpsItems API operation for Amazon Simple Systems Manager (SSM).

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting Started with OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeOpsItems for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeOpsItems

func (*SSM) DescribeOpsItemsRequest added in v1.99.0

func (c *SSM) DescribeOpsItemsRequest(input *DescribeOpsItemsInput) (req *request.Request, output *DescribeOpsItemsOutput)

DescribeOpsItemsRequest generates a "aws/request.Request" representing the client's request for the DescribeOpsItems operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOpsItems for more information on using the DescribeOpsItems API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeOpsItemsRequest method.
req, resp := client.DescribeOpsItemsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeOpsItems

func (*SSM) DescribeOpsItemsWithContext added in v1.99.0

func (c *SSM) DescribeOpsItemsWithContext(ctx aws.Context, input *DescribeOpsItemsInput, opts ...request.Option) (*DescribeOpsItemsOutput, error)

DescribeOpsItemsWithContext is the same as DescribeOpsItems with the addition of the ability to pass a context and additional request options.

See DescribeOpsItems for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeParameters added in v1.5.13

func (c *SSM) DescribeParameters(input *DescribeParametersInput) (*DescribeParametersOutput, error)

DescribeParameters API operation for Amazon Simple Systems Manager (SSM).

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeParameters for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

  • ErrCodeInvalidFilterOption "InvalidFilterOption" The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

  • ErrCodeInvalidFilterValue "InvalidFilterValue" The filter value is not valid. Verify the value and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeParameters

func (*SSM) DescribeParametersPages added in v1.10.1

func (c *SSM) DescribeParametersPages(input *DescribeParametersInput, fn func(*DescribeParametersOutput, bool) bool) error

DescribeParametersPages iterates over the pages of a DescribeParameters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeParameters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeParameters operation.
pageNum := 0
err := client.DescribeParametersPages(params,
    func(page *ssm.DescribeParametersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) DescribeParametersPagesWithContext added in v1.10.1

func (c *SSM) DescribeParametersPagesWithContext(ctx aws.Context, input *DescribeParametersInput, fn func(*DescribeParametersOutput, bool) bool, opts ...request.Option) error

DescribeParametersPagesWithContext same as DescribeParametersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeParametersRequest added in v1.5.13

func (c *SSM) DescribeParametersRequest(input *DescribeParametersInput) (req *request.Request, output *DescribeParametersOutput)

DescribeParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeParameters for more information on using the DescribeParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeParametersRequest method.
req, resp := client.DescribeParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeParameters

func (*SSM) DescribeParametersWithContext added in v1.8.0

func (c *SSM) DescribeParametersWithContext(ctx aws.Context, input *DescribeParametersInput, opts ...request.Option) (*DescribeParametersOutput, error)

DescribeParametersWithContext is the same as DescribeParameters with the addition of the ability to pass a context and additional request options.

See DescribeParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribePatchBaselines added in v1.6.4

func (c *SSM) DescribePatchBaselines(input *DescribePatchBaselinesInput) (*DescribePatchBaselinesOutput, error)

DescribePatchBaselines API operation for Amazon Simple Systems Manager (SSM).

Lists the patch baselines in your AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribePatchBaselines for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchBaselines

func (*SSM) DescribePatchBaselinesRequest added in v1.6.4

func (c *SSM) DescribePatchBaselinesRequest(input *DescribePatchBaselinesInput) (req *request.Request, output *DescribePatchBaselinesOutput)

DescribePatchBaselinesRequest generates a "aws/request.Request" representing the client's request for the DescribePatchBaselines operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePatchBaselines for more information on using the DescribePatchBaselines API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePatchBaselinesRequest method.
req, resp := client.DescribePatchBaselinesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchBaselines

func (*SSM) DescribePatchBaselinesWithContext added in v1.8.0

func (c *SSM) DescribePatchBaselinesWithContext(ctx aws.Context, input *DescribePatchBaselinesInput, opts ...request.Option) (*DescribePatchBaselinesOutput, error)

DescribePatchBaselinesWithContext is the same as DescribePatchBaselines with the addition of the ability to pass a context and additional request options.

See DescribePatchBaselines for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribePatchGroupState added in v1.6.4

func (c *SSM) DescribePatchGroupState(input *DescribePatchGroupStateInput) (*DescribePatchGroupStateOutput, error)

DescribePatchGroupState API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribePatchGroupState for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroupState

func (*SSM) DescribePatchGroupStateRequest added in v1.6.4

func (c *SSM) DescribePatchGroupStateRequest(input *DescribePatchGroupStateInput) (req *request.Request, output *DescribePatchGroupStateOutput)

DescribePatchGroupStateRequest generates a "aws/request.Request" representing the client's request for the DescribePatchGroupState operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePatchGroupState for more information on using the DescribePatchGroupState API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePatchGroupStateRequest method.
req, resp := client.DescribePatchGroupStateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroupState

func (*SSM) DescribePatchGroupStateWithContext added in v1.8.0

func (c *SSM) DescribePatchGroupStateWithContext(ctx aws.Context, input *DescribePatchGroupStateInput, opts ...request.Option) (*DescribePatchGroupStateOutput, error)

DescribePatchGroupStateWithContext is the same as DescribePatchGroupState with the addition of the ability to pass a context and additional request options.

See DescribePatchGroupState for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribePatchGroups added in v1.6.4

func (c *SSM) DescribePatchGroups(input *DescribePatchGroupsInput) (*DescribePatchGroupsOutput, error)

DescribePatchGroups API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribePatchGroups for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroups

func (*SSM) DescribePatchGroupsRequest added in v1.6.4

func (c *SSM) DescribePatchGroupsRequest(input *DescribePatchGroupsInput) (req *request.Request, output *DescribePatchGroupsOutput)

DescribePatchGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribePatchGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePatchGroups for more information on using the DescribePatchGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePatchGroupsRequest method.
req, resp := client.DescribePatchGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroups

func (*SSM) DescribePatchGroupsWithContext added in v1.8.0

func (c *SSM) DescribePatchGroupsWithContext(ctx aws.Context, input *DescribePatchGroupsInput, opts ...request.Option) (*DescribePatchGroupsOutput, error)

DescribePatchGroupsWithContext is the same as DescribePatchGroups with the addition of the ability to pass a context and additional request options.

See DescribePatchGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribePatchProperties added in v1.99.0

func (c *SSM) DescribePatchProperties(input *DescribePatchPropertiesInput) (*DescribePatchPropertiesOutput, error)

DescribePatchProperties API operation for Amazon Simple Systems Manager (SSM).

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

WINDOWS

Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY

AMAZON_LINUX

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

AMAZON_LINUX_2

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

UBUNTU

Valid properties: PRODUCT, PRIORITY

REDHAT_ENTERPRISE_LINUX

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

SUSE

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

CENTOS

Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribePatchProperties for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchProperties

func (*SSM) DescribePatchPropertiesRequest added in v1.99.0

func (c *SSM) DescribePatchPropertiesRequest(input *DescribePatchPropertiesInput) (req *request.Request, output *DescribePatchPropertiesOutput)

DescribePatchPropertiesRequest generates a "aws/request.Request" representing the client's request for the DescribePatchProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePatchProperties for more information on using the DescribePatchProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePatchPropertiesRequest method.
req, resp := client.DescribePatchPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchProperties

func (*SSM) DescribePatchPropertiesWithContext added in v1.99.0

func (c *SSM) DescribePatchPropertiesWithContext(ctx aws.Context, input *DescribePatchPropertiesInput, opts ...request.Option) (*DescribePatchPropertiesOutput, error)

DescribePatchPropertiesWithContext is the same as DescribePatchProperties with the addition of the ability to pass a context and additional request options.

See DescribePatchProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) DescribeSessions added in v1.99.0

func (c *SSM) DescribeSessions(input *DescribeSessionsInput) (*DescribeSessionsOutput, error)

DescribeSessions API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation DescribeSessions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeSessions

func (*SSM) DescribeSessionsRequest added in v1.99.0

func (c *SSM) DescribeSessionsRequest(input *DescribeSessionsInput) (req *request.Request, output *DescribeSessionsOutput)

DescribeSessionsRequest generates a "aws/request.Request" representing the client's request for the DescribeSessions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSessions for more information on using the DescribeSessions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSessionsRequest method.
req, resp := client.DescribeSessionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeSessions

func (*SSM) DescribeSessionsWithContext added in v1.99.0

func (c *SSM) DescribeSessionsWithContext(ctx aws.Context, input *DescribeSessionsInput, opts ...request.Option) (*DescribeSessionsOutput, error)

DescribeSessionsWithContext is the same as DescribeSessions with the addition of the ability to pass a context and additional request options.

See DescribeSessions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetAutomationExecution added in v1.5.13

func (c *SSM) GetAutomationExecution(input *GetAutomationExecutionInput) (*GetAutomationExecutionOutput, error)

GetAutomationExecution API operation for Amazon Simple Systems Manager (SSM).

Get detailed information about a particular Automation execution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetAutomationExecution for usage and error information.

Returned Error Codes:

  • ErrCodeAutomationExecutionNotFoundException "AutomationExecutionNotFoundException" There is no automation execution information for the requested automation execution ID.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetAutomationExecution

func (*SSM) GetAutomationExecutionRequest added in v1.5.13

func (c *SSM) GetAutomationExecutionRequest(input *GetAutomationExecutionInput) (req *request.Request, output *GetAutomationExecutionOutput)

GetAutomationExecutionRequest generates a "aws/request.Request" representing the client's request for the GetAutomationExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAutomationExecution for more information on using the GetAutomationExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAutomationExecutionRequest method.
req, resp := client.GetAutomationExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetAutomationExecution

func (*SSM) GetAutomationExecutionWithContext added in v1.8.0

func (c *SSM) GetAutomationExecutionWithContext(ctx aws.Context, input *GetAutomationExecutionInput, opts ...request.Option) (*GetAutomationExecutionOutput, error)

GetAutomationExecutionWithContext is the same as GetAutomationExecution with the addition of the ability to pass a context and additional request options.

See GetAutomationExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetCommandInvocation added in v1.5.13

func (c *SSM) GetCommandInvocation(input *GetCommandInvocationInput) (*GetCommandInvocationOutput, error)

GetCommandInvocation API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetCommandInvocation for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidCommandId "InvalidCommandId"

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidPluginName "InvalidPluginName" The plugin name is not valid.

  • ErrCodeInvocationDoesNotExist "InvocationDoesNotExist" The command ID and instance ID you specified did not match any invocations. Verify the command ID and the instance ID and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocation

func (*SSM) GetCommandInvocationRequest added in v1.5.13

func (c *SSM) GetCommandInvocationRequest(input *GetCommandInvocationInput) (req *request.Request, output *GetCommandInvocationOutput)

GetCommandInvocationRequest generates a "aws/request.Request" representing the client's request for the GetCommandInvocation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCommandInvocation for more information on using the GetCommandInvocation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCommandInvocationRequest method.
req, resp := client.GetCommandInvocationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetCommandInvocation

func (*SSM) GetCommandInvocationWithContext added in v1.8.0

func (c *SSM) GetCommandInvocationWithContext(ctx aws.Context, input *GetCommandInvocationInput, opts ...request.Option) (*GetCommandInvocationOutput, error)

GetCommandInvocationWithContext is the same as GetCommandInvocation with the addition of the ability to pass a context and additional request options.

See GetCommandInvocation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetConnectionStatus added in v1.99.0

func (c *SSM) GetConnectionStatus(input *GetConnectionStatusInput) (*GetConnectionStatusOutput, error)

GetConnectionStatus API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetConnectionStatus for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetConnectionStatus

func (*SSM) GetConnectionStatusRequest added in v1.99.0

func (c *SSM) GetConnectionStatusRequest(input *GetConnectionStatusInput) (req *request.Request, output *GetConnectionStatusOutput)

GetConnectionStatusRequest generates a "aws/request.Request" representing the client's request for the GetConnectionStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConnectionStatus for more information on using the GetConnectionStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetConnectionStatusRequest method.
req, resp := client.GetConnectionStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetConnectionStatus

func (*SSM) GetConnectionStatusWithContext added in v1.99.0

func (c *SSM) GetConnectionStatusWithContext(ctx aws.Context, input *GetConnectionStatusInput, opts ...request.Option) (*GetConnectionStatusOutput, error)

GetConnectionStatusWithContext is the same as GetConnectionStatus with the addition of the ability to pass a context and additional request options.

See GetConnectionStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetDefaultPatchBaseline added in v1.6.4

func (c *SSM) GetDefaultPatchBaseline(input *GetDefaultPatchBaselineInput) (*GetDefaultPatchBaselineOutput, error)

GetDefaultPatchBaseline API operation for Amazon Simple Systems Manager (SSM).

Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you do not specify an operating system value, the default patch baseline for Windows is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetDefaultPatchBaseline for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDefaultPatchBaseline

func (*SSM) GetDefaultPatchBaselineRequest added in v1.6.4

func (c *SSM) GetDefaultPatchBaselineRequest(input *GetDefaultPatchBaselineInput) (req *request.Request, output *GetDefaultPatchBaselineOutput)

GetDefaultPatchBaselineRequest generates a "aws/request.Request" representing the client's request for the GetDefaultPatchBaseline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDefaultPatchBaseline for more information on using the GetDefaultPatchBaseline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDefaultPatchBaselineRequest method.
req, resp := client.GetDefaultPatchBaselineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDefaultPatchBaseline

func (*SSM) GetDefaultPatchBaselineWithContext added in v1.8.0

func (c *SSM) GetDefaultPatchBaselineWithContext(ctx aws.Context, input *GetDefaultPatchBaselineInput, opts ...request.Option) (*GetDefaultPatchBaselineOutput, error)

GetDefaultPatchBaselineWithContext is the same as GetDefaultPatchBaseline with the addition of the ability to pass a context and additional request options.

See GetDefaultPatchBaseline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetDeployablePatchSnapshotForInstance added in v1.6.4

func (c *SSM) GetDeployablePatchSnapshotForInstance(input *GetDeployablePatchSnapshotForInstanceInput) (*GetDeployablePatchSnapshotForInstanceOutput, error)

GetDeployablePatchSnapshotForInstance API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetDeployablePatchSnapshotForInstance for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeUnsupportedOperatingSystem "UnsupportedOperatingSystem" The operating systems you specified is not supported, or the operation is not supported for the operating system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.

  • ErrCodeUnsupportedFeatureRequiredException "UnsupportedFeatureRequiredException" Microsoft application patching is only available on EC2 instances and Advanced Instances. To patch Microsoft applications on on-premises servers and VMs, you must enable Advanced Instances. For more information, see Using the Advanced-Instances Tier (http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html) in the AWS Systems Manager User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance

func (*SSM) GetDeployablePatchSnapshotForInstanceRequest added in v1.6.4

func (c *SSM) GetDeployablePatchSnapshotForInstanceRequest(input *GetDeployablePatchSnapshotForInstanceInput) (req *request.Request, output *GetDeployablePatchSnapshotForInstanceOutput)

GetDeployablePatchSnapshotForInstanceRequest generates a "aws/request.Request" representing the client's request for the GetDeployablePatchSnapshotForInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDeployablePatchSnapshotForInstance for more information on using the GetDeployablePatchSnapshotForInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDeployablePatchSnapshotForInstanceRequest method.
req, resp := client.GetDeployablePatchSnapshotForInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDeployablePatchSnapshotForInstance

func (*SSM) GetDeployablePatchSnapshotForInstanceWithContext added in v1.8.0

func (c *SSM) GetDeployablePatchSnapshotForInstanceWithContext(ctx aws.Context, input *GetDeployablePatchSnapshotForInstanceInput, opts ...request.Option) (*GetDeployablePatchSnapshotForInstanceOutput, error)

GetDeployablePatchSnapshotForInstanceWithContext is the same as GetDeployablePatchSnapshotForInstance with the addition of the ability to pass a context and additional request options.

See GetDeployablePatchSnapshotForInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetDocument

func (c *SSM) GetDocument(input *GetDocumentInput) (*GetDocumentOutput, error)

GetDocument API operation for Amazon Simple Systems Manager (SSM).

Gets the contents of the specified Systems Manager document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetDocument for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocument

func (*SSM) GetDocumentRequest

func (c *SSM) GetDocumentRequest(input *GetDocumentInput) (req *request.Request, output *GetDocumentOutput)

GetDocumentRequest generates a "aws/request.Request" representing the client's request for the GetDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDocument for more information on using the GetDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDocumentRequest method.
req, resp := client.GetDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetDocument

func (*SSM) GetDocumentWithContext added in v1.8.0

func (c *SSM) GetDocumentWithContext(ctx aws.Context, input *GetDocumentInput, opts ...request.Option) (*GetDocumentOutput, error)

GetDocumentWithContext is the same as GetDocument with the addition of the ability to pass a context and additional request options.

See GetDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetInventory added in v1.5.13

func (c *SSM) GetInventory(input *GetInventoryInput) (*GetInventoryOutput, error)

GetInventory API operation for Amazon Simple Systems Manager (SSM).

Query inventory information.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetInventory for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidInventoryGroupException "InvalidInventoryGroupException" The specified inventory group is not valid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInvalidTypeNameException "InvalidTypeNameException" The parameter type name is not valid.

  • ErrCodeInvalidAggregatorException "InvalidAggregatorException" The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.

  • ErrCodeInvalidResultAttributeException "InvalidResultAttributeException" The specified inventory item result attribute is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetInventory

func (*SSM) GetInventoryRequest added in v1.5.13

func (c *SSM) GetInventoryRequest(input *GetInventoryInput) (req *request.Request, output *GetInventoryOutput)

GetInventoryRequest generates a "aws/request.Request" representing the client's request for the GetInventory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInventory for more information on using the GetInventory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInventoryRequest method.
req, resp := client.GetInventoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetInventory

func (*SSM) GetInventorySchema added in v1.5.13

func (c *SSM) GetInventorySchema(input *GetInventorySchemaInput) (*GetInventorySchemaOutput, error)

GetInventorySchema API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetInventorySchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidTypeNameException "InvalidTypeNameException" The parameter type name is not valid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetInventorySchema

func (*SSM) GetInventorySchemaRequest added in v1.5.13

func (c *SSM) GetInventorySchemaRequest(input *GetInventorySchemaInput) (req *request.Request, output *GetInventorySchemaOutput)

GetInventorySchemaRequest generates a "aws/request.Request" representing the client's request for the GetInventorySchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInventorySchema for more information on using the GetInventorySchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInventorySchemaRequest method.
req, resp := client.GetInventorySchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetInventorySchema

func (*SSM) GetInventorySchemaWithContext added in v1.8.0

func (c *SSM) GetInventorySchemaWithContext(ctx aws.Context, input *GetInventorySchemaInput, opts ...request.Option) (*GetInventorySchemaOutput, error)

GetInventorySchemaWithContext is the same as GetInventorySchema with the addition of the ability to pass a context and additional request options.

See GetInventorySchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetInventoryWithContext added in v1.8.0

func (c *SSM) GetInventoryWithContext(ctx aws.Context, input *GetInventoryInput, opts ...request.Option) (*GetInventoryOutput, error)

GetInventoryWithContext is the same as GetInventory with the addition of the ability to pass a context and additional request options.

See GetInventory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetMaintenanceWindow added in v1.5.13

func (c *SSM) GetMaintenanceWindow(input *GetMaintenanceWindowInput) (*GetMaintenanceWindowOutput, error)

GetMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Retrieves a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindow

func (*SSM) GetMaintenanceWindowExecution added in v1.5.13

func (c *SSM) GetMaintenanceWindowExecution(input *GetMaintenanceWindowExecutionInput) (*GetMaintenanceWindowExecutionOutput, error)

GetMaintenanceWindowExecution API operation for Amazon Simple Systems Manager (SSM).

Retrieves details about a specific a maintenance window execution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetMaintenanceWindowExecution for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecution

func (*SSM) GetMaintenanceWindowExecutionRequest added in v1.5.13

func (c *SSM) GetMaintenanceWindowExecutionRequest(input *GetMaintenanceWindowExecutionInput) (req *request.Request, output *GetMaintenanceWindowExecutionOutput)

GetMaintenanceWindowExecutionRequest generates a "aws/request.Request" representing the client's request for the GetMaintenanceWindowExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMaintenanceWindowExecution for more information on using the GetMaintenanceWindowExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMaintenanceWindowExecutionRequest method.
req, resp := client.GetMaintenanceWindowExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecution

func (*SSM) GetMaintenanceWindowExecutionTask added in v1.5.13

func (c *SSM) GetMaintenanceWindowExecutionTask(input *GetMaintenanceWindowExecutionTaskInput) (*GetMaintenanceWindowExecutionTaskOutput, error)

GetMaintenanceWindowExecutionTask API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetMaintenanceWindowExecutionTask for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionTask

func (*SSM) GetMaintenanceWindowExecutionTaskInvocation added in v1.10.25

func (c *SSM) GetMaintenanceWindowExecutionTaskInvocation(input *GetMaintenanceWindowExecutionTaskInvocationInput) (*GetMaintenanceWindowExecutionTaskInvocationOutput, error)

GetMaintenanceWindowExecutionTaskInvocation API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetMaintenanceWindowExecutionTaskInvocation for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation

func (*SSM) GetMaintenanceWindowExecutionTaskInvocationRequest added in v1.10.25

func (c *SSM) GetMaintenanceWindowExecutionTaskInvocationRequest(input *GetMaintenanceWindowExecutionTaskInvocationInput) (req *request.Request, output *GetMaintenanceWindowExecutionTaskInvocationOutput)

GetMaintenanceWindowExecutionTaskInvocationRequest generates a "aws/request.Request" representing the client's request for the GetMaintenanceWindowExecutionTaskInvocation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMaintenanceWindowExecutionTaskInvocation for more information on using the GetMaintenanceWindowExecutionTaskInvocation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMaintenanceWindowExecutionTaskInvocationRequest method.
req, resp := client.GetMaintenanceWindowExecutionTaskInvocationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionTaskInvocation

func (*SSM) GetMaintenanceWindowExecutionTaskInvocationWithContext added in v1.10.25

func (c *SSM) GetMaintenanceWindowExecutionTaskInvocationWithContext(ctx aws.Context, input *GetMaintenanceWindowExecutionTaskInvocationInput, opts ...request.Option) (*GetMaintenanceWindowExecutionTaskInvocationOutput, error)

GetMaintenanceWindowExecutionTaskInvocationWithContext is the same as GetMaintenanceWindowExecutionTaskInvocation with the addition of the ability to pass a context and additional request options.

See GetMaintenanceWindowExecutionTaskInvocation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetMaintenanceWindowExecutionTaskRequest added in v1.5.13

func (c *SSM) GetMaintenanceWindowExecutionTaskRequest(input *GetMaintenanceWindowExecutionTaskInput) (req *request.Request, output *GetMaintenanceWindowExecutionTaskOutput)

GetMaintenanceWindowExecutionTaskRequest generates a "aws/request.Request" representing the client's request for the GetMaintenanceWindowExecutionTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMaintenanceWindowExecutionTask for more information on using the GetMaintenanceWindowExecutionTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMaintenanceWindowExecutionTaskRequest method.
req, resp := client.GetMaintenanceWindowExecutionTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowExecutionTask

func (*SSM) GetMaintenanceWindowExecutionTaskWithContext added in v1.8.0

func (c *SSM) GetMaintenanceWindowExecutionTaskWithContext(ctx aws.Context, input *GetMaintenanceWindowExecutionTaskInput, opts ...request.Option) (*GetMaintenanceWindowExecutionTaskOutput, error)

GetMaintenanceWindowExecutionTaskWithContext is the same as GetMaintenanceWindowExecutionTask with the addition of the ability to pass a context and additional request options.

See GetMaintenanceWindowExecutionTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetMaintenanceWindowExecutionWithContext added in v1.8.0

func (c *SSM) GetMaintenanceWindowExecutionWithContext(ctx aws.Context, input *GetMaintenanceWindowExecutionInput, opts ...request.Option) (*GetMaintenanceWindowExecutionOutput, error)

GetMaintenanceWindowExecutionWithContext is the same as GetMaintenanceWindowExecution with the addition of the ability to pass a context and additional request options.

See GetMaintenanceWindowExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetMaintenanceWindowRequest added in v1.5.13

func (c *SSM) GetMaintenanceWindowRequest(input *GetMaintenanceWindowInput) (req *request.Request, output *GetMaintenanceWindowOutput)

GetMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the GetMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMaintenanceWindow for more information on using the GetMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMaintenanceWindowRequest method.
req, resp := client.GetMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindow

func (*SSM) GetMaintenanceWindowTask added in v1.10.25

func (c *SSM) GetMaintenanceWindowTask(input *GetMaintenanceWindowTaskInput) (*GetMaintenanceWindowTaskOutput, error)

GetMaintenanceWindowTask API operation for Amazon Simple Systems Manager (SSM).

Lists the tasks in a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetMaintenanceWindowTask for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowTask

func (*SSM) GetMaintenanceWindowTaskRequest added in v1.10.25

func (c *SSM) GetMaintenanceWindowTaskRequest(input *GetMaintenanceWindowTaskInput) (req *request.Request, output *GetMaintenanceWindowTaskOutput)

GetMaintenanceWindowTaskRequest generates a "aws/request.Request" representing the client's request for the GetMaintenanceWindowTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMaintenanceWindowTask for more information on using the GetMaintenanceWindowTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMaintenanceWindowTaskRequest method.
req, resp := client.GetMaintenanceWindowTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetMaintenanceWindowTask

func (*SSM) GetMaintenanceWindowTaskWithContext added in v1.10.25

func (c *SSM) GetMaintenanceWindowTaskWithContext(ctx aws.Context, input *GetMaintenanceWindowTaskInput, opts ...request.Option) (*GetMaintenanceWindowTaskOutput, error)

GetMaintenanceWindowTaskWithContext is the same as GetMaintenanceWindowTask with the addition of the ability to pass a context and additional request options.

See GetMaintenanceWindowTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) GetMaintenanceWindowWithContext(ctx aws.Context, input *GetMaintenanceWindowInput, opts ...request.Option) (*GetMaintenanceWindowOutput, error)

GetMaintenanceWindowWithContext is the same as GetMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See GetMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetOpsItem added in v1.99.0

func (c *SSM) GetOpsItem(input *GetOpsItemInput) (*GetOpsItemOutput, error)

GetOpsItem API operation for Amazon Simple Systems Manager (SSM).

Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting Started with OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetOpsItem for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeOpsItemNotFoundException "OpsItemNotFoundException" The specified OpsItem ID doesn't exist. Verify the ID and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsItem

func (*SSM) GetOpsItemRequest added in v1.99.0

func (c *SSM) GetOpsItemRequest(input *GetOpsItemInput) (req *request.Request, output *GetOpsItemOutput)

GetOpsItemRequest generates a "aws/request.Request" representing the client's request for the GetOpsItem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOpsItem for more information on using the GetOpsItem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOpsItemRequest method.
req, resp := client.GetOpsItemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsItem

func (*SSM) GetOpsItemWithContext added in v1.99.0

func (c *SSM) GetOpsItemWithContext(ctx aws.Context, input *GetOpsItemInput, opts ...request.Option) (*GetOpsItemOutput, error)

GetOpsItemWithContext is the same as GetOpsItem with the addition of the ability to pass a context and additional request options.

See GetOpsItem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetOpsSummary added in v1.99.0

func (c *SSM) GetOpsSummary(input *GetOpsSummaryInput) (*GetOpsSummaryOutput, error)

GetOpsSummary API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetOpsSummary for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInvalidTypeNameException "InvalidTypeNameException" The parameter type name is not valid.

  • ErrCodeInvalidAggregatorException "InvalidAggregatorException" The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsSummary

func (*SSM) GetOpsSummaryRequest added in v1.99.0

func (c *SSM) GetOpsSummaryRequest(input *GetOpsSummaryInput) (req *request.Request, output *GetOpsSummaryOutput)

GetOpsSummaryRequest generates a "aws/request.Request" representing the client's request for the GetOpsSummary operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOpsSummary for more information on using the GetOpsSummary API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOpsSummaryRequest method.
req, resp := client.GetOpsSummaryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetOpsSummary

func (*SSM) GetOpsSummaryWithContext added in v1.99.0

func (c *SSM) GetOpsSummaryWithContext(ctx aws.Context, input *GetOpsSummaryInput, opts ...request.Option) (*GetOpsSummaryOutput, error)

GetOpsSummaryWithContext is the same as GetOpsSummary with the addition of the ability to pass a context and additional request options.

See GetOpsSummary for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetParameter added in v1.10.1

func (c *SSM) GetParameter(input *GetParameterInput) (*GetParameterOutput, error)

GetParameter API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetParameter for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidKeyId "InvalidKeyId" The query key ID is not valid.

  • ErrCodeParameterNotFound "ParameterNotFound" The parameter could not be found. Verify the name and try again.

  • ErrCodeParameterVersionNotFound "ParameterVersionNotFound" The specified parameter version was not found. Verify the parameter name and version, and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameter

func (*SSM) GetParameterHistory added in v1.5.13

func (c *SSM) GetParameterHistory(input *GetParameterHistoryInput) (*GetParameterHistoryOutput, error)

GetParameterHistory API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetParameterHistory for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeParameterNotFound "ParameterNotFound" The parameter could not be found. Verify the name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInvalidKeyId "InvalidKeyId" The query key ID is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameterHistory

func (*SSM) GetParameterHistoryPages added in v1.10.1

func (c *SSM) GetParameterHistoryPages(input *GetParameterHistoryInput, fn func(*GetParameterHistoryOutput, bool) bool) error

GetParameterHistoryPages iterates over the pages of a GetParameterHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetParameterHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetParameterHistory operation.
pageNum := 0
err := client.GetParameterHistoryPages(params,
    func(page *ssm.GetParameterHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) GetParameterHistoryPagesWithContext added in v1.10.1

func (c *SSM) GetParameterHistoryPagesWithContext(ctx aws.Context, input *GetParameterHistoryInput, fn func(*GetParameterHistoryOutput, bool) bool, opts ...request.Option) error

GetParameterHistoryPagesWithContext same as GetParameterHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetParameterHistoryRequest added in v1.5.13

func (c *SSM) GetParameterHistoryRequest(input *GetParameterHistoryInput) (req *request.Request, output *GetParameterHistoryOutput)

GetParameterHistoryRequest generates a "aws/request.Request" representing the client's request for the GetParameterHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetParameterHistory for more information on using the GetParameterHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetParameterHistoryRequest method.
req, resp := client.GetParameterHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameterHistory

func (*SSM) GetParameterHistoryWithContext added in v1.8.0

func (c *SSM) GetParameterHistoryWithContext(ctx aws.Context, input *GetParameterHistoryInput, opts ...request.Option) (*GetParameterHistoryOutput, error)

GetParameterHistoryWithContext is the same as GetParameterHistory with the addition of the ability to pass a context and additional request options.

See GetParameterHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetParameterRequest added in v1.10.1

func (c *SSM) GetParameterRequest(input *GetParameterInput) (req *request.Request, output *GetParameterOutput)

GetParameterRequest generates a "aws/request.Request" representing the client's request for the GetParameter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetParameter for more information on using the GetParameter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetParameterRequest method.
req, resp := client.GetParameterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameter

func (*SSM) GetParameterWithContext added in v1.10.1

func (c *SSM) GetParameterWithContext(ctx aws.Context, input *GetParameterInput, opts ...request.Option) (*GetParameterOutput, error)

GetParameterWithContext is the same as GetParameter with the addition of the ability to pass a context and additional request options.

See GetParameter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetParameters added in v1.5.13

func (c *SSM) GetParameters(input *GetParametersInput) (*GetParametersOutput, error)

GetParameters API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetParameters for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidKeyId "InvalidKeyId" The query key ID is not valid.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameters

func (*SSM) GetParametersByPath added in v1.10.1

func (c *SSM) GetParametersByPath(input *GetParametersByPathInput) (*GetParametersByPathOutput, error)

GetParametersByPath API operation for Amazon Simple Systems Manager (SSM).

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-working.html) in the AWS Systems Manager User Guide.

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.

This API action doesn't support filtering by tags.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetParametersByPath for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

  • ErrCodeInvalidFilterOption "InvalidFilterOption" The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

  • ErrCodeInvalidFilterValue "InvalidFilterValue" The filter value is not valid. Verify the value and try again.

  • ErrCodeInvalidKeyId "InvalidKeyId" The query key ID is not valid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParametersByPath

func (*SSM) GetParametersByPathPages added in v1.10.1

func (c *SSM) GetParametersByPathPages(input *GetParametersByPathInput, fn func(*GetParametersByPathOutput, bool) bool) error

GetParametersByPathPages iterates over the pages of a GetParametersByPath operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetParametersByPath method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetParametersByPath operation.
pageNum := 0
err := client.GetParametersByPathPages(params,
    func(page *ssm.GetParametersByPathOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) GetParametersByPathPagesWithContext added in v1.10.1

func (c *SSM) GetParametersByPathPagesWithContext(ctx aws.Context, input *GetParametersByPathInput, fn func(*GetParametersByPathOutput, bool) bool, opts ...request.Option) error

GetParametersByPathPagesWithContext same as GetParametersByPathPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetParametersByPathRequest added in v1.10.1

func (c *SSM) GetParametersByPathRequest(input *GetParametersByPathInput) (req *request.Request, output *GetParametersByPathOutput)

GetParametersByPathRequest generates a "aws/request.Request" representing the client's request for the GetParametersByPath operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetParametersByPath for more information on using the GetParametersByPath API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetParametersByPathRequest method.
req, resp := client.GetParametersByPathRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParametersByPath

func (*SSM) GetParametersByPathWithContext added in v1.10.1

func (c *SSM) GetParametersByPathWithContext(ctx aws.Context, input *GetParametersByPathInput, opts ...request.Option) (*GetParametersByPathOutput, error)

GetParametersByPathWithContext is the same as GetParametersByPath with the addition of the ability to pass a context and additional request options.

See GetParametersByPath for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetParametersRequest added in v1.5.13

func (c *SSM) GetParametersRequest(input *GetParametersInput) (req *request.Request, output *GetParametersOutput)

GetParametersRequest generates a "aws/request.Request" representing the client's request for the GetParameters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetParameters for more information on using the GetParameters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetParametersRequest method.
req, resp := client.GetParametersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetParameters

func (*SSM) GetParametersWithContext added in v1.8.0

func (c *SSM) GetParametersWithContext(ctx aws.Context, input *GetParametersInput, opts ...request.Option) (*GetParametersOutput, error)

GetParametersWithContext is the same as GetParameters with the addition of the ability to pass a context and additional request options.

See GetParameters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetPatchBaseline added in v1.6.4

func (c *SSM) GetPatchBaseline(input *GetPatchBaselineInput) (*GetPatchBaselineOutput, error)

GetPatchBaseline API operation for Amazon Simple Systems Manager (SSM).

Retrieves information about a patch baseline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetPatchBaseline for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetPatchBaseline

func (*SSM) GetPatchBaselineForPatchGroup added in v1.6.4

func (c *SSM) GetPatchBaselineForPatchGroup(input *GetPatchBaselineForPatchGroupInput) (*GetPatchBaselineForPatchGroupOutput, error)

GetPatchBaselineForPatchGroup API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetPatchBaselineForPatchGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetPatchBaselineForPatchGroup

func (*SSM) GetPatchBaselineForPatchGroupRequest added in v1.6.4

func (c *SSM) GetPatchBaselineForPatchGroupRequest(input *GetPatchBaselineForPatchGroupInput) (req *request.Request, output *GetPatchBaselineForPatchGroupOutput)

GetPatchBaselineForPatchGroupRequest generates a "aws/request.Request" representing the client's request for the GetPatchBaselineForPatchGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPatchBaselineForPatchGroup for more information on using the GetPatchBaselineForPatchGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPatchBaselineForPatchGroupRequest method.
req, resp := client.GetPatchBaselineForPatchGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetPatchBaselineForPatchGroup

func (*SSM) GetPatchBaselineForPatchGroupWithContext added in v1.8.0

func (c *SSM) GetPatchBaselineForPatchGroupWithContext(ctx aws.Context, input *GetPatchBaselineForPatchGroupInput, opts ...request.Option) (*GetPatchBaselineForPatchGroupOutput, error)

GetPatchBaselineForPatchGroupWithContext is the same as GetPatchBaselineForPatchGroup with the addition of the ability to pass a context and additional request options.

See GetPatchBaselineForPatchGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetPatchBaselineRequest added in v1.6.4

func (c *SSM) GetPatchBaselineRequest(input *GetPatchBaselineInput) (req *request.Request, output *GetPatchBaselineOutput)

GetPatchBaselineRequest generates a "aws/request.Request" representing the client's request for the GetPatchBaseline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPatchBaseline for more information on using the GetPatchBaseline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPatchBaselineRequest method.
req, resp := client.GetPatchBaselineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetPatchBaseline

func (*SSM) GetPatchBaselineWithContext added in v1.8.0

func (c *SSM) GetPatchBaselineWithContext(ctx aws.Context, input *GetPatchBaselineInput, opts ...request.Option) (*GetPatchBaselineOutput, error)

GetPatchBaselineWithContext is the same as GetPatchBaseline with the addition of the ability to pass a context and additional request options.

See GetPatchBaseline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) GetServiceSetting added in v1.99.0

func (c *SSM) GetServiceSetting(input *GetServiceSettingInput) (*GetServiceSettingOutput, error)

GetServiceSetting API operation for Amazon Simple Systems Manager (SSM).

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

Query the current service setting for the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation GetServiceSetting for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeServiceSettingNotFound "ServiceSettingNotFound" The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetServiceSetting

func (*SSM) GetServiceSettingRequest added in v1.99.0

func (c *SSM) GetServiceSettingRequest(input *GetServiceSettingInput) (req *request.Request, output *GetServiceSettingOutput)

GetServiceSettingRequest generates a "aws/request.Request" representing the client's request for the GetServiceSetting operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetServiceSetting for more information on using the GetServiceSetting API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetServiceSettingRequest method.
req, resp := client.GetServiceSettingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetServiceSetting

func (*SSM) GetServiceSettingWithContext added in v1.99.0

func (c *SSM) GetServiceSettingWithContext(ctx aws.Context, input *GetServiceSettingInput, opts ...request.Option) (*GetServiceSettingOutput, error)

GetServiceSettingWithContext is the same as GetServiceSetting with the addition of the ability to pass a context and additional request options.

See GetServiceSetting for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) LabelParameterVersion added in v1.99.0

func (c *SSM) LabelParameterVersion(input *LabelParameterVersionInput) (*LabelParameterVersionOutput, error)

LabelParameterVersion API operation for Amazon Simple Systems Manager (SSM).

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

Parameter labels have the following requirements and restrictions.

  • A version of a parameter can have a maximum of 10 labels.

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

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

  • You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

  • You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.

  • A label can have a maximum of 100 characters.

  • Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation LabelParameterVersion for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

  • ErrCodeParameterNotFound "ParameterNotFound" The parameter could not be found. Verify the name and try again.

  • ErrCodeParameterVersionNotFound "ParameterVersionNotFound" The specified parameter version was not found. Verify the parameter name and version, and try again.

  • ErrCodeParameterVersionLabelLimitExceeded "ParameterVersionLabelLimitExceeded" A parameter version can have a maximum of ten labels.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/LabelParameterVersion

func (*SSM) LabelParameterVersionRequest added in v1.99.0

func (c *SSM) LabelParameterVersionRequest(input *LabelParameterVersionInput) (req *request.Request, output *LabelParameterVersionOutput)

LabelParameterVersionRequest generates a "aws/request.Request" representing the client's request for the LabelParameterVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See LabelParameterVersion for more information on using the LabelParameterVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the LabelParameterVersionRequest method.
req, resp := client.LabelParameterVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/LabelParameterVersion

func (*SSM) LabelParameterVersionWithContext added in v1.99.0

func (c *SSM) LabelParameterVersionWithContext(ctx aws.Context, input *LabelParameterVersionInput, opts ...request.Option) (*LabelParameterVersionOutput, error)

LabelParameterVersionWithContext is the same as LabelParameterVersion with the addition of the ability to pass a context and additional request options.

See LabelParameterVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListAssociationVersions added in v1.10.30

func (c *SSM) ListAssociationVersions(input *ListAssociationVersionsInput) (*ListAssociationVersionsOutput, error)

ListAssociationVersions API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListAssociationVersions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociationVersions

func (*SSM) ListAssociationVersionsRequest added in v1.10.30

func (c *SSM) ListAssociationVersionsRequest(input *ListAssociationVersionsInput) (req *request.Request, output *ListAssociationVersionsOutput)

ListAssociationVersionsRequest generates a "aws/request.Request" representing the client's request for the ListAssociationVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssociationVersions for more information on using the ListAssociationVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAssociationVersionsRequest method.
req, resp := client.ListAssociationVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociationVersions

func (*SSM) ListAssociationVersionsWithContext added in v1.10.30

func (c *SSM) ListAssociationVersionsWithContext(ctx aws.Context, input *ListAssociationVersionsInput, opts ...request.Option) (*ListAssociationVersionsOutput, error)

ListAssociationVersionsWithContext is the same as ListAssociationVersions with the addition of the ability to pass a context and additional request options.

See ListAssociationVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListAssociations

func (c *SSM) ListAssociations(input *ListAssociationsInput) (*ListAssociationsOutput, error)

ListAssociations API operation for Amazon Simple Systems Manager (SSM).

Lists the associations for the specified Systems Manager document or instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListAssociations for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociations

func (*SSM) ListAssociationsPages added in v1.1.0

func (c *SSM) ListAssociationsPages(input *ListAssociationsInput, fn func(*ListAssociationsOutput, bool) bool) error

ListAssociationsPages iterates over the pages of a ListAssociations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssociations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAssociations operation.
pageNum := 0
err := client.ListAssociationsPages(params,
    func(page *ssm.ListAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) ListAssociationsPagesWithContext added in v1.8.0

func (c *SSM) ListAssociationsPagesWithContext(ctx aws.Context, input *ListAssociationsInput, fn func(*ListAssociationsOutput, bool) bool, opts ...request.Option) error

ListAssociationsPagesWithContext same as ListAssociationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListAssociationsRequest

func (c *SSM) ListAssociationsRequest(input *ListAssociationsInput) (req *request.Request, output *ListAssociationsOutput)

ListAssociationsRequest generates a "aws/request.Request" representing the client's request for the ListAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssociations for more information on using the ListAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAssociationsRequest method.
req, resp := client.ListAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListAssociations

func (*SSM) ListAssociationsWithContext added in v1.8.0

func (c *SSM) ListAssociationsWithContext(ctx aws.Context, input *ListAssociationsInput, opts ...request.Option) (*ListAssociationsOutput, error)

ListAssociationsWithContext is the same as ListAssociations with the addition of the ability to pass a context and additional request options.

See ListAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListCommandInvocations added in v0.9.17

func (c *SSM) ListCommandInvocations(input *ListCommandInvocationsInput) (*ListCommandInvocationsOutput, error)

ListCommandInvocations API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListCommandInvocations for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidCommandId "InvalidCommandId"

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommandInvocations

func (*SSM) ListCommandInvocationsPages added in v1.1.0

func (c *SSM) ListCommandInvocationsPages(input *ListCommandInvocationsInput, fn func(*ListCommandInvocationsOutput, bool) bool) error

ListCommandInvocationsPages iterates over the pages of a ListCommandInvocations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCommandInvocations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCommandInvocations operation.
pageNum := 0
err := client.ListCommandInvocationsPages(params,
    func(page *ssm.ListCommandInvocationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) ListCommandInvocationsPagesWithContext added in v1.8.0

func (c *SSM) ListCommandInvocationsPagesWithContext(ctx aws.Context, input *ListCommandInvocationsInput, fn func(*ListCommandInvocationsOutput, bool) bool, opts ...request.Option) error

ListCommandInvocationsPagesWithContext same as ListCommandInvocationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListCommandInvocationsRequest added in v0.9.17

func (c *SSM) ListCommandInvocationsRequest(input *ListCommandInvocationsInput) (req *request.Request, output *ListCommandInvocationsOutput)

ListCommandInvocationsRequest generates a "aws/request.Request" representing the client's request for the ListCommandInvocations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCommandInvocations for more information on using the ListCommandInvocations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListCommandInvocationsRequest method.
req, resp := client.ListCommandInvocationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommandInvocations

func (*SSM) ListCommandInvocationsWithContext added in v1.8.0

func (c *SSM) ListCommandInvocationsWithContext(ctx aws.Context, input *ListCommandInvocationsInput, opts ...request.Option) (*ListCommandInvocationsOutput, error)

ListCommandInvocationsWithContext is the same as ListCommandInvocations with the addition of the ability to pass a context and additional request options.

See ListCommandInvocations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListCommands added in v0.9.17

func (c *SSM) ListCommands(input *ListCommandsInput) (*ListCommandsOutput, error)

ListCommands API operation for Amazon Simple Systems Manager (SSM).

Lists the commands requested by users of the AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListCommands for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidCommandId "InvalidCommandId"

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommands

func (*SSM) ListCommandsPages added in v1.1.0

func (c *SSM) ListCommandsPages(input *ListCommandsInput, fn func(*ListCommandsOutput, bool) bool) error

ListCommandsPages iterates over the pages of a ListCommands operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCommands method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCommands operation.
pageNum := 0
err := client.ListCommandsPages(params,
    func(page *ssm.ListCommandsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) ListCommandsPagesWithContext added in v1.8.0

func (c *SSM) ListCommandsPagesWithContext(ctx aws.Context, input *ListCommandsInput, fn func(*ListCommandsOutput, bool) bool, opts ...request.Option) error

ListCommandsPagesWithContext same as ListCommandsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListCommandsRequest added in v0.9.17

func (c *SSM) ListCommandsRequest(input *ListCommandsInput) (req *request.Request, output *ListCommandsOutput)

ListCommandsRequest generates a "aws/request.Request" representing the client's request for the ListCommands operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCommands for more information on using the ListCommands API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListCommandsRequest method.
req, resp := client.ListCommandsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListCommands

func (*SSM) ListCommandsWithContext added in v1.8.0

func (c *SSM) ListCommandsWithContext(ctx aws.Context, input *ListCommandsInput, opts ...request.Option) (*ListCommandsOutput, error)

ListCommandsWithContext is the same as ListCommands with the addition of the ability to pass a context and additional request options.

See ListCommands for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListComplianceItems added in v1.10.25

func (c *SSM) ListComplianceItems(input *ListComplianceItemsInput) (*ListComplianceItemsOutput, error)

ListComplianceItems API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListComplianceItems for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidResourceType "InvalidResourceType" The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListComplianceItems

func (*SSM) ListComplianceItemsRequest added in v1.10.25

func (c *SSM) ListComplianceItemsRequest(input *ListComplianceItemsInput) (req *request.Request, output *ListComplianceItemsOutput)

ListComplianceItemsRequest generates a "aws/request.Request" representing the client's request for the ListComplianceItems operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListComplianceItems for more information on using the ListComplianceItems API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListComplianceItemsRequest method.
req, resp := client.ListComplianceItemsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListComplianceItems

func (*SSM) ListComplianceItemsWithContext added in v1.10.25

func (c *SSM) ListComplianceItemsWithContext(ctx aws.Context, input *ListComplianceItemsInput, opts ...request.Option) (*ListComplianceItemsOutput, error)

ListComplianceItemsWithContext is the same as ListComplianceItems with the addition of the ability to pass a context and additional request options.

See ListComplianceItems for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListComplianceSummaries added in v1.10.25

func (c *SSM) ListComplianceSummaries(input *ListComplianceSummariesInput) (*ListComplianceSummariesOutput, error)

ListComplianceSummaries API operation for Amazon Simple Systems Manager (SSM).

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListComplianceSummaries for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListComplianceSummaries

func (*SSM) ListComplianceSummariesRequest added in v1.10.25

func (c *SSM) ListComplianceSummariesRequest(input *ListComplianceSummariesInput) (req *request.Request, output *ListComplianceSummariesOutput)

ListComplianceSummariesRequest generates a "aws/request.Request" representing the client's request for the ListComplianceSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListComplianceSummaries for more information on using the ListComplianceSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListComplianceSummariesRequest method.
req, resp := client.ListComplianceSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListComplianceSummaries

func (*SSM) ListComplianceSummariesWithContext added in v1.10.25

func (c *SSM) ListComplianceSummariesWithContext(ctx aws.Context, input *ListComplianceSummariesInput, opts ...request.Option) (*ListComplianceSummariesOutput, error)

ListComplianceSummariesWithContext is the same as ListComplianceSummaries with the addition of the ability to pass a context and additional request options.

See ListComplianceSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListDocumentVersions added in v1.5.13

func (c *SSM) ListDocumentVersions(input *ListDocumentVersionsInput) (*ListDocumentVersionsOutput, error)

ListDocumentVersions API operation for Amazon Simple Systems Manager (SSM).

List all versions for a document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListDocumentVersions for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentVersions

func (*SSM) ListDocumentVersionsRequest added in v1.5.13

func (c *SSM) ListDocumentVersionsRequest(input *ListDocumentVersionsInput) (req *request.Request, output *ListDocumentVersionsOutput)

ListDocumentVersionsRequest generates a "aws/request.Request" representing the client's request for the ListDocumentVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDocumentVersions for more information on using the ListDocumentVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDocumentVersionsRequest method.
req, resp := client.ListDocumentVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocumentVersions

func (*SSM) ListDocumentVersionsWithContext added in v1.8.0

func (c *SSM) ListDocumentVersionsWithContext(ctx aws.Context, input *ListDocumentVersionsInput, opts ...request.Option) (*ListDocumentVersionsOutput, error)

ListDocumentVersionsWithContext is the same as ListDocumentVersions with the addition of the ability to pass a context and additional request options.

See ListDocumentVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListDocuments

func (c *SSM) ListDocuments(input *ListDocumentsInput) (*ListDocumentsOutput, error)

ListDocuments API operation for Amazon Simple Systems Manager (SSM).

Describes one or more of your Systems Manager documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListDocuments for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInvalidFilterKey "InvalidFilterKey" The specified key is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocuments

func (*SSM) ListDocumentsPages added in v1.1.0

func (c *SSM) ListDocumentsPages(input *ListDocumentsInput, fn func(*ListDocumentsOutput, bool) bool) error

ListDocumentsPages iterates over the pages of a ListDocuments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDocuments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDocuments operation.
pageNum := 0
err := client.ListDocumentsPages(params,
    func(page *ssm.ListDocumentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SSM) ListDocumentsPagesWithContext added in v1.8.0

func (c *SSM) ListDocumentsPagesWithContext(ctx aws.Context, input *ListDocumentsInput, fn func(*ListDocumentsOutput, bool) bool, opts ...request.Option) error

ListDocumentsPagesWithContext same as ListDocumentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListDocumentsRequest

func (c *SSM) ListDocumentsRequest(input *ListDocumentsInput) (req *request.Request, output *ListDocumentsOutput)

ListDocumentsRequest generates a "aws/request.Request" representing the client's request for the ListDocuments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDocuments for more information on using the ListDocuments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDocumentsRequest method.
req, resp := client.ListDocumentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListDocuments

func (*SSM) ListDocumentsWithContext added in v1.8.0

func (c *SSM) ListDocumentsWithContext(ctx aws.Context, input *ListDocumentsInput, opts ...request.Option) (*ListDocumentsOutput, error)

ListDocumentsWithContext is the same as ListDocuments with the addition of the ability to pass a context and additional request options.

See ListDocuments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListInventoryEntries added in v1.5.13

func (c *SSM) ListInventoryEntries(input *ListInventoryEntriesInput) (*ListInventoryEntriesOutput, error)

ListInventoryEntries API operation for Amazon Simple Systems Manager (SSM).

A list of inventory items returned by the request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListInventoryEntries for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidTypeNameException "InvalidTypeNameException" The parameter type name is not valid.

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListInventoryEntries

func (*SSM) ListInventoryEntriesRequest added in v1.5.13

func (c *SSM) ListInventoryEntriesRequest(input *ListInventoryEntriesInput) (req *request.Request, output *ListInventoryEntriesOutput)

ListInventoryEntriesRequest generates a "aws/request.Request" representing the client's request for the ListInventoryEntries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListInventoryEntries for more information on using the ListInventoryEntries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListInventoryEntriesRequest method.
req, resp := client.ListInventoryEntriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListInventoryEntries

func (*SSM) ListInventoryEntriesWithContext added in v1.8.0

func (c *SSM) ListInventoryEntriesWithContext(ctx aws.Context, input *ListInventoryEntriesInput, opts ...request.Option) (*ListInventoryEntriesOutput, error)

ListInventoryEntriesWithContext is the same as ListInventoryEntries with the addition of the ability to pass a context and additional request options.

See ListInventoryEntries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListResourceComplianceSummaries added in v1.10.25

func (c *SSM) ListResourceComplianceSummaries(input *ListResourceComplianceSummariesInput) (*ListResourceComplianceSummariesOutput, error)

ListResourceComplianceSummaries API operation for Amazon Simple Systems Manager (SSM).

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListResourceComplianceSummaries for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidFilter "InvalidFilter" The filter name is not valid. Verify the you entered the correct name and try again.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListResourceComplianceSummaries

func (*SSM) ListResourceComplianceSummariesRequest added in v1.10.25

func (c *SSM) ListResourceComplianceSummariesRequest(input *ListResourceComplianceSummariesInput) (req *request.Request, output *ListResourceComplianceSummariesOutput)

ListResourceComplianceSummariesRequest generates a "aws/request.Request" representing the client's request for the ListResourceComplianceSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListResourceComplianceSummaries for more information on using the ListResourceComplianceSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListResourceComplianceSummariesRequest method.
req, resp := client.ListResourceComplianceSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListResourceComplianceSummaries

func (*SSM) ListResourceComplianceSummariesWithContext added in v1.10.25

func (c *SSM) ListResourceComplianceSummariesWithContext(ctx aws.Context, input *ListResourceComplianceSummariesInput, opts ...request.Option) (*ListResourceComplianceSummariesOutput, error)

ListResourceComplianceSummariesWithContext is the same as ListResourceComplianceSummaries with the addition of the ability to pass a context and additional request options.

See ListResourceComplianceSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListResourceDataSync added in v1.10.5

func (c *SSM) ListResourceDataSync(input *ListResourceDataSyncInput) (*ListResourceDataSyncOutput, error)

ListResourceDataSync API operation for Amazon Simple Systems Manager (SSM).

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListResourceDataSync for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidNextToken "InvalidNextToken" The specified token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListResourceDataSync

func (*SSM) ListResourceDataSyncRequest added in v1.10.5

func (c *SSM) ListResourceDataSyncRequest(input *ListResourceDataSyncInput) (req *request.Request, output *ListResourceDataSyncOutput)

ListResourceDataSyncRequest generates a "aws/request.Request" representing the client's request for the ListResourceDataSync operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListResourceDataSync for more information on using the ListResourceDataSync API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListResourceDataSyncRequest method.
req, resp := client.ListResourceDataSyncRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListResourceDataSync

func (*SSM) ListResourceDataSyncWithContext added in v1.10.5

func (c *SSM) ListResourceDataSyncWithContext(ctx aws.Context, input *ListResourceDataSyncInput, opts ...request.Option) (*ListResourceDataSyncOutput, error)

ListResourceDataSyncWithContext is the same as ListResourceDataSync with the addition of the ability to pass a context and additional request options.

See ListResourceDataSync for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ListTagsForResource added in v1.2.2

func (c *SSM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidResourceType "InvalidResourceType" The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListTagsForResource

func (*SSM) ListTagsForResourceRequest added in v1.2.2

func (c *SSM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ListTagsForResource

func (*SSM) ListTagsForResourceWithContext added in v1.8.0

func (c *SSM) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ModifyDocumentPermission added in v1.1.26

func (c *SSM) ModifyDocumentPermission(input *ModifyDocumentPermissionInput) (*ModifyDocumentPermissionOutput, error)

ModifyDocumentPermission API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ModifyDocumentPermission for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidPermissionType "InvalidPermissionType" The permission type is not supported. Share is the only supported permission type.

  • ErrCodeDocumentPermissionLimit "DocumentPermissionLimit" The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.

  • ErrCodeDocumentLimitExceeded "DocumentLimitExceeded" You can have at most 500 active Systems Manager documents.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ModifyDocumentPermission

func (*SSM) ModifyDocumentPermissionRequest added in v1.1.26

func (c *SSM) ModifyDocumentPermissionRequest(input *ModifyDocumentPermissionInput) (req *request.Request, output *ModifyDocumentPermissionOutput)

ModifyDocumentPermissionRequest generates a "aws/request.Request" representing the client's request for the ModifyDocumentPermission operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyDocumentPermission for more information on using the ModifyDocumentPermission API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ModifyDocumentPermissionRequest method.
req, resp := client.ModifyDocumentPermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ModifyDocumentPermission

func (*SSM) ModifyDocumentPermissionWithContext added in v1.8.0

func (c *SSM) ModifyDocumentPermissionWithContext(ctx aws.Context, input *ModifyDocumentPermissionInput, opts ...request.Option) (*ModifyDocumentPermissionOutput, error)

ModifyDocumentPermissionWithContext is the same as ModifyDocumentPermission with the addition of the ability to pass a context and additional request options.

See ModifyDocumentPermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) PutComplianceItems added in v1.10.25

func (c *SSM) PutComplianceItems(input *PutComplianceItemsInput) (*PutComplianceItemsOutput, error)

PutComplianceItems API operation for Amazon Simple Systems Manager (SSM).

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

ComplianceType can be one of the following:

  • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

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

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

  • Id: The patch, association, or custom compliance ID.

  • Title: A title.

  • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

  • Severity: A patch severity. For example, critical.

  • DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.

  • DocumentVersion: An SSM document version number. For example, 4.

  • Classification: A patch classification. For example, security updates.

  • PatchBaselineId: A patch baseline ID.

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

  • PatchState: A patch state. For example, InstancesWithFailedPatches.

  • PatchGroup: The name of a patch group.

  • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation PutComplianceItems for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidItemContentException "InvalidItemContentException" One or more content items is not valid.

  • ErrCodeTotalSizeLimitExceededException "TotalSizeLimitExceededException" The size of inventory data has exceeded the total size limit for the resource.

  • ErrCodeItemSizeLimitExceededException "ItemSizeLimitExceededException" The inventory item size has exceeded the size limit.

  • ErrCodeComplianceTypeCountLimitExceededException "ComplianceTypeCountLimitExceededException" You specified too many custom compliance types. You can specify a maximum of 10 different types.

  • ErrCodeInvalidResourceType "InvalidResourceType" The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutComplianceItems

func (*SSM) PutComplianceItemsRequest added in v1.10.25

func (c *SSM) PutComplianceItemsRequest(input *PutComplianceItemsInput) (req *request.Request, output *PutComplianceItemsOutput)

PutComplianceItemsRequest generates a "aws/request.Request" representing the client's request for the PutComplianceItems operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutComplianceItems for more information on using the PutComplianceItems API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutComplianceItemsRequest method.
req, resp := client.PutComplianceItemsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutComplianceItems

func (*SSM) PutComplianceItemsWithContext added in v1.10.25

func (c *SSM) PutComplianceItemsWithContext(ctx aws.Context, input *PutComplianceItemsInput, opts ...request.Option) (*PutComplianceItemsOutput, error)

PutComplianceItemsWithContext is the same as PutComplianceItems with the addition of the ability to pass a context and additional request options.

See PutComplianceItems for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) PutInventory added in v1.5.13

func (c *SSM) PutInventory(input *PutInventoryInput) (*PutInventoryOutput, error)

PutInventory API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation PutInventory for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidTypeNameException "InvalidTypeNameException" The parameter type name is not valid.

  • ErrCodeInvalidItemContentException "InvalidItemContentException" One or more content items is not valid.

  • ErrCodeTotalSizeLimitExceededException "TotalSizeLimitExceededException" The size of inventory data has exceeded the total size limit for the resource.

  • ErrCodeItemSizeLimitExceededException "ItemSizeLimitExceededException" The inventory item size has exceeded the size limit.

  • ErrCodeItemContentMismatchException "ItemContentMismatchException" The inventory item has invalid content.

  • ErrCodeCustomSchemaCountLimitExceededException "CustomSchemaCountLimitExceededException" You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

  • ErrCodeUnsupportedInventorySchemaVersionException "UnsupportedInventorySchemaVersionException" Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.

  • ErrCodeUnsupportedInventoryItemContextException "UnsupportedInventoryItemContextException" The Context attribute that you specified for the InventoryItem is not allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.

  • ErrCodeInvalidInventoryItemContextException "InvalidInventoryItemContextException" You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.

  • ErrCodeSubTypeCountLimitExceededException "SubTypeCountLimitExceededException" The sub-type count exceeded the limit for the inventory type.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutInventory

func (*SSM) PutInventoryRequest added in v1.5.13

func (c *SSM) PutInventoryRequest(input *PutInventoryInput) (req *request.Request, output *PutInventoryOutput)

PutInventoryRequest generates a "aws/request.Request" representing the client's request for the PutInventory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutInventory for more information on using the PutInventory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutInventoryRequest method.
req, resp := client.PutInventoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutInventory

func (*SSM) PutInventoryWithContext added in v1.8.0

func (c *SSM) PutInventoryWithContext(ctx aws.Context, input *PutInventoryInput, opts ...request.Option) (*PutInventoryOutput, error)

PutInventoryWithContext is the same as PutInventory with the addition of the ability to pass a context and additional request options.

See PutInventory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) PutParameter added in v1.5.13

func (c *SSM) PutParameter(input *PutParameterInput) (*PutParameterOutput, error)

PutParameter API operation for Amazon Simple Systems Manager (SSM).

Add a parameter to the system.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation PutParameter for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidKeyId "InvalidKeyId" The query key ID is not valid.

  • ErrCodeParameterLimitExceeded "ParameterLimitExceeded" You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

  • ErrCodeParameterAlreadyExists "ParameterAlreadyExists" The parameter already exists. You can't create duplicate parameters.

  • ErrCodeHierarchyLevelLimitExceededException "HierarchyLevelLimitExceededException" A hierarchy can have a maximum of 15 levels. For more information, see Requirements and Constraints for Parameter Names (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html) in the AWS Systems Manager User Guide.

  • ErrCodeHierarchyTypeMismatchException "HierarchyTypeMismatchException" Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.

  • ErrCodeInvalidAllowedPatternException "InvalidAllowedPatternException" The request does not meet the regular expression requirement.

  • ErrCodeParameterMaxVersionLimitExceeded "ParameterMaxVersionLimitExceeded" The parameter exceeded the maximum number of allowed versions.

  • ErrCodeParameterPatternMismatchException "ParameterPatternMismatchException" The parameter name is not valid.

  • ErrCodeUnsupportedParameterType "UnsupportedParameterType" The parameter type is not supported.

  • ErrCodePoliciesLimitExceededException "PoliciesLimitExceededException" You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.

  • ErrCodeInvalidPolicyTypeException "InvalidPolicyTypeException" The policy type is not supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

  • ErrCodeInvalidPolicyAttributeException "InvalidPolicyAttributeException" A policy attribute or its value is invalid.

  • ErrCodeIncompatiblePolicyException "IncompatiblePolicyException" There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutParameter

func (*SSM) PutParameterRequest added in v1.5.13

func (c *SSM) PutParameterRequest(input *PutParameterInput) (req *request.Request, output *PutParameterOutput)

PutParameterRequest generates a "aws/request.Request" representing the client's request for the PutParameter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutParameter for more information on using the PutParameter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutParameterRequest method.
req, resp := client.PutParameterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/PutParameter

func (*SSM) PutParameterWithContext added in v1.8.0

func (c *SSM) PutParameterWithContext(ctx aws.Context, input *PutParameterInput, opts ...request.Option) (*PutParameterOutput, error)

PutParameterWithContext is the same as PutParameter with the addition of the ability to pass a context and additional request options.

See PutParameter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) RegisterDefaultPatchBaseline added in v1.6.4

func (c *SSM) RegisterDefaultPatchBaseline(input *RegisterDefaultPatchBaselineInput) (*RegisterDefaultPatchBaselineOutput, error)

RegisterDefaultPatchBaseline API operation for Amazon Simple Systems Manager (SSM).

Defines the default patch baseline for the relevant operating system.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation RegisterDefaultPatchBaseline for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterDefaultPatchBaseline

func (*SSM) RegisterDefaultPatchBaselineRequest added in v1.6.4

func (c *SSM) RegisterDefaultPatchBaselineRequest(input *RegisterDefaultPatchBaselineInput) (req *request.Request, output *RegisterDefaultPatchBaselineOutput)

RegisterDefaultPatchBaselineRequest generates a "aws/request.Request" representing the client's request for the RegisterDefaultPatchBaseline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterDefaultPatchBaseline for more information on using the RegisterDefaultPatchBaseline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterDefaultPatchBaselineRequest method.
req, resp := client.RegisterDefaultPatchBaselineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterDefaultPatchBaseline

func (*SSM) RegisterDefaultPatchBaselineWithContext added in v1.8.0

func (c *SSM) RegisterDefaultPatchBaselineWithContext(ctx aws.Context, input *RegisterDefaultPatchBaselineInput, opts ...request.Option) (*RegisterDefaultPatchBaselineOutput, error)

RegisterDefaultPatchBaselineWithContext is the same as RegisterDefaultPatchBaseline with the addition of the ability to pass a context and additional request options.

See RegisterDefaultPatchBaseline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) RegisterPatchBaselineForPatchGroup added in v1.6.4

func (c *SSM) RegisterPatchBaselineForPatchGroup(input *RegisterPatchBaselineForPatchGroupInput) (*RegisterPatchBaselineForPatchGroupOutput, error)

RegisterPatchBaselineForPatchGroup API operation for Amazon Simple Systems Manager (SSM).

Registers a patch baseline for a patch group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation RegisterPatchBaselineForPatchGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAlreadyExistsException "AlreadyExistsException" Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeResourceLimitExceededException "ResourceLimitExceededException" Error returned when the caller has exceeded the default resource limits. For example, too many maintenance windows or patch baselines have been created.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup

func (*SSM) RegisterPatchBaselineForPatchGroupRequest added in v1.6.4

func (c *SSM) RegisterPatchBaselineForPatchGroupRequest(input *RegisterPatchBaselineForPatchGroupInput) (req *request.Request, output *RegisterPatchBaselineForPatchGroupOutput)

RegisterPatchBaselineForPatchGroupRequest generates a "aws/request.Request" representing the client's request for the RegisterPatchBaselineForPatchGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterPatchBaselineForPatchGroup for more information on using the RegisterPatchBaselineForPatchGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterPatchBaselineForPatchGroupRequest method.
req, resp := client.RegisterPatchBaselineForPatchGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterPatchBaselineForPatchGroup

func (*SSM) RegisterPatchBaselineForPatchGroupWithContext added in v1.8.0

func (c *SSM) RegisterPatchBaselineForPatchGroupWithContext(ctx aws.Context, input *RegisterPatchBaselineForPatchGroupInput, opts ...request.Option) (*RegisterPatchBaselineForPatchGroupOutput, error)

RegisterPatchBaselineForPatchGroupWithContext is the same as RegisterPatchBaselineForPatchGroup with the addition of the ability to pass a context and additional request options.

See RegisterPatchBaselineForPatchGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) RegisterTargetWithMaintenanceWindow added in v1.5.13

func (c *SSM) RegisterTargetWithMaintenanceWindow(input *RegisterTargetWithMaintenanceWindowInput) (*RegisterTargetWithMaintenanceWindowOutput, error)

RegisterTargetWithMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Registers a target with a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation RegisterTargetWithMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeIdempotentParameterMismatch "IdempotentParameterMismatch" Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeResourceLimitExceededException "ResourceLimitExceededException" Error returned when the caller has exceeded the default resource limits. For example, too many maintenance windows or patch baselines have been created.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow

func (*SSM) RegisterTargetWithMaintenanceWindowRequest added in v1.5.13

func (c *SSM) RegisterTargetWithMaintenanceWindowRequest(input *RegisterTargetWithMaintenanceWindowInput) (req *request.Request, output *RegisterTargetWithMaintenanceWindowOutput)

RegisterTargetWithMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the RegisterTargetWithMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterTargetWithMaintenanceWindow for more information on using the RegisterTargetWithMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterTargetWithMaintenanceWindowRequest method.
req, resp := client.RegisterTargetWithMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterTargetWithMaintenanceWindow

func (*SSM) RegisterTargetWithMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) RegisterTargetWithMaintenanceWindowWithContext(ctx aws.Context, input *RegisterTargetWithMaintenanceWindowInput, opts ...request.Option) (*RegisterTargetWithMaintenanceWindowOutput, error)

RegisterTargetWithMaintenanceWindowWithContext is the same as RegisterTargetWithMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See RegisterTargetWithMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) RegisterTaskWithMaintenanceWindow added in v1.5.13

func (c *SSM) RegisterTaskWithMaintenanceWindow(input *RegisterTaskWithMaintenanceWindowInput) (*RegisterTaskWithMaintenanceWindowOutput, error)

RegisterTaskWithMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Adds a new task to a maintenance window.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation RegisterTaskWithMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeIdempotentParameterMismatch "IdempotentParameterMismatch" Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeResourceLimitExceededException "ResourceLimitExceededException" Error returned when the caller has exceeded the default resource limits. For example, too many maintenance windows or patch baselines have been created.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeFeatureNotAvailableException "FeatureNotAvailableException" You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service is not available.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow

func (*SSM) RegisterTaskWithMaintenanceWindowRequest added in v1.5.13

func (c *SSM) RegisterTaskWithMaintenanceWindowRequest(input *RegisterTaskWithMaintenanceWindowInput) (req *request.Request, output *RegisterTaskWithMaintenanceWindowOutput)

RegisterTaskWithMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the RegisterTaskWithMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterTaskWithMaintenanceWindow for more information on using the RegisterTaskWithMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterTaskWithMaintenanceWindowRequest method.
req, resp := client.RegisterTaskWithMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RegisterTaskWithMaintenanceWindow

func (*SSM) RegisterTaskWithMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) RegisterTaskWithMaintenanceWindowWithContext(ctx aws.Context, input *RegisterTaskWithMaintenanceWindowInput, opts ...request.Option) (*RegisterTaskWithMaintenanceWindowOutput, error)

RegisterTaskWithMaintenanceWindowWithContext is the same as RegisterTaskWithMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See RegisterTaskWithMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) RemoveTagsFromResource added in v1.2.2

func (c *SSM) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResource API operation for Amazon Simple Systems Manager (SSM).

Removes tag keys from the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidResourceType "InvalidResourceType" The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

  • ErrCodeInvalidResourceId "InvalidResourceId" The resource ID is not valid. Verify that you entered the correct ID and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RemoveTagsFromResource

func (*SSM) RemoveTagsFromResourceRequest added in v1.2.2

func (c *SSM) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)

RemoveTagsFromResourceRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTagsFromResource for more information on using the RemoveTagsFromResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveTagsFromResourceRequest method.
req, resp := client.RemoveTagsFromResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/RemoveTagsFromResource

func (*SSM) RemoveTagsFromResourceWithContext added in v1.8.0

func (c *SSM) RemoveTagsFromResourceWithContext(ctx aws.Context, input *RemoveTagsFromResourceInput, opts ...request.Option) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResourceWithContext is the same as RemoveTagsFromResource with the addition of the ability to pass a context and additional request options.

See RemoveTagsFromResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ResetServiceSetting added in v1.99.0

func (c *SSM) ResetServiceSetting(input *ResetServiceSettingInput) (*ResetServiceSettingOutput, error)

ResetServiceSetting API operation for Amazon Simple Systems Manager (SSM).

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting.

Reset the service setting for the account to the default value as provisioned by the AWS service team.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ResetServiceSetting for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeServiceSettingNotFound "ServiceSettingNotFound" The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResetServiceSetting

func (*SSM) ResetServiceSettingRequest added in v1.99.0

func (c *SSM) ResetServiceSettingRequest(input *ResetServiceSettingInput) (req *request.Request, output *ResetServiceSettingOutput)

ResetServiceSettingRequest generates a "aws/request.Request" representing the client's request for the ResetServiceSetting operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResetServiceSetting for more information on using the ResetServiceSetting API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResetServiceSettingRequest method.
req, resp := client.ResetServiceSettingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResetServiceSetting

func (*SSM) ResetServiceSettingWithContext added in v1.99.0

func (c *SSM) ResetServiceSettingWithContext(ctx aws.Context, input *ResetServiceSettingInput, opts ...request.Option) (*ResetServiceSettingOutput, error)

ResetServiceSettingWithContext is the same as ResetServiceSetting with the addition of the ability to pass a context and additional request options.

See ResetServiceSetting for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) ResumeSession added in v1.99.0

func (c *SSM) ResumeSession(input *ResumeSessionInput) (*ResumeSessionOutput, error)

ResumeSession API operation for Amazon Simple Systems Manager (SSM).

Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation ResumeSession for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResumeSession

func (*SSM) ResumeSessionRequest added in v1.99.0

func (c *SSM) ResumeSessionRequest(input *ResumeSessionInput) (req *request.Request, output *ResumeSessionOutput)

ResumeSessionRequest generates a "aws/request.Request" representing the client's request for the ResumeSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ResumeSession for more information on using the ResumeSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ResumeSessionRequest method.
req, resp := client.ResumeSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/ResumeSession

func (*SSM) ResumeSessionWithContext added in v1.99.0

func (c *SSM) ResumeSessionWithContext(ctx aws.Context, input *ResumeSessionInput, opts ...request.Option) (*ResumeSessionOutput, error)

ResumeSessionWithContext is the same as ResumeSession with the addition of the ability to pass a context and additional request options.

See ResumeSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) SendAutomationSignal added in v1.10.19

func (c *SSM) SendAutomationSignal(input *SendAutomationSignalInput) (*SendAutomationSignalOutput, error)

SendAutomationSignal API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation SendAutomationSignal for usage and error information.

Returned Error Codes:

  • ErrCodeAutomationExecutionNotFoundException "AutomationExecutionNotFoundException" There is no automation execution information for the requested automation execution ID.

  • ErrCodeAutomationStepNotFoundException "AutomationStepNotFoundException" The specified step name and execution ID don't exist. Verify the information and try again.

  • ErrCodeInvalidAutomationSignalException "InvalidAutomationSignalException" The signal is not valid for the current Automation execution.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendAutomationSignal

func (*SSM) SendAutomationSignalRequest added in v1.10.19

func (c *SSM) SendAutomationSignalRequest(input *SendAutomationSignalInput) (req *request.Request, output *SendAutomationSignalOutput)

SendAutomationSignalRequest generates a "aws/request.Request" representing the client's request for the SendAutomationSignal operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendAutomationSignal for more information on using the SendAutomationSignal API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SendAutomationSignalRequest method.
req, resp := client.SendAutomationSignalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendAutomationSignal

func (*SSM) SendAutomationSignalWithContext added in v1.10.19

func (c *SSM) SendAutomationSignalWithContext(ctx aws.Context, input *SendAutomationSignalInput, opts ...request.Option) (*SendAutomationSignalOutput, error)

SendAutomationSignalWithContext is the same as SendAutomationSignal with the addition of the ability to pass a context and additional request options.

See SendAutomationSignal for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) SendCommand added in v0.9.17

func (c *SSM) SendCommand(input *SendCommandInput) (*SendCommandOutput, error)

SendCommand API operation for Amazon Simple Systems Manager (SSM).

Runs commands on one or more managed instances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation SendCommand for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateInstanceId "DuplicateInstanceId" You cannot specify an instance ID in more than one association.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

  • ErrCodeInvalidOutputFolder "InvalidOutputFolder" The S3 bucket does not exist.

  • ErrCodeInvalidParameters "InvalidParameters" You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

  • ErrCodeUnsupportedPlatformType "UnsupportedPlatformType" The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

  • ErrCodeMaxDocumentSizeExceeded "MaxDocumentSizeExceeded" The size limit of a document is 64 KB.

  • ErrCodeInvalidRole "InvalidRole" The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command (http://docs.aws.amazon.com/systems-manager/latest/userguide/rc-sns-notifications.html) in the AWS Systems Manager User Guide.

  • ErrCodeInvalidNotificationConfig "InvalidNotificationConfig" One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendCommand

func (*SSM) SendCommandRequest added in v0.9.17

func (c *SSM) SendCommandRequest(input *SendCommandInput) (req *request.Request, output *SendCommandOutput)

SendCommandRequest generates a "aws/request.Request" representing the client's request for the SendCommand operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SendCommand for more information on using the SendCommand API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SendCommandRequest method.
req, resp := client.SendCommandRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/SendCommand

func (*SSM) SendCommandWithContext added in v1.8.0

func (c *SSM) SendCommandWithContext(ctx aws.Context, input *SendCommandInput, opts ...request.Option) (*SendCommandOutput, error)

SendCommandWithContext is the same as SendCommand with the addition of the ability to pass a context and additional request options.

See SendCommand for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) StartAssociationsOnce added in v1.14.18

func (c *SSM) StartAssociationsOnce(input *StartAssociationsOnceInput) (*StartAssociationsOnceOutput, error)

StartAssociationsOnce API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation StartAssociationsOnce for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidAssociation "InvalidAssociation" The association is not valid or does not exist.

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartAssociationsOnce

func (*SSM) StartAssociationsOnceRequest added in v1.14.18

func (c *SSM) StartAssociationsOnceRequest(input *StartAssociationsOnceInput) (req *request.Request, output *StartAssociationsOnceOutput)

StartAssociationsOnceRequest generates a "aws/request.Request" representing the client's request for the StartAssociationsOnce operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartAssociationsOnce for more information on using the StartAssociationsOnce API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartAssociationsOnceRequest method.
req, resp := client.StartAssociationsOnceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartAssociationsOnce

func (*SSM) StartAssociationsOnceWithContext added in v1.14.18

func (c *SSM) StartAssociationsOnceWithContext(ctx aws.Context, input *StartAssociationsOnceInput, opts ...request.Option) (*StartAssociationsOnceOutput, error)

StartAssociationsOnceWithContext is the same as StartAssociationsOnce with the addition of the ability to pass a context and additional request options.

See StartAssociationsOnce for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) StartAutomationExecution added in v1.5.13

func (c *SSM) StartAutomationExecution(input *StartAutomationExecutionInput) (*StartAutomationExecutionOutput, error)

StartAutomationExecution API operation for Amazon Simple Systems Manager (SSM).

Initiates execution of an Automation document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation StartAutomationExecution for usage and error information.

Returned Error Codes:

  • ErrCodeAutomationDefinitionNotFoundException "AutomationDefinitionNotFoundException" An Automation document with the specified name could not be found.

  • ErrCodeInvalidAutomationExecutionParametersException "InvalidAutomationExecutionParametersException" The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.

  • ErrCodeAutomationExecutionLimitExceededException "AutomationExecutionLimitExceededException" The number of simultaneously running Automation executions exceeded the allowable limit.

  • ErrCodeAutomationDefinitionVersionNotFoundException "AutomationDefinitionVersionNotFoundException" An Automation document with the specified name and version could not be found.

  • ErrCodeIdempotentParameterMismatch "IdempotentParameterMismatch" Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

  • ErrCodeInvalidTarget "InvalidTarget" The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartAutomationExecution

func (*SSM) StartAutomationExecutionRequest added in v1.5.13

func (c *SSM) StartAutomationExecutionRequest(input *StartAutomationExecutionInput) (req *request.Request, output *StartAutomationExecutionOutput)

StartAutomationExecutionRequest generates a "aws/request.Request" representing the client's request for the StartAutomationExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartAutomationExecution for more information on using the StartAutomationExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartAutomationExecutionRequest method.
req, resp := client.StartAutomationExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartAutomationExecution

func (*SSM) StartAutomationExecutionWithContext added in v1.8.0

func (c *SSM) StartAutomationExecutionWithContext(ctx aws.Context, input *StartAutomationExecutionInput, opts ...request.Option) (*StartAutomationExecutionOutput, error)

StartAutomationExecutionWithContext is the same as StartAutomationExecution with the addition of the ability to pass a context and additional request options.

See StartAutomationExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) StartSession added in v1.99.0

func (c *SSM) StartSession(input *StartSessionInput) (*StartSessionOutput, error)

StartSession API operation for Amazon Simple Systems Manager (SSM).

Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI (http://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) in the AWS Systems Manager User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation StartSession for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeTargetNotConnected "TargetNotConnected" The specified target instance for the session is not fully configured for use with Session Manager. For more information, see Getting Started with Session Manager (http://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html) in the AWS Systems Manager User Guide.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartSession

func (*SSM) StartSessionRequest added in v1.99.0

func (c *SSM) StartSessionRequest(input *StartSessionInput) (req *request.Request, output *StartSessionOutput)

StartSessionRequest generates a "aws/request.Request" representing the client's request for the StartSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSession for more information on using the StartSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartSessionRequest method.
req, resp := client.StartSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StartSession

func (*SSM) StartSessionWithContext added in v1.99.0

func (c *SSM) StartSessionWithContext(ctx aws.Context, input *StartSessionInput, opts ...request.Option) (*StartSessionOutput, error)

StartSessionWithContext is the same as StartSession with the addition of the ability to pass a context and additional request options.

See StartSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) StopAutomationExecution added in v1.5.13

func (c *SSM) StopAutomationExecution(input *StopAutomationExecutionInput) (*StopAutomationExecutionOutput, error)

StopAutomationExecution API operation for Amazon Simple Systems Manager (SSM).

Stop an Automation that is currently running.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation StopAutomationExecution for usage and error information.

Returned Error Codes:

  • ErrCodeAutomationExecutionNotFoundException "AutomationExecutionNotFoundException" There is no automation execution information for the requested automation execution ID.

  • ErrCodeInvalidAutomationStatusUpdateException "InvalidAutomationStatusUpdateException" The specified update status operation is not valid.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StopAutomationExecution

func (*SSM) StopAutomationExecutionRequest added in v1.5.13

func (c *SSM) StopAutomationExecutionRequest(input *StopAutomationExecutionInput) (req *request.Request, output *StopAutomationExecutionOutput)

StopAutomationExecutionRequest generates a "aws/request.Request" representing the client's request for the StopAutomationExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopAutomationExecution for more information on using the StopAutomationExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopAutomationExecutionRequest method.
req, resp := client.StopAutomationExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/StopAutomationExecution

func (*SSM) StopAutomationExecutionWithContext added in v1.8.0

func (c *SSM) StopAutomationExecutionWithContext(ctx aws.Context, input *StopAutomationExecutionInput, opts ...request.Option) (*StopAutomationExecutionOutput, error)

StopAutomationExecutionWithContext is the same as StopAutomationExecution with the addition of the ability to pass a context and additional request options.

See StopAutomationExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) TerminateSession added in v1.99.0

func (c *SSM) TerminateSession(input *TerminateSessionInput) (*TerminateSessionOutput, error)

TerminateSession API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation TerminateSession for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/TerminateSession

func (*SSM) TerminateSessionRequest added in v1.99.0

func (c *SSM) TerminateSessionRequest(input *TerminateSessionInput) (req *request.Request, output *TerminateSessionOutput)

TerminateSessionRequest generates a "aws/request.Request" representing the client's request for the TerminateSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TerminateSession for more information on using the TerminateSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TerminateSessionRequest method.
req, resp := client.TerminateSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/TerminateSession

func (*SSM) TerminateSessionWithContext added in v1.99.0

func (c *SSM) TerminateSessionWithContext(ctx aws.Context, input *TerminateSessionInput, opts ...request.Option) (*TerminateSessionOutput, error)

TerminateSessionWithContext is the same as TerminateSession with the addition of the ability to pass a context and additional request options.

See TerminateSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateAssociation added in v1.5.13

func (c *SSM) UpdateAssociation(input *UpdateAssociationInput) (*UpdateAssociationOutput, error)

UpdateAssociation API operation for Amazon Simple Systems Manager (SSM).

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

When you update an association, the association immediately runs against the specified targets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateAssociation for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidSchedule "InvalidSchedule" The schedule is invalid. Verify your cron or rate expression and try again.

  • ErrCodeInvalidParameters "InvalidParameters" You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

  • ErrCodeInvalidOutputLocation "InvalidOutputLocation" The output location is not valid or does not exist.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

  • ErrCodeInvalidUpdate "InvalidUpdate" The update is not valid.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidTarget "InvalidTarget" The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

  • ErrCodeInvalidAssociationVersion "InvalidAssociationVersion" The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.

  • ErrCodeAssociationVersionLimitExceeded "AssociationVersionLimitExceeded" You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociation

func (*SSM) UpdateAssociationRequest added in v1.5.13

func (c *SSM) UpdateAssociationRequest(input *UpdateAssociationInput) (req *request.Request, output *UpdateAssociationOutput)

UpdateAssociationRequest generates a "aws/request.Request" representing the client's request for the UpdateAssociation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAssociation for more information on using the UpdateAssociation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAssociationRequest method.
req, resp := client.UpdateAssociationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociation

func (*SSM) UpdateAssociationStatus

func (c *SSM) UpdateAssociationStatus(input *UpdateAssociationStatusInput) (*UpdateAssociationStatusOutput, error)

UpdateAssociationStatus API operation for Amazon Simple Systems Manager (SSM).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateAssociationStatus for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeAssociationDoesNotExist "AssociationDoesNotExist" The specified association does not exist.

  • ErrCodeStatusUnchanged "StatusUnchanged" The updated status is the same as the current status.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationStatus

func (*SSM) UpdateAssociationStatusRequest

func (c *SSM) UpdateAssociationStatusRequest(input *UpdateAssociationStatusInput) (req *request.Request, output *UpdateAssociationStatusOutput)

UpdateAssociationStatusRequest generates a "aws/request.Request" representing the client's request for the UpdateAssociationStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAssociationStatus for more information on using the UpdateAssociationStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAssociationStatusRequest method.
req, resp := client.UpdateAssociationStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateAssociationStatus

func (*SSM) UpdateAssociationStatusWithContext added in v1.8.0

func (c *SSM) UpdateAssociationStatusWithContext(ctx aws.Context, input *UpdateAssociationStatusInput, opts ...request.Option) (*UpdateAssociationStatusOutput, error)

UpdateAssociationStatusWithContext is the same as UpdateAssociationStatus with the addition of the ability to pass a context and additional request options.

See UpdateAssociationStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateAssociationWithContext added in v1.8.0

func (c *SSM) UpdateAssociationWithContext(ctx aws.Context, input *UpdateAssociationInput, opts ...request.Option) (*UpdateAssociationOutput, error)

UpdateAssociationWithContext is the same as UpdateAssociation with the addition of the ability to pass a context and additional request options.

See UpdateAssociation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateDocument added in v1.5.13

func (c *SSM) UpdateDocument(input *UpdateDocumentInput) (*UpdateDocumentOutput, error)

UpdateDocument API operation for Amazon Simple Systems Manager (SSM).

Updates one or more values for an SSM document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateDocument for usage and error information.

Returned Error Codes:

  • ErrCodeMaxDocumentSizeExceeded "MaxDocumentSizeExceeded" The size limit of a document is 64 KB.

  • ErrCodeDocumentVersionLimitExceeded "DocumentVersionLimitExceeded" The document has too many versions. Delete one or more document versions and try again.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeDuplicateDocumentContent "DuplicateDocumentContent" The content of the association document matches another document. Change the content of the document and try again.

  • ErrCodeDuplicateDocumentVersionName "DuplicateDocumentVersionName" The version name has already been used in this document. Specify a different version name, and then try again.

  • ErrCodeInvalidDocumentContent "InvalidDocumentContent" The content for the document is not valid.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

  • ErrCodeInvalidDocumentSchemaVersion "InvalidDocumentSchemaVersion" The version of the document schema is not supported.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentOperation "InvalidDocumentOperation" You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocument

func (*SSM) UpdateDocumentDefaultVersion added in v1.5.13

func (c *SSM) UpdateDocumentDefaultVersion(input *UpdateDocumentDefaultVersionInput) (*UpdateDocumentDefaultVersionOutput, error)

UpdateDocumentDefaultVersion API operation for Amazon Simple Systems Manager (SSM).

Set the default version of a document.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateDocumentDefaultVersion for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeInvalidDocument "InvalidDocument" The specified document does not exist.

  • ErrCodeInvalidDocumentVersion "InvalidDocumentVersion" The document version is not valid or does not exist.

  • ErrCodeInvalidDocumentSchemaVersion "InvalidDocumentSchemaVersion" The version of the document schema is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentDefaultVersion

func (*SSM) UpdateDocumentDefaultVersionRequest added in v1.5.13

func (c *SSM) UpdateDocumentDefaultVersionRequest(input *UpdateDocumentDefaultVersionInput) (req *request.Request, output *UpdateDocumentDefaultVersionOutput)

UpdateDocumentDefaultVersionRequest generates a "aws/request.Request" representing the client's request for the UpdateDocumentDefaultVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDocumentDefaultVersion for more information on using the UpdateDocumentDefaultVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateDocumentDefaultVersionRequest method.
req, resp := client.UpdateDocumentDefaultVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocumentDefaultVersion

func (*SSM) UpdateDocumentDefaultVersionWithContext added in v1.8.0

func (c *SSM) UpdateDocumentDefaultVersionWithContext(ctx aws.Context, input *UpdateDocumentDefaultVersionInput, opts ...request.Option) (*UpdateDocumentDefaultVersionOutput, error)

UpdateDocumentDefaultVersionWithContext is the same as UpdateDocumentDefaultVersion with the addition of the ability to pass a context and additional request options.

See UpdateDocumentDefaultVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateDocumentRequest added in v1.5.13

func (c *SSM) UpdateDocumentRequest(input *UpdateDocumentInput) (req *request.Request, output *UpdateDocumentOutput)

UpdateDocumentRequest generates a "aws/request.Request" representing the client's request for the UpdateDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDocument for more information on using the UpdateDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateDocumentRequest method.
req, resp := client.UpdateDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateDocument

func (*SSM) UpdateDocumentWithContext added in v1.8.0

func (c *SSM) UpdateDocumentWithContext(ctx aws.Context, input *UpdateDocumentInput, opts ...request.Option) (*UpdateDocumentOutput, error)

UpdateDocumentWithContext is the same as UpdateDocument with the addition of the ability to pass a context and additional request options.

See UpdateDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateMaintenanceWindow added in v1.5.13

func (c *SSM) UpdateMaintenanceWindow(input *UpdateMaintenanceWindowInput) (*UpdateMaintenanceWindowOutput, error)

UpdateMaintenanceWindow API operation for Amazon Simple Systems Manager (SSM).

Updates an existing maintenance window. Only specified parameters are modified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateMaintenanceWindow for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindow

func (*SSM) UpdateMaintenanceWindowRequest added in v1.5.13

func (c *SSM) UpdateMaintenanceWindowRequest(input *UpdateMaintenanceWindowInput) (req *request.Request, output *UpdateMaintenanceWindowOutput)

UpdateMaintenanceWindowRequest generates a "aws/request.Request" representing the client's request for the UpdateMaintenanceWindow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMaintenanceWindow for more information on using the UpdateMaintenanceWindow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateMaintenanceWindowRequest method.
req, resp := client.UpdateMaintenanceWindowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindow

func (*SSM) UpdateMaintenanceWindowTarget added in v1.10.25

func (c *SSM) UpdateMaintenanceWindowTarget(input *UpdateMaintenanceWindowTargetInput) (*UpdateMaintenanceWindowTargetOutput, error)

UpdateMaintenanceWindowTarget API operation for Amazon Simple Systems Manager (SSM).

Modifies the target of an existing maintenance window. You can change the following:

  • Name

  • Description

  • Owner

  • IDs for an ID target

  • Tags for a Tag target

  • From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

If a parameter is null, then the corresponding field is not modified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateMaintenanceWindowTarget for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowTarget

func (*SSM) UpdateMaintenanceWindowTargetRequest added in v1.10.25

func (c *SSM) UpdateMaintenanceWindowTargetRequest(input *UpdateMaintenanceWindowTargetInput) (req *request.Request, output *UpdateMaintenanceWindowTargetOutput)

UpdateMaintenanceWindowTargetRequest generates a "aws/request.Request" representing the client's request for the UpdateMaintenanceWindowTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMaintenanceWindowTarget for more information on using the UpdateMaintenanceWindowTarget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateMaintenanceWindowTargetRequest method.
req, resp := client.UpdateMaintenanceWindowTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowTarget

func (*SSM) UpdateMaintenanceWindowTargetWithContext added in v1.10.25

func (c *SSM) UpdateMaintenanceWindowTargetWithContext(ctx aws.Context, input *UpdateMaintenanceWindowTargetInput, opts ...request.Option) (*UpdateMaintenanceWindowTargetOutput, error)

UpdateMaintenanceWindowTargetWithContext is the same as UpdateMaintenanceWindowTarget with the addition of the ability to pass a context and additional request options.

See UpdateMaintenanceWindowTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateMaintenanceWindowTask added in v1.10.25

func (c *SSM) UpdateMaintenanceWindowTask(input *UpdateMaintenanceWindowTaskInput) (*UpdateMaintenanceWindowTaskOutput, error)

UpdateMaintenanceWindowTask API operation for Amazon Simple Systems Manager (SSM).

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

  • TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

  • ServiceRoleArn

  • TaskInvocationParameters

  • Priority

  • MaxConcurrency

  • MaxErrors

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateMaintenanceWindowTask for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowTask

func (*SSM) UpdateMaintenanceWindowTaskRequest added in v1.10.25

func (c *SSM) UpdateMaintenanceWindowTaskRequest(input *UpdateMaintenanceWindowTaskInput) (req *request.Request, output *UpdateMaintenanceWindowTaskOutput)

UpdateMaintenanceWindowTaskRequest generates a "aws/request.Request" representing the client's request for the UpdateMaintenanceWindowTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMaintenanceWindowTask for more information on using the UpdateMaintenanceWindowTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateMaintenanceWindowTaskRequest method.
req, resp := client.UpdateMaintenanceWindowTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateMaintenanceWindowTask

func (*SSM) UpdateMaintenanceWindowTaskWithContext added in v1.10.25

func (c *SSM) UpdateMaintenanceWindowTaskWithContext(ctx aws.Context, input *UpdateMaintenanceWindowTaskInput, opts ...request.Option) (*UpdateMaintenanceWindowTaskOutput, error)

UpdateMaintenanceWindowTaskWithContext is the same as UpdateMaintenanceWindowTask with the addition of the ability to pass a context and additional request options.

See UpdateMaintenanceWindowTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateMaintenanceWindowWithContext added in v1.8.0

func (c *SSM) UpdateMaintenanceWindowWithContext(ctx aws.Context, input *UpdateMaintenanceWindowInput, opts ...request.Option) (*UpdateMaintenanceWindowOutput, error)

UpdateMaintenanceWindowWithContext is the same as UpdateMaintenanceWindow with the addition of the ability to pass a context and additional request options.

See UpdateMaintenanceWindow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateManagedInstanceRole added in v1.2.2

func (c *SSM) UpdateManagedInstanceRole(input *UpdateManagedInstanceRoleInput) (*UpdateManagedInstanceRoleOutput, error)

UpdateManagedInstanceRole API operation for Amazon Simple Systems Manager (SSM).

Assigns or changes an Amazon Identity and Access Management (IAM) role for the managed instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateManagedInstanceRole for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInstanceId "InvalidInstanceId" The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateManagedInstanceRole

func (*SSM) UpdateManagedInstanceRoleRequest added in v1.2.2

func (c *SSM) UpdateManagedInstanceRoleRequest(input *UpdateManagedInstanceRoleInput) (req *request.Request, output *UpdateManagedInstanceRoleOutput)

UpdateManagedInstanceRoleRequest generates a "aws/request.Request" representing the client's request for the UpdateManagedInstanceRole operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateManagedInstanceRole for more information on using the UpdateManagedInstanceRole API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateManagedInstanceRoleRequest method.
req, resp := client.UpdateManagedInstanceRoleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateManagedInstanceRole

func (*SSM) UpdateManagedInstanceRoleWithContext added in v1.8.0

func (c *SSM) UpdateManagedInstanceRoleWithContext(ctx aws.Context, input *UpdateManagedInstanceRoleInput, opts ...request.Option) (*UpdateManagedInstanceRoleOutput, error)

UpdateManagedInstanceRoleWithContext is the same as UpdateManagedInstanceRole with the addition of the ability to pass a context and additional request options.

See UpdateManagedInstanceRole for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateOpsItem added in v1.99.0

func (c *SSM) UpdateOpsItem(input *UpdateOpsItemInput) (*UpdateOpsItemOutput, error)

UpdateOpsItem API operation for Amazon Simple Systems Manager (SSM).

Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting Started with OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html) in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html) in the AWS Systems Manager User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateOpsItem for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeOpsItemNotFoundException "OpsItemNotFoundException" The specified OpsItem ID doesn't exist. Verify the ID and try again.

  • ErrCodeOpsItemAlreadyExistsException "OpsItemAlreadyExistsException" The OpsItem already exists.

  • ErrCodeOpsItemLimitExceededException "OpsItemLimitExceededException" The request caused OpsItems to exceed one or more limits. For information about OpsItem limits, see What are the resource limits for OpsCenter? (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits).

  • ErrCodeOpsItemInvalidParameterException "OpsItemInvalidParameterException" A specified parameter argument isn't valid. Verify the available arguments and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItem

func (*SSM) UpdateOpsItemRequest added in v1.99.0

func (c *SSM) UpdateOpsItemRequest(input *UpdateOpsItemInput) (req *request.Request, output *UpdateOpsItemOutput)

UpdateOpsItemRequest generates a "aws/request.Request" representing the client's request for the UpdateOpsItem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateOpsItem for more information on using the UpdateOpsItem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateOpsItemRequest method.
req, resp := client.UpdateOpsItemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateOpsItem

func (*SSM) UpdateOpsItemWithContext added in v1.99.0

func (c *SSM) UpdateOpsItemWithContext(ctx aws.Context, input *UpdateOpsItemInput, opts ...request.Option) (*UpdateOpsItemOutput, error)

UpdateOpsItemWithContext is the same as UpdateOpsItem with the addition of the ability to pass a context and additional request options.

See UpdateOpsItem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdatePatchBaseline added in v1.6.4

func (c *SSM) UpdatePatchBaseline(input *UpdatePatchBaselineInput) (*UpdatePatchBaselineOutput, error)

UpdatePatchBaseline API operation for Amazon Simple Systems Manager (SSM).

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdatePatchBaseline for usage and error information.

Returned Error Codes:

  • ErrCodeDoesNotExistException "DoesNotExistException" Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm).

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdatePatchBaseline

func (*SSM) UpdatePatchBaselineRequest added in v1.6.4

func (c *SSM) UpdatePatchBaselineRequest(input *UpdatePatchBaselineInput) (req *request.Request, output *UpdatePatchBaselineOutput)

UpdatePatchBaselineRequest generates a "aws/request.Request" representing the client's request for the UpdatePatchBaseline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePatchBaseline for more information on using the UpdatePatchBaseline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdatePatchBaselineRequest method.
req, resp := client.UpdatePatchBaselineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdatePatchBaseline

func (*SSM) UpdatePatchBaselineWithContext added in v1.8.0

func (c *SSM) UpdatePatchBaselineWithContext(ctx aws.Context, input *UpdatePatchBaselineInput, opts ...request.Option) (*UpdatePatchBaselineOutput, error)

UpdatePatchBaselineWithContext is the same as UpdatePatchBaseline with the addition of the ability to pass a context and additional request options.

See UpdatePatchBaseline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SSM) UpdateServiceSetting added in v1.99.0

func (c *SSM) UpdateServiceSetting(input *UpdateServiceSettingInput) (*UpdateServiceSettingOutput, error)

UpdateServiceSetting API operation for Amazon Simple Systems Manager (SSM).

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

Update the service setting for the account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Systems Manager (SSM)'s API operation UpdateServiceSetting for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.

  • ErrCodeServiceSettingNotFound "ServiceSettingNotFound" The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.

  • ErrCodeTooManyUpdates "TooManyUpdates" There are concurrent updates for a resource that supports one update at a time.

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateServiceSetting

func (*SSM) UpdateServiceSettingRequest added in v1.99.0

func (c *SSM) UpdateServiceSettingRequest(input *UpdateServiceSettingInput) (req *request.Request, output *UpdateServiceSettingOutput)

UpdateServiceSettingRequest generates a "aws/request.Request" representing the client's request for the UpdateServiceSetting operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateServiceSetting for more information on using the UpdateServiceSetting API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateServiceSettingRequest method.
req, resp := client.UpdateServiceSettingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/UpdateServiceSetting

func (*SSM) UpdateServiceSettingWithContext added in v1.99.0

func (c *SSM) UpdateServiceSettingWithContext(ctx aws.Context, input *UpdateServiceSettingInput, opts ...request.Option) (*UpdateServiceSettingOutput, error)

UpdateServiceSettingWithContext is the same as UpdateServiceSetting with the addition of the ability to pass a context and additional request options.

See UpdateServiceSetting for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ScheduledWindowExecution added in v1.99.0

type ScheduledWindowExecution struct {

	// The time, in ISO-8601 Extended format, that the maintenance window is scheduled
	// to be run.
	ExecutionTime *string `type:"string"`

	// The name of the maintenance window to be run.
	Name *string `min:"3" type:"string"`

	// The ID of the maintenance window to be run.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

Information about a scheduled execution for a maintenance window.

func (ScheduledWindowExecution) GoString added in v1.99.0

func (s ScheduledWindowExecution) GoString() string

GoString returns the string representation

func (*ScheduledWindowExecution) SetExecutionTime added in v1.99.0

SetExecutionTime sets the ExecutionTime field's value.

func (*ScheduledWindowExecution) SetName added in v1.99.0

SetName sets the Name field's value.

func (*ScheduledWindowExecution) SetWindowId added in v1.99.0

SetWindowId sets the WindowId field's value.

func (ScheduledWindowExecution) String added in v1.99.0

func (s ScheduledWindowExecution) String() string

String returns the string representation

type SendAutomationSignalInput added in v1.10.19

type SendAutomationSignalInput struct {

	// The unique identifier for an existing Automation execution that you want
	// to send the signal to.
	//
	// AutomationExecutionId is a required field
	AutomationExecutionId *string `min:"36" type:"string" required:"true"`

	// 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 `min:"1" type:"map"`

	// The type of signal to send to an Automation execution.
	//
	// SignalType is a required field
	SignalType *string `type:"string" required:"true" enum:"SignalType"`
	// contains filtered or unexported fields
}

func (SendAutomationSignalInput) GoString added in v1.10.19

func (s SendAutomationSignalInput) GoString() string

GoString returns the string representation

func (*SendAutomationSignalInput) SetAutomationExecutionId added in v1.10.19

func (s *SendAutomationSignalInput) SetAutomationExecutionId(v string) *SendAutomationSignalInput

SetAutomationExecutionId sets the AutomationExecutionId field's value.

func (*SendAutomationSignalInput) SetPayload added in v1.10.19

SetPayload sets the Payload field's value.

func (*SendAutomationSignalInput) SetSignalType added in v1.10.19

SetSignalType sets the SignalType field's value.

func (SendAutomationSignalInput) String added in v1.10.19

func (s SendAutomationSignalInput) String() string

String returns the string representation

func (*SendAutomationSignalInput) Validate added in v1.10.19

func (s *SendAutomationSignalInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendAutomationSignalOutput added in v1.10.19

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

func (SendAutomationSignalOutput) GoString added in v1.10.19

func (s SendAutomationSignalOutput) GoString() string

GoString returns the string representation

func (SendAutomationSignalOutput) String added in v1.10.19

String returns the string representation

type SendCommandInput added in v0.9.17

type SendCommandInput struct {

	// Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
	CloudWatchOutputConfig *CloudWatchOutputConfig `type:"structure"`

	// User-specified information about the command, such as a brief description
	// of what the command should do.
	Comment *string `type:"string"`

	// The Sha256 or Sha1 hash created by the system when the document was created.
	//
	// Sha1 hashes have been deprecated.
	DocumentHash *string `type:"string"`

	// Sha256 or Sha1.
	//
	// Sha1 hashes have been deprecated.
	DocumentHashType *string `type:"string" enum:"DocumentHashType"`

	// Required. The name of the Systems Manager document to run. This can be a
	// public document or a custom document.
	//
	// DocumentName is a required field
	DocumentName *string `type:"string" required:"true"`

	// The SSM document version to use in the request. You can specify $DEFAULT,
	// $LATEST, or a specific version number. If you run commands by using the AWS
	// CLI, then you must escape the first two options by using a backslash. If
	// you specify a version number, then you don't need to use the backslash. For
	// example:
	//
	// --document-version "\$DEFAULT"
	//
	// --document-version "\$LATEST"
	//
	// --document-version "3"
	DocumentVersion *string `type:"string"`

	// The instance IDs where the command should run. You can specify a maximum
	// of 50 IDs. If you prefer not to list individual instance IDs, you can instead
	// send commands to a fleet of instances using the Targets parameter, which
	// accepts EC2 tags. For more information about how to use targets, see Sending
	// Commands to a Fleet (http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html)
	// in the AWS Systems Manager User Guide.
	InstanceIds []*string `type:"list"`

	// (Optional) The maximum number of instances that are allowed to run the command
	// at the same time. You can specify a number such as 10 or a percentage such
	// as 10%. The default value is 50. For more information about how to use MaxConcurrency,
	// see Using Concurrency Controls (http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity)
	// in the AWS Systems Manager User Guide.
	MaxConcurrency *string `min:"1" type:"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 (http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors)
	// in the AWS Systems Manager User Guide.
	MaxErrors *string `min:"1" type:"string"`

	// Configurations for sending notifications.
	NotificationConfig *NotificationConfig `type:"structure"`

	// The name of the S3 bucket where command execution responses should be stored.
	OutputS3BucketName *string `min:"3" type:"string"`

	// The directory structure within the S3 bucket where the responses should be
	// stored.
	OutputS3KeyPrefix *string `type:"string"`

	// (Deprecated) You can no longer specify this parameter. The system ignores
	// it. Instead, Systems Manager automatically determines the Amazon S3 bucket
	// region.
	OutputS3Region *string `min:"3" type:"string"`

	// The required and optional parameters specified in the document being run.
	Parameters map[string][]*string `type:"map"`

	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for Run Command commands.
	ServiceRoleArn *string `type:"string"`

	// (Optional) An array of search criteria that targets instances using a Key,Value
	// combination that you specify. Targets is required if you don't provide one
	// or more instance IDs in the call. For more information about how to use targets,
	// see Sending Commands to a Fleet (http://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html)
	// in the AWS Systems Manager User Guide.
	Targets []*Target `type:"list"`

	// If this time is reached and the command has not already started running,
	// it will not run.
	TimeoutSeconds *int64 `min:"30" type:"integer"`
	// contains filtered or unexported fields
}

func (SendCommandInput) GoString added in v0.9.17

func (s SendCommandInput) GoString() string

GoString returns the string representation

func (*SendCommandInput) SetCloudWatchOutputConfig added in v1.14.6

func (s *SendCommandInput) SetCloudWatchOutputConfig(v *CloudWatchOutputConfig) *SendCommandInput

SetCloudWatchOutputConfig sets the CloudWatchOutputConfig field's value.

func (*SendCommandInput) SetComment added in v1.5.0

func (s *SendCommandInput) SetComment(v string) *SendCommandInput

SetComment sets the Comment field's value.

func (*SendCommandInput) SetDocumentHash added in v1.5.0

func (s *SendCommandInput) SetDocumentHash(v string) *SendCommandInput

SetDocumentHash sets the DocumentHash field's value.

func (*SendCommandInput) SetDocumentHashType added in v1.5.0

func (s *SendCommandInput) SetDocumentHashType(v string) *SendCommandInput

SetDocumentHashType sets the DocumentHashType field's value.

func (*SendCommandInput) SetDocumentName added in v1.5.0

func (s *SendCommandInput) SetDocumentName(v string) *SendCommandInput

SetDocumentName sets the DocumentName field's value.

func (*SendCommandInput) SetDocumentVersion added in v1.13.40

func (s *SendCommandInput) SetDocumentVersion(v string) *SendCommandInput

SetDocumentVersion sets the DocumentVersion field's value.

func (*SendCommandInput) SetInstanceIds added in v1.5.0

func (s *SendCommandInput) SetInstanceIds(v []*string) *SendCommandInput

SetInstanceIds sets the InstanceIds field's value.

func (*SendCommandInput) SetMaxConcurrency added in v1.5.13

func (s *SendCommandInput) SetMaxConcurrency(v string) *SendCommandInput

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*SendCommandInput) SetMaxErrors added in v1.5.13

func (s *SendCommandInput) SetMaxErrors(v string) *SendCommandInput

SetMaxErrors sets the MaxErrors field's value.

func (*SendCommandInput) SetNotificationConfig added in v1.5.0

func (s *SendCommandInput) SetNotificationConfig(v *NotificationConfig) *SendCommandInput

SetNotificationConfig sets the NotificationConfig field's value.

func (*SendCommandInput) SetOutputS3BucketName added in v1.5.0

func (s *SendCommandInput) SetOutputS3BucketName(v string) *SendCommandInput

SetOutputS3BucketName sets the OutputS3BucketName field's value.

func (*SendCommandInput) SetOutputS3KeyPrefix added in v1.5.0

func (s *SendCommandInput) SetOutputS3KeyPrefix(v string) *SendCommandInput

SetOutputS3KeyPrefix sets the OutputS3KeyPrefix field's value.

func (*SendCommandInput) SetOutputS3Region added in v1.5.13

func (s *SendCommandInput) SetOutputS3Region(v string) *SendCommandInput

SetOutputS3Region sets the OutputS3Region field's value.

func (*SendCommandInput) SetParameters added in v1.5.0

func (s *SendCommandInput) SetParameters(v map[string][]*string) *SendCommandInput

SetParameters sets the Parameters field's value.

func (*SendCommandInput) SetServiceRoleArn added in v1.5.0

func (s *SendCommandInput) SetServiceRoleArn(v string) *SendCommandInput

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*SendCommandInput) SetTargets added in v1.5.13

func (s *SendCommandInput) SetTargets(v []*Target) *SendCommandInput

SetTargets sets the Targets field's value.

func (*SendCommandInput) SetTimeoutSeconds added in v1.5.0

func (s *SendCommandInput) SetTimeoutSeconds(v int64) *SendCommandInput

SetTimeoutSeconds sets the TimeoutSeconds field's value.

func (SendCommandInput) String added in v0.9.17

func (s SendCommandInput) String() string

String returns the string representation

func (*SendCommandInput) Validate added in v1.1.21

func (s *SendCommandInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendCommandOutput added in v0.9.17

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 *Command `type:"structure"`
	// contains filtered or unexported fields
}

func (SendCommandOutput) GoString added in v0.9.17

func (s SendCommandOutput) GoString() string

GoString returns the string representation

func (*SendCommandOutput) SetCommand added in v1.5.0

func (s *SendCommandOutput) SetCommand(v *Command) *SendCommandOutput

SetCommand sets the Command field's value.

func (SendCommandOutput) String added in v0.9.17

func (s SendCommandOutput) String() string

String returns the string representation

type ServiceSetting added in v1.99.0

type ServiceSetting struct {

	// The ARN of the service setting.
	ARN *string `type:"string"`

	// The last time the service setting was modified.
	LastModifiedDate *time.Time `type:"timestamp"`

	// The ARN of the last modified user. This field is populated only if the setting
	// value was overwritten.
	LastModifiedUser *string `type:"string"`

	// The ID of the service setting.
	SettingId *string `min:"1" type:"string"`

	// The value of the service setting.
	SettingValue *string `min:"1" type:"string"`

	// The status of the service setting. The value can be Default, Customized or
	// PendingUpdate.
	//
	//    * Default: The current setting uses a default value provisioned by the
	//    AWS service team.
	//
	//    * Customized: The current setting use a custom value specified by the
	//    customer.
	//
	//    * PendingUpdate: The current setting uses a default or custom value, but
	//    a setting change request is pending approval.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

The service setting data structure.

ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

func (ServiceSetting) GoString added in v1.99.0

func (s ServiceSetting) GoString() string

GoString returns the string representation

func (*ServiceSetting) SetARN added in v1.99.0

func (s *ServiceSetting) SetARN(v string) *ServiceSetting

SetARN sets the ARN field's value.

func (*ServiceSetting) SetLastModifiedDate added in v1.99.0

func (s *ServiceSetting) SetLastModifiedDate(v time.Time) *ServiceSetting

SetLastModifiedDate sets the LastModifiedDate field's value.

func (*ServiceSetting) SetLastModifiedUser added in v1.99.0

func (s *ServiceSetting) SetLastModifiedUser(v string) *ServiceSetting

SetLastModifiedUser sets the LastModifiedUser field's value.

func (*ServiceSetting) SetSettingId added in v1.99.0

func (s *ServiceSetting) SetSettingId(v string) *ServiceSetting

SetSettingId sets the SettingId field's value.

func (*ServiceSetting) SetSettingValue added in v1.99.0

func (s *ServiceSetting) SetSettingValue(v string) *ServiceSetting

SetSettingValue sets the SettingValue field's value.

func (*ServiceSetting) SetStatus added in v1.99.0

func (s *ServiceSetting) SetStatus(v string) *ServiceSetting

SetStatus sets the Status field's value.

func (ServiceSetting) String added in v1.99.0

func (s ServiceSetting) String() string

String returns the string representation

type Session added in v1.99.0

type Session struct {

	// Reserved for future use.
	Details *string `min:"1" type:"string"`

	// The name of the Session Manager SSM document used to define the parameters
	// and plugin settings for the session. For example, SSM-SessionManagerRunShell.
	DocumentName *string `type:"string"`

	// The date and time, in ISO-8601 Extended format, when the session was terminated.
	EndDate *time.Time `type:"timestamp"`

	// Reserved for future use.
	OutputUrl *SessionManagerOutputUrl `type:"structure"`

	// The ID of the AWS user account that started the session.
	Owner *string `min:"1" type:"string"`

	// The ID of the session.
	SessionId *string `min:"1" type:"string"`

	// The date and time, in ISO-8601 Extended format, when the session began.
	StartDate *time.Time `type:"timestamp"`

	// The status of the session. For example, "Connected" or "Terminated".
	Status *string `type:"string" enum:"SessionStatus"`

	// The instance that the Session Manager session connected to.
	Target *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about a Session Manager connection to an instance.

func (Session) GoString added in v1.99.0

func (s Session) GoString() string

GoString returns the string representation

func (*Session) SetDetails added in v1.99.0

func (s *Session) SetDetails(v string) *Session

SetDetails sets the Details field's value.

func (*Session) SetDocumentName added in v1.99.0

func (s *Session) SetDocumentName(v string) *Session

SetDocumentName sets the DocumentName field's value.

func (*Session) SetEndDate added in v1.99.0

func (s *Session) SetEndDate(v time.Time) *Session

SetEndDate sets the EndDate field's value.

func (*Session) SetOutputUrl added in v1.99.0

func (s *Session) SetOutputUrl(v *SessionManagerOutputUrl) *Session

SetOutputUrl sets the OutputUrl field's value.

func (*Session) SetOwner added in v1.99.0

func (s *Session) SetOwner(v string) *Session

SetOwner sets the Owner field's value.

func (*Session) SetSessionId added in v1.99.0

func (s *Session) SetSessionId(v string) *Session

SetSessionId sets the SessionId field's value.

func (*Session) SetStartDate added in v1.99.0

func (s *Session) SetStartDate(v time.Time) *Session

SetStartDate sets the StartDate field's value.

func (*Session) SetStatus added in v1.99.0

func (s *Session) SetStatus(v string) *Session

SetStatus sets the Status field's value.

func (*Session) SetTarget added in v1.99.0

func (s *Session) SetTarget(v string) *Session

SetTarget sets the Target field's value.

func (Session) String added in v1.99.0

func (s Session) String() string

String returns the string representation

type SessionFilter added in v1.99.0

type SessionFilter struct {

	// The name of the filter.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true" enum:"SessionFilterKey"`

	// The filter value. Valid values for each filter key are as follows:
	//
	//    * InvokedAfter: Specify a timestamp to limit your results. For example,
	//    specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018,
	//    and later.
	//
	//    * InvokedBefore: Specify a timestamp to limit your results. For example,
	//    specify 2018-08-29T00:00:00Z to see sessions that started before August
	//    29, 2018.
	//
	//    * Target: Specify an instance to which session connections have been made.
	//
	//    * Owner: Specify an AWS user account to see a list of sessions started
	//    by that user.
	//
	//    * Status: Specify a valid session status to see a list of all sessions
	//    with that status. Status values you can specify include: Connected Connecting
	//    Disconnected Terminated Terminating Failed
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a filter for Session Manager information.

func (SessionFilter) GoString added in v1.99.0

func (s SessionFilter) GoString() string

GoString returns the string representation

func (*SessionFilter) SetKey added in v1.99.0

func (s *SessionFilter) SetKey(v string) *SessionFilter

SetKey sets the Key field's value.

func (*SessionFilter) SetValue added in v1.99.0

func (s *SessionFilter) SetValue(v string) *SessionFilter

SetValue sets the Value field's value.

func (SessionFilter) String added in v1.99.0

func (s SessionFilter) String() string

String returns the string representation

func (*SessionFilter) Validate added in v1.99.0

func (s *SessionFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SessionManagerOutputUrl added in v1.99.0

type SessionManagerOutputUrl struct {

	// Reserved for future use.
	CloudWatchOutputUrl *string `min:"1" type:"string"`

	// Reserved for future use.
	S3OutputUrl *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Reserved for future use.

func (SessionManagerOutputUrl) GoString added in v1.99.0

func (s SessionManagerOutputUrl) GoString() string

GoString returns the string representation

func (*SessionManagerOutputUrl) SetCloudWatchOutputUrl added in v1.99.0

func (s *SessionManagerOutputUrl) SetCloudWatchOutputUrl(v string) *SessionManagerOutputUrl

SetCloudWatchOutputUrl sets the CloudWatchOutputUrl field's value.

func (*SessionManagerOutputUrl) SetS3OutputUrl added in v1.99.0

SetS3OutputUrl sets the S3OutputUrl field's value.

func (SessionManagerOutputUrl) String added in v1.99.0

func (s SessionManagerOutputUrl) String() string

String returns the string representation

type SeveritySummary added in v1.10.25

type SeveritySummary struct {

	// The total number of resources or compliance items that have a severity level
	// of critical. Critical severity is determined by the organization that published
	// the compliance items.
	CriticalCount *int64 `type:"integer"`

	// The total number of resources or compliance items that have a severity level
	// of high. High severity is determined by the organization that published the
	// compliance items.
	HighCount *int64 `type:"integer"`

	// The total number of resources or compliance items that have a severity level
	// of informational. Informational severity is determined by the organization
	// that published the compliance items.
	InformationalCount *int64 `type:"integer"`

	// The total number of resources or compliance items that have a severity level
	// of low. Low severity is determined by the organization that published the
	// compliance items.
	LowCount *int64 `type:"integer"`

	// The total number of resources or compliance items that have a severity level
	// of medium. Medium severity is determined by the organization that published
	// the compliance items.
	MediumCount *int64 `type:"integer"`

	// The total number of resources or compliance items that have a severity level
	// of unspecified. Unspecified severity is determined by the organization that
	// published the compliance items.
	UnspecifiedCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The number of managed instances found for each patch severity level defined in the request filter.

func (SeveritySummary) GoString added in v1.10.25

func (s SeveritySummary) GoString() string

GoString returns the string representation

func (*SeveritySummary) SetCriticalCount added in v1.10.25

func (s *SeveritySummary) SetCriticalCount(v int64) *SeveritySummary

SetCriticalCount sets the CriticalCount field's value.

func (*SeveritySummary) SetHighCount added in v1.10.25

func (s *SeveritySummary) SetHighCount(v int64) *SeveritySummary

SetHighCount sets the HighCount field's value.

func (*SeveritySummary) SetInformationalCount added in v1.10.25

func (s *SeveritySummary) SetInformationalCount(v int64) *SeveritySummary

SetInformationalCount sets the InformationalCount field's value.

func (*SeveritySummary) SetLowCount added in v1.10.25

func (s *SeveritySummary) SetLowCount(v int64) *SeveritySummary

SetLowCount sets the LowCount field's value.

func (*SeveritySummary) SetMediumCount added in v1.10.25

func (s *SeveritySummary) SetMediumCount(v int64) *SeveritySummary

SetMediumCount sets the MediumCount field's value.

func (*SeveritySummary) SetUnspecifiedCount added in v1.10.25

func (s *SeveritySummary) SetUnspecifiedCount(v int64) *SeveritySummary

SetUnspecifiedCount sets the UnspecifiedCount field's value.

func (SeveritySummary) String added in v1.10.25

func (s SeveritySummary) String() string

String returns the string representation

type StartAssociationsOnceInput added in v1.14.18

type StartAssociationsOnceInput struct {

	// The association IDs that you want to run immediately and only one time.
	//
	// AssociationIds is a required field
	AssociationIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StartAssociationsOnceInput) GoString added in v1.14.18

func (s StartAssociationsOnceInput) GoString() string

GoString returns the string representation

func (*StartAssociationsOnceInput) SetAssociationIds added in v1.14.18

func (s *StartAssociationsOnceInput) SetAssociationIds(v []*string) *StartAssociationsOnceInput

SetAssociationIds sets the AssociationIds field's value.

func (StartAssociationsOnceInput) String added in v1.14.18

String returns the string representation

func (*StartAssociationsOnceInput) Validate added in v1.14.18

func (s *StartAssociationsOnceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartAssociationsOnceOutput added in v1.14.18

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

func (StartAssociationsOnceOutput) GoString added in v1.14.18

func (s StartAssociationsOnceOutput) GoString() string

GoString returns the string representation

func (StartAssociationsOnceOutput) String added in v1.14.18

String returns the string representation

type StartAutomationExecutionInput added in v1.5.13

type StartAutomationExecutionInput struct {

	// User-provided idempotency token. The token must be unique, is case insensitive,
	// enforces the UUID format, and can't be reused.
	ClientToken *string `min:"36" type:"string"`

	// The name of the Automation document to use for this execution.
	//
	// DocumentName is a required field
	DocumentName *string `type:"string" required:"true"`

	// The version of the Automation document to use for this execution.
	DocumentVersion *string `type:"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 `min:"1" type:"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 `min:"1" type:"string"`

	// The execution mode of the automation. Valid modes include the following:
	// Auto and Interactive. The default mode is Auto.
	Mode *string `type:"string" enum:"ExecutionMode"`

	// A key-value map of execution parameters, which match the declared parameters
	// in the Automation document.
	Parameters map[string][]*string `min:"1" type:"map"`

	// A location is a combination of AWS Regions and/or AWS accounts where you
	// want to run the Automation. Use this action to start an Automation in multiple
	// Regions and multiple accounts. For more information, see Executing Automations
	// in Multiple AWS Regions and Accounts (http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html)
	// in the AWS Systems Manager User Guide.
	TargetLocations []*TargetLocation `min:"1" type:"list"`

	// A key-value mapping of document parameters to target resources. Both Targets
	// and TargetMaps cannot be specified together.
	TargetMaps []map[string][]*string `type:"list"`

	// The name of the parameter used as the target resource for the rate-controlled
	// execution. Required if you specify targets.
	TargetParameterName *string `min:"1" type:"string"`

	// A key-value mapping to target resources. Required if you specify TargetParameterName.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

func (StartAutomationExecutionInput) GoString added in v1.5.13

GoString returns the string representation

func (*StartAutomationExecutionInput) SetClientToken added in v1.10.37

SetClientToken sets the ClientToken field's value.

func (*StartAutomationExecutionInput) SetDocumentName added in v1.5.13

SetDocumentName sets the DocumentName field's value.

func (*StartAutomationExecutionInput) SetDocumentVersion added in v1.5.13

SetDocumentVersion sets the DocumentVersion field's value.

func (*StartAutomationExecutionInput) SetMaxConcurrency added in v1.12.37

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*StartAutomationExecutionInput) SetMaxErrors added in v1.12.37

SetMaxErrors sets the MaxErrors field's value.

func (*StartAutomationExecutionInput) SetMode added in v1.12.37

SetMode sets the Mode field's value.

func (*StartAutomationExecutionInput) SetParameters added in v1.5.13

SetParameters sets the Parameters field's value.

func (*StartAutomationExecutionInput) SetTargetLocations added in v1.99.0

SetTargetLocations sets the TargetLocations field's value.

func (*StartAutomationExecutionInput) SetTargetMaps added in v1.99.0

SetTargetMaps sets the TargetMaps field's value.

func (*StartAutomationExecutionInput) SetTargetParameterName added in v1.12.37

SetTargetParameterName sets the TargetParameterName field's value.

func (*StartAutomationExecutionInput) SetTargets added in v1.12.37

SetTargets sets the Targets field's value.

func (StartAutomationExecutionInput) String added in v1.5.13

String returns the string representation

func (*StartAutomationExecutionInput) Validate added in v1.5.13

func (s *StartAutomationExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartAutomationExecutionOutput added in v1.5.13

type StartAutomationExecutionOutput struct {

	// The unique ID of a newly scheduled automation execution.
	AutomationExecutionId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (StartAutomationExecutionOutput) GoString added in v1.5.13

GoString returns the string representation

func (*StartAutomationExecutionOutput) SetAutomationExecutionId added in v1.5.13

SetAutomationExecutionId sets the AutomationExecutionId field's value.

func (StartAutomationExecutionOutput) String added in v1.5.13

String returns the string representation

type StartSessionInput added in v1.99.0

type StartSessionInput struct {

	// The name of the SSM document to define the parameters and plugin settings
	// for the session. For example, SSM-SessionManagerRunShell. If no document
	// name is provided, a shell to the instance is launched by default.
	DocumentName *string `type:"string"`

	// Reserved for future use.
	Parameters map[string][]*string `type:"map"`

	// The instance to connect to for the session.
	//
	// Target is a required field
	Target *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartSessionInput) GoString added in v1.99.0

func (s StartSessionInput) GoString() string

GoString returns the string representation

func (*StartSessionInput) SetDocumentName added in v1.99.0

func (s *StartSessionInput) SetDocumentName(v string) *StartSessionInput

SetDocumentName sets the DocumentName field's value.

func (*StartSessionInput) SetParameters added in v1.99.0

func (s *StartSessionInput) SetParameters(v map[string][]*string) *StartSessionInput

SetParameters sets the Parameters field's value.

func (*StartSessionInput) SetTarget added in v1.99.0

func (s *StartSessionInput) SetTarget(v string) *StartSessionInput

SetTarget sets the Target field's value.

func (StartSessionInput) String added in v1.99.0

func (s StartSessionInput) String() string

String returns the string representation

func (*StartSessionInput) Validate added in v1.99.0

func (s *StartSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSessionOutput added in v1.99.0

type StartSessionOutput struct {

	// The ID of the session.
	SessionId *string `min:"1" type:"string"`

	// A URL back to SSM Agent on the instance that the Session Manager client uses
	// to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)
	//
	// region represents the Region identifier for an AWS Region supported by AWS
	// Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list
	// of supported region values, see the Region column in the AWS Systems Manager
	// table of regions and endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#ssm_region)
	// in the AWS General Reference.
	//
	// session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
	StreamUrl *string `type:"string"`

	// An encrypted token value containing session and caller information. Used
	// to authenticate the connection to the instance.
	TokenValue *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartSessionOutput) GoString added in v1.99.0

func (s StartSessionOutput) GoString() string

GoString returns the string representation

func (*StartSessionOutput) SetSessionId added in v1.99.0

func (s *StartSessionOutput) SetSessionId(v string) *StartSessionOutput

SetSessionId sets the SessionId field's value.

func (*StartSessionOutput) SetStreamUrl added in v1.99.0

func (s *StartSessionOutput) SetStreamUrl(v string) *StartSessionOutput

SetStreamUrl sets the StreamUrl field's value.

func (*StartSessionOutput) SetTokenValue added in v1.99.0

func (s *StartSessionOutput) SetTokenValue(v string) *StartSessionOutput

SetTokenValue sets the TokenValue field's value.

func (StartSessionOutput) String added in v1.99.0

func (s StartSessionOutput) String() string

String returns the string representation

type StepExecution added in v1.5.13

type StepExecution struct {

	// The action this step performs. The action determines the behavior of the
	// step.
	Action *string `type:"string"`

	// If a step has finished execution, this contains the time the execution ended.
	// If the step has not yet concluded, this field is not populated.
	ExecutionEndTime *time.Time `type:"timestamp"`

	// If a step has begun execution, this contains the time the step started. If
	// the step is in Pending status, this field is not populated.
	ExecutionStartTime *time.Time `type:"timestamp"`

	// Information about the Automation failure.
	FailureDetails *FailureDetails `type:"structure"`

	// If a step failed, this message explains why the execution failed.
	FailureMessage *string `type:"string"`

	// Fully-resolved values passed into the step before execution.
	Inputs map[string]*string `type:"map"`

	// The flag which can be used to help decide whether the failure of current
	// step leads to the Automation failure.
	IsCritical *bool `type:"boolean"`

	// The flag which can be used to end automation no matter whether the step succeeds
	// or fails.
	IsEnd *bool `type:"boolean"`

	// The maximum number of tries to run the action of the step. The default value
	// is 1.
	MaxAttempts *int64 `type:"integer"`

	// The next step after the step succeeds.
	NextStep *string `type:"string"`

	// The action to take if the step fails. The default value is Abort.
	OnFailure *string `type:"string"`

	// Returned values from the execution of the step.
	Outputs map[string][]*string `min:"1" type:"map"`

	// A user-specified list of parameters to override when running a step.
	OverriddenParameters map[string][]*string `min:"1" type:"map"`

	// A message associated with the response code for an execution.
	Response *string `type:"string"`

	// The response code returned by the execution of the step.
	ResponseCode *string `type:"string"`

	// The unique ID of a step execution.
	StepExecutionId *string `type:"string"`

	// The name of this execution step.
	StepName *string `type:"string"`

	// The execution status for this step. Valid values include: Pending, InProgress,
	// Success, Cancelled, Failed, and TimedOut.
	StepStatus *string `type:"string" enum:"AutomationExecutionStatus"`

	// The combination of AWS Regions and accounts targeted by the current Automation
	// execution.
	TargetLocation *TargetLocation `type:"structure"`

	// The targets for the step execution.
	Targets []*Target `type:"list"`

	// The timeout seconds of the step.
	TimeoutSeconds *int64 `type:"long"`

	// Strategies used when step fails, we support Continue and Abort. Abort will
	// fail the automation when the step fails. Continue will ignore the failure
	// of current step and allow automation to run the next step. With conditional
	// branching, we add step:stepName to support the automation to go to another
	// specific step.
	ValidNextSteps []*string `type:"list"`
	// contains filtered or unexported fields
}

Detailed information about an the execution state of an Automation step.

func (StepExecution) GoString added in v1.5.13

func (s StepExecution) GoString() string

GoString returns the string representation

func (*StepExecution) SetAction added in v1.5.13

func (s *StepExecution) SetAction(v string) *StepExecution

SetAction sets the Action field's value.

func (*StepExecution) SetExecutionEndTime added in v1.5.13

func (s *StepExecution) SetExecutionEndTime(v time.Time) *StepExecution

SetExecutionEndTime sets the ExecutionEndTime field's value.

func (*StepExecution) SetExecutionStartTime added in v1.5.13

func (s *StepExecution) SetExecutionStartTime(v time.Time) *StepExecution

SetExecutionStartTime sets the ExecutionStartTime field's value.

func (*StepExecution) SetFailureDetails added in v1.8.23

func (s *StepExecution) SetFailureDetails(v *FailureDetails) *StepExecution

SetFailureDetails sets the FailureDetails field's value.

func (*StepExecution) SetFailureMessage added in v1.5.13

func (s *StepExecution) SetFailureMessage(v string) *StepExecution

SetFailureMessage sets the FailureMessage field's value.

func (*StepExecution) SetInputs added in v1.5.13

func (s *StepExecution) SetInputs(v map[string]*string) *StepExecution

SetInputs sets the Inputs field's value.

func (*StepExecution) SetIsCritical added in v1.14.25

func (s *StepExecution) SetIsCritical(v bool) *StepExecution

SetIsCritical sets the IsCritical field's value.

func (*StepExecution) SetIsEnd added in v1.14.25

func (s *StepExecution) SetIsEnd(v bool) *StepExecution

SetIsEnd sets the IsEnd field's value.

func (*StepExecution) SetMaxAttempts added in v1.12.37

func (s *StepExecution) SetMaxAttempts(v int64) *StepExecution

SetMaxAttempts sets the MaxAttempts field's value.

func (*StepExecution) SetNextStep added in v1.14.25

func (s *StepExecution) SetNextStep(v string) *StepExecution

SetNextStep sets the NextStep field's value.

func (*StepExecution) SetOnFailure added in v1.12.37

func (s *StepExecution) SetOnFailure(v string) *StepExecution

SetOnFailure sets the OnFailure field's value.

func (*StepExecution) SetOutputs added in v1.5.13

func (s *StepExecution) SetOutputs(v map[string][]*string) *StepExecution

SetOutputs sets the Outputs field's value.

func (*StepExecution) SetOverriddenParameters added in v1.12.37

func (s *StepExecution) SetOverriddenParameters(v map[string][]*string) *StepExecution

SetOverriddenParameters sets the OverriddenParameters field's value.

func (*StepExecution) SetResponse added in v1.5.13

func (s *StepExecution) SetResponse(v string) *StepExecution

SetResponse sets the Response field's value.

func (*StepExecution) SetResponseCode added in v1.5.13

func (s *StepExecution) SetResponseCode(v string) *StepExecution

SetResponseCode sets the ResponseCode field's value.

func (*StepExecution) SetStepExecutionId added in v1.12.37

func (s *StepExecution) SetStepExecutionId(v string) *StepExecution

SetStepExecutionId sets the StepExecutionId field's value.

func (*StepExecution) SetStepName added in v1.5.13

func (s *StepExecution) SetStepName(v string) *StepExecution

SetStepName sets the StepName field's value.

func (*StepExecution) SetStepStatus added in v1.5.13

func (s *StepExecution) SetStepStatus(v string) *StepExecution

SetStepStatus sets the StepStatus field's value.

func (*StepExecution) SetTargetLocation added in v1.99.0

func (s *StepExecution) SetTargetLocation(v *TargetLocation) *StepExecution

SetTargetLocation sets the TargetLocation field's value.

func (*StepExecution) SetTargets added in v1.99.0

func (s *StepExecution) SetTargets(v []*Target) *StepExecution

SetTargets sets the Targets field's value.

func (*StepExecution) SetTimeoutSeconds added in v1.12.37

func (s *StepExecution) SetTimeoutSeconds(v int64) *StepExecution

SetTimeoutSeconds sets the TimeoutSeconds field's value.

func (*StepExecution) SetValidNextSteps added in v1.14.25

func (s *StepExecution) SetValidNextSteps(v []*string) *StepExecution

SetValidNextSteps sets the ValidNextSteps field's value.

func (StepExecution) String added in v1.5.13

func (s StepExecution) String() string

String returns the string representation

type StepExecutionFilter added in v1.12.37

type StepExecutionFilter struct {

	// One or more keys to limit the results. Valid filter keys include the following:
	// StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore,
	// StartTimeAfter.
	//
	// Key is a required field
	Key *string `type:"string" required:"true" enum:"StepExecutionFilterKey"`

	// The values of the filter key.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A filter to limit the amount of step execution information returned by the call.

func (StepExecutionFilter) GoString added in v1.12.37

func (s StepExecutionFilter) GoString() string

GoString returns the string representation

func (*StepExecutionFilter) SetKey added in v1.12.37

SetKey sets the Key field's value.

func (*StepExecutionFilter) SetValues added in v1.12.37

func (s *StepExecutionFilter) SetValues(v []*string) *StepExecutionFilter

SetValues sets the Values field's value.

func (StepExecutionFilter) String added in v1.12.37

func (s StepExecutionFilter) String() string

String returns the string representation

func (*StepExecutionFilter) Validate added in v1.12.37

func (s *StepExecutionFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopAutomationExecutionInput added in v1.5.13

type StopAutomationExecutionInput struct {

	// The execution ID of the Automation to stop.
	//
	// AutomationExecutionId is a required field
	AutomationExecutionId *string `min:"36" type:"string" required:"true"`

	// The stop request type. Valid types include the following: Cancel and Complete.
	// The default type is Cancel.
	Type *string `type:"string" enum:"StopType"`
	// contains filtered or unexported fields
}

func (StopAutomationExecutionInput) GoString added in v1.5.13

func (s StopAutomationExecutionInput) GoString() string

GoString returns the string representation

func (*StopAutomationExecutionInput) SetAutomationExecutionId added in v1.5.13

func (s *StopAutomationExecutionInput) SetAutomationExecutionId(v string) *StopAutomationExecutionInput

SetAutomationExecutionId sets the AutomationExecutionId field's value.

func (*StopAutomationExecutionInput) SetType added in v1.12.37

SetType sets the Type field's value.

func (StopAutomationExecutionInput) String added in v1.5.13

String returns the string representation

func (*StopAutomationExecutionInput) Validate added in v1.5.13

func (s *StopAutomationExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopAutomationExecutionOutput added in v1.5.13

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

func (StopAutomationExecutionOutput) GoString added in v1.5.13

GoString returns the string representation

func (StopAutomationExecutionOutput) String added in v1.5.13

String returns the string representation

type Tag added in v1.2.2

type Tag struct {

	// The name of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Systems Manager, you can apply tags to documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines.

func (Tag) GoString added in v1.2.2

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.5.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.2.2

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.2.2

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Target added in v1.5.13

type Target struct {

	// User-defined criteria for sending commands that target instances that meet
	// the criteria.
	Key *string `min:"1" type:"string"`

	// User-defined criteria that maps to Key. For example, if you specified tag:ServerRole,
	// you could specify value:WebServer to run a command on instances that include
	// Amazon EC2 tags of ServerRole,WebServer.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

An array of search criteria that targets instances using a Key,Value combination that you specify.

Supported formats include the following.

  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

  • Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

  • Key=tag-key,Values=my-tag-key-1,my-tag-key-2

  • (Maintenance window targets only) Key=resource-groups:Name,Values=resource-group-name

  • (Maintenance window targets only) Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For example:

  • Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

  • Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

  • Key=tag-key,Values=Name,Instance-Type,CostCenter

  • (Maintenance window targets only) Key=resource-groups:Name,Values=ProductionResourceGroup

  • (Maintenance window targets only) Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

For information about how to send commands that target instances using Key,Value parameters, 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#send-commands-targeting) in the AWS Systems Manager User Guide.

func (Target) GoString added in v1.5.13

func (s Target) GoString() string

GoString returns the string representation

func (*Target) SetKey added in v1.5.13

func (s *Target) SetKey(v string) *Target

SetKey sets the Key field's value.

func (*Target) SetValues added in v1.5.13

func (s *Target) SetValues(v []*string) *Target

SetValues sets the Values field's value.

func (Target) String added in v1.5.13

func (s Target) String() string

String returns the string representation

func (*Target) Validate added in v1.5.13

func (s *Target) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TargetLocation added in v1.99.0

type TargetLocation struct {

	// The AWS accounts targeted by the current Automation execution.
	Accounts []*string `min:"1" type:"list"`

	// The Automation execution role used by the currently running Automation.
	ExecutionRoleName *string `min:"1" type:"string"`

	// The AWS Regions targeted by the current Automation execution.
	Regions []*string `min:"1" type:"list"`

	// The maximum number of AWS accounts and AWS regions allowed to run the Automation
	// concurrently
	TargetLocationMaxConcurrency *string `min:"1" type:"string"`

	// The maximum number of errors allowed before the system stops queueing additional
	// Automation executions for the currently running Automation.
	TargetLocationMaxErrors *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The combination of AWS Regions and accounts targeted by the current Automation execution.

func (TargetLocation) GoString added in v1.99.0

func (s TargetLocation) GoString() string

GoString returns the string representation

func (*TargetLocation) SetAccounts added in v1.99.0

func (s *TargetLocation) SetAccounts(v []*string) *TargetLocation

SetAccounts sets the Accounts field's value.

func (*TargetLocation) SetExecutionRoleName added in v1.99.0

func (s *TargetLocation) SetExecutionRoleName(v string) *TargetLocation

SetExecutionRoleName sets the ExecutionRoleName field's value.

func (*TargetLocation) SetRegions added in v1.99.0

func (s *TargetLocation) SetRegions(v []*string) *TargetLocation

SetRegions sets the Regions field's value.

func (*TargetLocation) SetTargetLocationMaxConcurrency added in v1.99.0

func (s *TargetLocation) SetTargetLocationMaxConcurrency(v string) *TargetLocation

SetTargetLocationMaxConcurrency sets the TargetLocationMaxConcurrency field's value.

func (*TargetLocation) SetTargetLocationMaxErrors added in v1.99.0

func (s *TargetLocation) SetTargetLocationMaxErrors(v string) *TargetLocation

SetTargetLocationMaxErrors sets the TargetLocationMaxErrors field's value.

func (TargetLocation) String added in v1.99.0

func (s TargetLocation) String() string

String returns the string representation

func (*TargetLocation) Validate added in v1.99.0

func (s *TargetLocation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TerminateSessionInput added in v1.99.0

type TerminateSessionInput struct {

	// The ID of the session to terminate.
	//
	// SessionId is a required field
	SessionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TerminateSessionInput) GoString added in v1.99.0

func (s TerminateSessionInput) GoString() string

GoString returns the string representation

func (*TerminateSessionInput) SetSessionId added in v1.99.0

SetSessionId sets the SessionId field's value.

func (TerminateSessionInput) String added in v1.99.0

func (s TerminateSessionInput) String() string

String returns the string representation

func (*TerminateSessionInput) Validate added in v1.99.0

func (s *TerminateSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TerminateSessionOutput added in v1.99.0

type TerminateSessionOutput struct {

	// The ID of the session that has been terminated.
	SessionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (TerminateSessionOutput) GoString added in v1.99.0

func (s TerminateSessionOutput) GoString() string

GoString returns the string representation

func (*TerminateSessionOutput) SetSessionId added in v1.99.0

SetSessionId sets the SessionId field's value.

func (TerminateSessionOutput) String added in v1.99.0

func (s TerminateSessionOutput) String() string

String returns the string representation

type UpdateAssociationInput added in v1.5.13

type UpdateAssociationInput struct {

	// The ID of the association you want to update.
	//
	// AssociationId is a required field
	AssociationId *string `type:"string" required:"true"`

	// The name of the association that you want to update.
	AssociationName *string `type:"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 `type:"string"`

	// Specify the target for the association. This target is required for associations
	// that use an Automation document and target resources by using rate controls.
	AutomationTargetParameterName *string `min:"1" type:"string"`

	// The severity level to assign to the association.
	ComplianceSeverity *string `type:"string" enum:"AssociationComplianceSeverity"`

	// The document version you want update for the association.
	DocumentVersion *string `type:"string"`

	// The maximum number of targets allowed to run the association at the same
	// time. You can specify a number, for example 10, or a percentage of the target
	// set, for example 10%. The default value is 100%, which means all targets
	// run the association at the same time.
	//
	// If a new instance starts and attempts to run an association while Systems
	// Manager is running MaxConcurrency associations, the association is allowed
	// to run. During the next association interval, the new instance will process
	// its association within the limit specified for MaxConcurrency.
	MaxConcurrency *string `min:"1" type:"string"`

	// The number of errors that are allowed before the system stops sending requests
	// to run the association on additional targets. You can specify either an absolute
	// number of errors, for example 10, or a percentage of the target set, for
	// example 10%. If you specify 3, for example, the system stops sending requests
	// when the fourth error is received. If you specify 0, then the system stops
	// sending requests after the first error is returned. If you run an association
	// on 50 instances and set MaxError to 10%, then the system stops sending the
	// request when the sixth error is received.
	//
	// Executions that are already running an association when MaxErrors is reached
	// are allowed to complete, but some of these executions may fail as well. If
	// you need to ensure that there won't be more than max-errors failed executions,
	// set MaxConcurrency to 1 so that executions proceed one at a time.
	MaxErrors *string `min:"1" type:"string"`

	// The name of the SSM document that contains the configuration information
	// for the instance. You can specify Command or Automation documents.
	//
	// You can specify AWS-predefined documents, documents you created, or a document
	// that is shared with you from another account.
	//
	// For SSM documents that are shared with you from other AWS accounts, you must
	// specify the complete SSM document ARN, in the following format:
	//
	// arn:aws:ssm:region:account-id:document/document-name
	//
	// For example:
	//
	// arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
	//
	// For AWS-predefined documents and SSM documents you created in your account,
	// you only need to specify the document name. For example, AWS-ApplyPatchBaseline
	// or My-Document.
	Name *string `type:"string"`

	// An Amazon S3 bucket where you want to store the results of this request.
	OutputLocation *InstanceAssociationOutputLocation `type:"structure"`

	// The parameters you want to update for the association. If you create a parameter
	// using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}
	Parameters map[string][]*string `type:"map"`

	// The cron expression used to schedule the association that you want to update.
	ScheduleExpression *string `min:"1" type:"string"`

	// The targets of the association.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateAssociationInput) GoString added in v1.5.13

func (s UpdateAssociationInput) GoString() string

GoString returns the string representation

func (*UpdateAssociationInput) SetAssociationId added in v1.5.13

func (s *UpdateAssociationInput) SetAssociationId(v string) *UpdateAssociationInput

SetAssociationId sets the AssociationId field's value.

func (*UpdateAssociationInput) SetAssociationName added in v1.10.30

func (s *UpdateAssociationInput) SetAssociationName(v string) *UpdateAssociationInput

SetAssociationName sets the AssociationName field's value.

func (*UpdateAssociationInput) SetAssociationVersion added in v1.10.30

func (s *UpdateAssociationInput) SetAssociationVersion(v string) *UpdateAssociationInput

SetAssociationVersion sets the AssociationVersion field's value.

func (*UpdateAssociationInput) SetAutomationTargetParameterName added in v1.99.0

func (s *UpdateAssociationInput) SetAutomationTargetParameterName(v string) *UpdateAssociationInput

SetAutomationTargetParameterName sets the AutomationTargetParameterName field's value.

func (*UpdateAssociationInput) SetComplianceSeverity added in v1.99.0

func (s *UpdateAssociationInput) SetComplianceSeverity(v string) *UpdateAssociationInput

SetComplianceSeverity sets the ComplianceSeverity field's value.

func (*UpdateAssociationInput) SetDocumentVersion added in v1.5.13

func (s *UpdateAssociationInput) SetDocumentVersion(v string) *UpdateAssociationInput

SetDocumentVersion sets the DocumentVersion field's value.

func (*UpdateAssociationInput) SetMaxConcurrency added in v1.99.0

func (s *UpdateAssociationInput) SetMaxConcurrency(v string) *UpdateAssociationInput

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*UpdateAssociationInput) SetMaxErrors added in v1.99.0

SetMaxErrors sets the MaxErrors field's value.

func (*UpdateAssociationInput) SetName added in v1.8.23

SetName sets the Name field's value.

func (*UpdateAssociationInput) SetOutputLocation added in v1.5.13

SetOutputLocation sets the OutputLocation field's value.

func (*UpdateAssociationInput) SetParameters added in v1.5.13

func (s *UpdateAssociationInput) SetParameters(v map[string][]*string) *UpdateAssociationInput

SetParameters sets the Parameters field's value.

func (*UpdateAssociationInput) SetScheduleExpression added in v1.5.13

func (s *UpdateAssociationInput) SetScheduleExpression(v string) *UpdateAssociationInput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*UpdateAssociationInput) SetTargets added in v1.8.23

SetTargets sets the Targets field's value.

func (UpdateAssociationInput) String added in v1.5.13

func (s UpdateAssociationInput) String() string

String returns the string representation

func (*UpdateAssociationInput) Validate added in v1.5.13

func (s *UpdateAssociationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAssociationOutput added in v1.5.13

type UpdateAssociationOutput struct {

	// The description of the association that was updated.
	AssociationDescription *AssociationDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAssociationOutput) GoString added in v1.5.13

func (s UpdateAssociationOutput) GoString() string

GoString returns the string representation

func (*UpdateAssociationOutput) SetAssociationDescription added in v1.5.13

SetAssociationDescription sets the AssociationDescription field's value.

func (UpdateAssociationOutput) String added in v1.5.13

func (s UpdateAssociationOutput) String() string

String returns the string representation

type UpdateAssociationStatusInput

type UpdateAssociationStatusInput struct {

	// The association status.
	//
	// AssociationStatus is a required field
	AssociationStatus *AssociationStatus `type:"structure" required:"true"`

	// The ID of the instance.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The name of the Systems Manager document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssociationStatusInput) GoString added in v0.6.5

func (s UpdateAssociationStatusInput) GoString() string

GoString returns the string representation

func (*UpdateAssociationStatusInput) SetAssociationStatus added in v1.5.0

SetAssociationStatus sets the AssociationStatus field's value.

func (*UpdateAssociationStatusInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (*UpdateAssociationStatusInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (UpdateAssociationStatusInput) String added in v0.6.5

String returns the string representation

func (*UpdateAssociationStatusInput) Validate added in v1.1.21

func (s *UpdateAssociationStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAssociationStatusOutput

type UpdateAssociationStatusOutput struct {

	// Information about the association.
	AssociationDescription *AssociationDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAssociationStatusOutput) GoString added in v0.6.5

GoString returns the string representation

func (*UpdateAssociationStatusOutput) SetAssociationDescription added in v1.5.0

SetAssociationDescription sets the AssociationDescription field's value.

func (UpdateAssociationStatusOutput) String added in v0.6.5

String returns the string representation

type UpdateDocumentDefaultVersionInput added in v1.5.13

type UpdateDocumentDefaultVersionInput struct {

	// The version of a custom document that you want to set as the default version.
	//
	// DocumentVersion is a required field
	DocumentVersion *string `type:"string" required:"true"`

	// The name of a custom document that you want to set as the default version.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDocumentDefaultVersionInput) GoString added in v1.5.13

GoString returns the string representation

func (*UpdateDocumentDefaultVersionInput) SetDocumentVersion added in v1.5.13

SetDocumentVersion sets the DocumentVersion field's value.

func (*UpdateDocumentDefaultVersionInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (UpdateDocumentDefaultVersionInput) String added in v1.5.13

String returns the string representation

func (*UpdateDocumentDefaultVersionInput) Validate added in v1.5.13

Validate inspects the fields of the type to determine if they are valid.

type UpdateDocumentDefaultVersionOutput added in v1.5.13

type UpdateDocumentDefaultVersionOutput struct {

	// The description of a custom document that you want to set as the default
	// version.
	Description *DocumentDefaultVersionDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDocumentDefaultVersionOutput) GoString added in v1.5.13

GoString returns the string representation

func (*UpdateDocumentDefaultVersionOutput) SetDescription added in v1.5.13

SetDescription sets the Description field's value.

func (UpdateDocumentDefaultVersionOutput) String added in v1.5.13

String returns the string representation

type UpdateDocumentInput added in v1.5.13

type UpdateDocumentInput struct {

	// A list of key and value pairs that describe attachments to a version of a
	// document.
	Attachments []*AttachmentsSource `type:"list"`

	// A valid JSON or YAML string.
	//
	// Content is a required field
	Content *string `min:"1" type:"string" required:"true"`

	// Specify the document format for the new document version. Systems Manager
	// supports JSON and YAML documents. JSON is the default format.
	DocumentFormat *string `type:"string" enum:"DocumentFormat"`

	// The version of the document that you want to update.
	DocumentVersion *string `type:"string"`

	// The name of the document that you want to update.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Specify a new target type for the document.
	TargetType *string `type:"string"`

	// An optional field specifying the version of the artifact you are updating
	// with the document. For example, "Release 12, Update 6". This value is unique
	// across all versions of a document, and cannot be changed.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateDocumentInput) GoString added in v1.5.13

func (s UpdateDocumentInput) GoString() string

GoString returns the string representation

func (*UpdateDocumentInput) SetAttachments added in v1.99.0

SetAttachments sets the Attachments field's value.

func (*UpdateDocumentInput) SetContent added in v1.5.13

SetContent sets the Content field's value.

func (*UpdateDocumentInput) SetDocumentFormat added in v1.12.37

func (s *UpdateDocumentInput) SetDocumentFormat(v string) *UpdateDocumentInput

SetDocumentFormat sets the DocumentFormat field's value.

func (*UpdateDocumentInput) SetDocumentVersion added in v1.5.13

func (s *UpdateDocumentInput) SetDocumentVersion(v string) *UpdateDocumentInput

SetDocumentVersion sets the DocumentVersion field's value.

func (*UpdateDocumentInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*UpdateDocumentInput) SetTargetType added in v1.12.37

func (s *UpdateDocumentInput) SetTargetType(v string) *UpdateDocumentInput

SetTargetType sets the TargetType field's value.

func (*UpdateDocumentInput) SetVersionName added in v1.99.0

func (s *UpdateDocumentInput) SetVersionName(v string) *UpdateDocumentInput

SetVersionName sets the VersionName field's value.

func (UpdateDocumentInput) String added in v1.5.13

func (s UpdateDocumentInput) String() string

String returns the string representation

func (*UpdateDocumentInput) Validate added in v1.5.13

func (s *UpdateDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDocumentOutput added in v1.5.13

type UpdateDocumentOutput struct {

	// A description of the document that was updated.
	DocumentDescription *DocumentDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDocumentOutput) GoString added in v1.5.13

func (s UpdateDocumentOutput) GoString() string

GoString returns the string representation

func (*UpdateDocumentOutput) SetDocumentDescription added in v1.5.13

func (s *UpdateDocumentOutput) SetDocumentDescription(v *DocumentDescription) *UpdateDocumentOutput

SetDocumentDescription sets the DocumentDescription field's value.

func (UpdateDocumentOutput) String added in v1.5.13

func (s UpdateDocumentOutput) String() string

String returns the string representation

type UpdateMaintenanceWindowInput added in v1.5.13

type UpdateMaintenanceWindowInput struct {

	// Whether targets must be registered with the maintenance window before tasks
	// can be defined for those targets.
	AllowUnassociatedTargets *bool `type:"boolean"`

	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int64 `type:"integer"`

	// An optional description for the update request.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The duration of the maintenance window in hours.
	Duration *int64 `min:"1" type:"integer"`

	// Whether the maintenance window is enabled.
	Enabled *bool `type:"boolean"`

	// 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 `type:"string"`

	// The name of the maintenance window.
	Name *string `min:"3" type:"string"`

	// If True, then all fields that are required by the CreateMaintenanceWindow
	// action are also required for this API request. Optional fields that are not
	// specified are set to null.
	Replace *bool `type:"boolean"`

	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string `min:"1" type:"string"`

	// The time zone that the scheduled maintenance window executions are based
	// on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles",
	// "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database
	// (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string `type:"string"`

	// The time zone that the scheduled maintenance window executions are based
	// on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles",
	// "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database
	// (https://www.iana.org/time-zones) on the IANA website.
	StartDate *string `type:"string"`

	// The ID of the maintenance window to update.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMaintenanceWindowInput) GoString added in v1.5.13

func (s UpdateMaintenanceWindowInput) GoString() string

GoString returns the string representation

func (*UpdateMaintenanceWindowInput) SetAllowUnassociatedTargets added in v1.5.13

func (s *UpdateMaintenanceWindowInput) SetAllowUnassociatedTargets(v bool) *UpdateMaintenanceWindowInput

SetAllowUnassociatedTargets sets the AllowUnassociatedTargets field's value.

func (*UpdateMaintenanceWindowInput) SetCutoff added in v1.5.13

SetCutoff sets the Cutoff field's value.

func (*UpdateMaintenanceWindowInput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*UpdateMaintenanceWindowInput) SetDuration added in v1.5.13

SetDuration sets the Duration field's value.

func (*UpdateMaintenanceWindowInput) SetEnabled added in v1.5.13

SetEnabled sets the Enabled field's value.

func (*UpdateMaintenanceWindowInput) SetEndDate added in v1.99.0

SetEndDate sets the EndDate field's value.

func (*UpdateMaintenanceWindowInput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*UpdateMaintenanceWindowInput) SetReplace added in v1.10.25

SetReplace sets the Replace field's value.

func (*UpdateMaintenanceWindowInput) SetSchedule added in v1.5.13

SetSchedule sets the Schedule field's value.

func (*UpdateMaintenanceWindowInput) SetScheduleTimezone added in v1.99.0

SetScheduleTimezone sets the ScheduleTimezone field's value.

func (*UpdateMaintenanceWindowInput) SetStartDate added in v1.99.0

SetStartDate sets the StartDate field's value.

func (*UpdateMaintenanceWindowInput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (UpdateMaintenanceWindowInput) String added in v1.5.13

String returns the string representation

func (*UpdateMaintenanceWindowInput) Validate added in v1.5.13

func (s *UpdateMaintenanceWindowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMaintenanceWindowOutput added in v1.5.13

type UpdateMaintenanceWindowOutput struct {

	// Whether targets must be registered with the maintenance window before tasks
	// can be defined for those targets.
	AllowUnassociatedTargets *bool `type:"boolean"`

	// The number of hours before the end of the maintenance window that Systems
	// Manager stops scheduling new tasks for execution.
	Cutoff *int64 `type:"integer"`

	// An optional description of the update.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The duration of the maintenance window in hours.
	Duration *int64 `min:"1" type:"integer"`

	// Whether the maintenance window is enabled.
	Enabled *bool `type:"boolean"`

	// The date and time, in ISO-8601 Extended format, for when the maintenance
	// window is scheduled to become inactive. The maintenance window will not run
	// after this specified time.
	EndDate *string `type:"string"`

	// The name of the maintenance window.
	Name *string `min:"3" type:"string"`

	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string `min:"1" type:"string"`

	// The time zone that the scheduled maintenance window executions are based
	// on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles",
	// "etc/UTC", or "Asia/Seoul". For more information, see the Time Zone Database
	// (https://www.iana.org/time-zones) on the IANA website.
	ScheduleTimezone *string `type:"string"`

	// The date and time, in ISO-8601 Extended format, for when the maintenance
	// window is scheduled to become active. The maintenance window will not run
	// before this specified time.
	StartDate *string `type:"string"`

	// The ID of the created maintenance window.
	WindowId *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateMaintenanceWindowOutput) GoString added in v1.5.13

GoString returns the string representation

func (*UpdateMaintenanceWindowOutput) SetAllowUnassociatedTargets added in v1.5.13

func (s *UpdateMaintenanceWindowOutput) SetAllowUnassociatedTargets(v bool) *UpdateMaintenanceWindowOutput

SetAllowUnassociatedTargets sets the AllowUnassociatedTargets field's value.

func (*UpdateMaintenanceWindowOutput) SetCutoff added in v1.5.13

SetCutoff sets the Cutoff field's value.

func (*UpdateMaintenanceWindowOutput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*UpdateMaintenanceWindowOutput) SetDuration added in v1.5.13

SetDuration sets the Duration field's value.

func (*UpdateMaintenanceWindowOutput) SetEnabled added in v1.5.13

SetEnabled sets the Enabled field's value.

func (*UpdateMaintenanceWindowOutput) SetEndDate added in v1.99.0

SetEndDate sets the EndDate field's value.

func (*UpdateMaintenanceWindowOutput) SetName added in v1.5.13

SetName sets the Name field's value.

func (*UpdateMaintenanceWindowOutput) SetSchedule added in v1.5.13

SetSchedule sets the Schedule field's value.

func (*UpdateMaintenanceWindowOutput) SetScheduleTimezone added in v1.99.0

SetScheduleTimezone sets the ScheduleTimezone field's value.

func (*UpdateMaintenanceWindowOutput) SetStartDate added in v1.99.0

SetStartDate sets the StartDate field's value.

func (*UpdateMaintenanceWindowOutput) SetWindowId added in v1.5.13

SetWindowId sets the WindowId field's value.

func (UpdateMaintenanceWindowOutput) String added in v1.5.13

String returns the string representation

type UpdateMaintenanceWindowTargetInput added in v1.10.25

type UpdateMaintenanceWindowTargetInput struct {

	// An optional description for the update.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// A name for the update.
	Name *string `min:"3" type:"string"`

	// User-provided value that will be included in any CloudWatch events raised
	// while running tasks for these targets in this maintenance window.
	OwnerInformation *string `min:"1" type:"string" sensitive:"true"`

	// If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow
	// action are also required for this API request. Optional fields that are not
	// specified are set to null.
	Replace *bool `type:"boolean"`

	// The targets to add or replace.
	Targets []*Target `type:"list"`

	// The maintenance window ID with which to modify the target.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`

	// The target ID to modify.
	//
	// WindowTargetId is a required field
	WindowTargetId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMaintenanceWindowTargetInput) GoString added in v1.10.25

GoString returns the string representation

func (*UpdateMaintenanceWindowTargetInput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*UpdateMaintenanceWindowTargetInput) SetName added in v1.10.25

SetName sets the Name field's value.

func (*UpdateMaintenanceWindowTargetInput) SetOwnerInformation added in v1.10.25

SetOwnerInformation sets the OwnerInformation field's value.

func (*UpdateMaintenanceWindowTargetInput) SetReplace added in v1.10.25

SetReplace sets the Replace field's value.

func (*UpdateMaintenanceWindowTargetInput) SetTargets added in v1.10.25

SetTargets sets the Targets field's value.

func (*UpdateMaintenanceWindowTargetInput) SetWindowId added in v1.10.25

SetWindowId sets the WindowId field's value.

func (*UpdateMaintenanceWindowTargetInput) SetWindowTargetId added in v1.10.25

SetWindowTargetId sets the WindowTargetId field's value.

func (UpdateMaintenanceWindowTargetInput) String added in v1.10.25

String returns the string representation

func (*UpdateMaintenanceWindowTargetInput) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type UpdateMaintenanceWindowTargetOutput added in v1.10.25

type UpdateMaintenanceWindowTargetOutput struct {

	// The updated description.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The updated name.
	Name *string `min:"3" type:"string"`

	// The updated owner.
	OwnerInformation *string `min:"1" type:"string" sensitive:"true"`

	// The updated targets.
	Targets []*Target `type:"list"`

	// The maintenance window ID specified in the update request.
	WindowId *string `min:"20" type:"string"`

	// The target ID specified in the update request.
	WindowTargetId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateMaintenanceWindowTargetOutput) GoString added in v1.10.25

GoString returns the string representation

func (*UpdateMaintenanceWindowTargetOutput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*UpdateMaintenanceWindowTargetOutput) SetName added in v1.10.25

SetName sets the Name field's value.

func (*UpdateMaintenanceWindowTargetOutput) SetOwnerInformation added in v1.10.25

SetOwnerInformation sets the OwnerInformation field's value.

func (*UpdateMaintenanceWindowTargetOutput) SetTargets added in v1.10.25

SetTargets sets the Targets field's value.

func (*UpdateMaintenanceWindowTargetOutput) SetWindowId added in v1.10.25

SetWindowId sets the WindowId field's value.

func (*UpdateMaintenanceWindowTargetOutput) SetWindowTargetId added in v1.10.25

SetWindowTargetId sets the WindowTargetId field's value.

func (UpdateMaintenanceWindowTargetOutput) String added in v1.10.25

String returns the string representation

type UpdateMaintenanceWindowTaskInput added in v1.10.25

type UpdateMaintenanceWindowTaskInput struct {

	// The new task description to specify.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The new logging location in Amazon S3 to specify.
	//
	// LoggingInfo has been deprecated. To specify an S3 bucket to contain logs,
	// instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	LoggingInfo *LoggingInfo `type:"structure"`

	// The new MaxConcurrency value you want to specify. MaxConcurrency is the number
	// of targets that are allowed to run this task in parallel.
	MaxConcurrency *string `min:"1" type:"string"`

	// The new MaxErrors value to specify. MaxErrors is the maximum number of errors
	// that are allowed before the task stops being scheduled.
	MaxErrors *string `min:"1" type:"string"`

	// The new task name to specify.
	Name *string `min:"3" type:"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 *int64 `type:"integer"`

	// If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow
	// action are also required for this API request. Optional fields that are not
	// specified are set to null.
	Replace *bool `type:"boolean"`

	// The ARN of the IAM service role for Systems Manager to assume when running
	// a maintenance window task. If you do not specify a service role ARN, Systems
	// Manager uses your account's service-linked role. If no service-linked role
	// for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
	//
	// For more information, see the following topics in the in the AWS Systems
	// Manager User Guide:
	//
	//    * Service-Linked Role Permissions for Systems Manager (http://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? (http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role)
	ServiceRoleArn *string `type:"string"`

	// The targets (either instances or tags) to modify. Instances are specified
	// using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified
	// using Key=tag_name,Values=tag_value.
	Targets []*Target `type:"list"`

	// The task ARN to modify.
	TaskArn *string `min:"1" type:"string"`

	// The parameters that the task should use during execution. Populate only the
	// fields that match the task type. All other fields should be empty.
	TaskInvocationParameters *MaintenanceWindowTaskInvocationParameters `type:"structure"`

	// 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]*MaintenanceWindowTaskParameterValueExpression `type:"map" sensitive:"true"`

	// The maintenance window ID that contains the task to modify.
	//
	// WindowId is a required field
	WindowId *string `min:"20" type:"string" required:"true"`

	// The task ID to modify.
	//
	// WindowTaskId is a required field
	WindowTaskId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMaintenanceWindowTaskInput) GoString added in v1.10.25

GoString returns the string representation

func (*UpdateMaintenanceWindowTaskInput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*UpdateMaintenanceWindowTaskInput) SetLoggingInfo added in v1.10.25

SetLoggingInfo sets the LoggingInfo field's value.

func (*UpdateMaintenanceWindowTaskInput) SetMaxConcurrency added in v1.10.25

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*UpdateMaintenanceWindowTaskInput) SetMaxErrors added in v1.10.25

SetMaxErrors sets the MaxErrors field's value.

func (*UpdateMaintenanceWindowTaskInput) SetName added in v1.10.25

SetName sets the Name field's value.

func (*UpdateMaintenanceWindowTaskInput) SetPriority added in v1.10.25

SetPriority sets the Priority field's value.

func (*UpdateMaintenanceWindowTaskInput) SetReplace added in v1.10.25

SetReplace sets the Replace field's value.

func (*UpdateMaintenanceWindowTaskInput) SetServiceRoleArn added in v1.10.25

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*UpdateMaintenanceWindowTaskInput) SetTargets added in v1.10.25

SetTargets sets the Targets field's value.

func (*UpdateMaintenanceWindowTaskInput) SetTaskArn added in v1.10.25

SetTaskArn sets the TaskArn field's value.

func (*UpdateMaintenanceWindowTaskInput) SetTaskInvocationParameters added in v1.10.25

SetTaskInvocationParameters sets the TaskInvocationParameters field's value.

func (*UpdateMaintenanceWindowTaskInput) SetTaskParameters added in v1.10.25

SetTaskParameters sets the TaskParameters field's value.

func (*UpdateMaintenanceWindowTaskInput) SetWindowId added in v1.10.25

SetWindowId sets the WindowId field's value.

func (*UpdateMaintenanceWindowTaskInput) SetWindowTaskId added in v1.10.25

SetWindowTaskId sets the WindowTaskId field's value.

func (UpdateMaintenanceWindowTaskInput) String added in v1.10.25

String returns the string representation

func (*UpdateMaintenanceWindowTaskInput) Validate added in v1.10.25

Validate inspects the fields of the type to determine if they are valid.

type UpdateMaintenanceWindowTaskOutput added in v1.10.25

type UpdateMaintenanceWindowTaskOutput struct {

	// The updated task description.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The updated logging information in Amazon S3.
	//
	// LoggingInfo has been deprecated. To specify an S3 bucket to contain logs,
	// instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	LoggingInfo *LoggingInfo `type:"structure"`

	// The updated MaxConcurrency value.
	MaxConcurrency *string `min:"1" type:"string"`

	// The updated MaxErrors value.
	MaxErrors *string `min:"1" type:"string"`

	// The updated task name.
	Name *string `min:"3" type:"string"`

	// The updated priority value.
	Priority *int64 `type:"integer"`

	// The ARN of the IAM service role to use to publish Amazon Simple Notification
	// Service (Amazon SNS) notifications for maintenance window Run Command tasks.
	ServiceRoleArn *string `type:"string"`

	// The updated target values.
	Targets []*Target `type:"list"`

	// The updated task ARN value.
	TaskArn *string `min:"1" type:"string"`

	// The updated parameter values.
	TaskInvocationParameters *MaintenanceWindowTaskInvocationParameters `type:"structure"`

	// 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]*MaintenanceWindowTaskParameterValueExpression `type:"map" sensitive:"true"`

	// The ID of the maintenance window that was updated.
	WindowId *string `min:"20" type:"string"`

	// The task ID of the maintenance window that was updated.
	WindowTaskId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateMaintenanceWindowTaskOutput) GoString added in v1.10.25

GoString returns the string representation

func (*UpdateMaintenanceWindowTaskOutput) SetDescription added in v1.10.25

SetDescription sets the Description field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetLoggingInfo added in v1.10.25

SetLoggingInfo sets the LoggingInfo field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetMaxConcurrency added in v1.10.25

SetMaxConcurrency sets the MaxConcurrency field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetMaxErrors added in v1.10.25

SetMaxErrors sets the MaxErrors field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetName added in v1.10.25

SetName sets the Name field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetPriority added in v1.10.25

SetPriority sets the Priority field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetServiceRoleArn added in v1.10.25

SetServiceRoleArn sets the ServiceRoleArn field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetTargets added in v1.10.25

SetTargets sets the Targets field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetTaskArn added in v1.10.25

SetTaskArn sets the TaskArn field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetTaskInvocationParameters added in v1.10.25

SetTaskInvocationParameters sets the TaskInvocationParameters field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetTaskParameters added in v1.10.25

SetTaskParameters sets the TaskParameters field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetWindowId added in v1.10.25

SetWindowId sets the WindowId field's value.

func (*UpdateMaintenanceWindowTaskOutput) SetWindowTaskId added in v1.10.25

SetWindowTaskId sets the WindowTaskId field's value.

func (UpdateMaintenanceWindowTaskOutput) String added in v1.10.25

String returns the string representation

type UpdateManagedInstanceRoleInput added in v1.2.2

type UpdateManagedInstanceRoleInput struct {

	// The IAM role you want to assign or change.
	//
	// IamRole is a required field
	IamRole *string `type:"string" required:"true"`

	// The ID of the managed instance where you want to update the role.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateManagedInstanceRoleInput) GoString added in v1.2.2

GoString returns the string representation

func (*UpdateManagedInstanceRoleInput) SetIamRole added in v1.5.0

SetIamRole sets the IamRole field's value.

func (*UpdateManagedInstanceRoleInput) SetInstanceId added in v1.5.0

SetInstanceId sets the InstanceId field's value.

func (UpdateManagedInstanceRoleInput) String added in v1.2.2

String returns the string representation

func (*UpdateManagedInstanceRoleInput) Validate added in v1.2.2

func (s *UpdateManagedInstanceRoleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateManagedInstanceRoleOutput added in v1.2.2

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

func (UpdateManagedInstanceRoleOutput) GoString added in v1.2.2

GoString returns the string representation

func (UpdateManagedInstanceRoleOutput) String added in v1.2.2

String returns the string representation

type UpdateOpsItemInput added in v1.99.0

type UpdateOpsItemInput struct {

	// Update the information about the OpsItem. Provide enough information so that
	// users reading this OpsItem for the first time understand the issue.
	Description *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of an SNS topic where notifications are sent
	// when this OpsItem is edited or changed.
	Notifications []*OpsItemNotification `type:"list"`

	// 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 action) can view and search on the specified data. Operational data that
	// is not searchable is only viewable by users who have access to the OpsItem
	// (as provided by the GetOpsItem API action).
	//
	// Use the /aws/resources key in OperationalData to specify a related resource
	// in the request. Use the /aws/automations key in OperationalData to associate
	// an Automation runbook with the OpsItem. To view AWS CLI example commands
	// that use these keys, see Creating OpsItems Manually (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems)
	// in the AWS Systems Manager User Guide.
	OperationalData map[string]*OpsItemDataValue `type:"map"`

	// Keys that you want to remove from the OperationalData map.
	OperationalDataToDelete []*string `type:"list"`

	// The ID of the OpsItem.
	//
	// OpsItemId is a required field
	OpsItemId *string `type:"string" required:"true"`

	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int64 `min:"1" type:"integer"`

	// 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 []*RelatedOpsItem `type:"list"`

	// The OpsItem status. Status can be Open, In Progress, or Resolved. For more
	// information, see Editing OpsItem Details (http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html)
	// in the AWS Systems Manager User Guide.
	Status *string `type:"string" enum:"OpsItemStatus"`

	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	Title *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateOpsItemInput) GoString added in v1.99.0

func (s UpdateOpsItemInput) GoString() string

GoString returns the string representation

func (*UpdateOpsItemInput) SetDescription added in v1.99.0

func (s *UpdateOpsItemInput) SetDescription(v string) *UpdateOpsItemInput

SetDescription sets the Description field's value.

func (*UpdateOpsItemInput) SetNotifications added in v1.99.0

func (s *UpdateOpsItemInput) SetNotifications(v []*OpsItemNotification) *UpdateOpsItemInput

SetNotifications sets the Notifications field's value.

func (*UpdateOpsItemInput) SetOperationalData added in v1.99.0

func (s *UpdateOpsItemInput) SetOperationalData(v map[string]*OpsItemDataValue) *UpdateOpsItemInput

SetOperationalData sets the OperationalData field's value.

func (*UpdateOpsItemInput) SetOperationalDataToDelete added in v1.99.0

func (s *UpdateOpsItemInput) SetOperationalDataToDelete(v []*string) *UpdateOpsItemInput

SetOperationalDataToDelete sets the OperationalDataToDelete field's value.

func (*UpdateOpsItemInput) SetOpsItemId added in v1.99.0

func (s *UpdateOpsItemInput) SetOpsItemId(v string) *UpdateOpsItemInput

SetOpsItemId sets the OpsItemId field's value.

func (*UpdateOpsItemInput) SetPriority added in v1.99.0

func (s *UpdateOpsItemInput) SetPriority(v int64) *UpdateOpsItemInput

SetPriority sets the Priority field's value.

func (*UpdateOpsItemInput) SetRelatedOpsItems added in v1.99.0

func (s *UpdateOpsItemInput) SetRelatedOpsItems(v []*RelatedOpsItem) *UpdateOpsItemInput

SetRelatedOpsItems sets the RelatedOpsItems field's value.

func (*UpdateOpsItemInput) SetStatus added in v1.99.0

func (s *UpdateOpsItemInput) SetStatus(v string) *UpdateOpsItemInput

SetStatus sets the Status field's value.

func (*UpdateOpsItemInput) SetTitle added in v1.99.0

SetTitle sets the Title field's value.

func (UpdateOpsItemInput) String added in v1.99.0

func (s UpdateOpsItemInput) String() string

String returns the string representation

func (*UpdateOpsItemInput) Validate added in v1.99.0

func (s *UpdateOpsItemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateOpsItemOutput added in v1.99.0

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

func (UpdateOpsItemOutput) GoString added in v1.99.0

func (s UpdateOpsItemOutput) GoString() string

GoString returns the string representation

func (UpdateOpsItemOutput) String added in v1.99.0

func (s UpdateOpsItemOutput) String() string

String returns the string representation

type UpdatePatchBaselineInput added in v1.6.4

type UpdatePatchBaselineInput struct {

	// A set of rules used to include patches in the baseline.
	ApprovalRules *PatchRuleGroup `type:"structure"`

	// A list of explicitly approved patches for the baseline.
	//
	// For information about accepted formats for lists of approved patches and
	// rejected patches, see Package Name Formats for Approved and Rejected Patch
	// Lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	ApprovedPatches []*string `type:"list"`

	// Assigns a new compliance severity level to an existing patch baseline.
	ApprovedPatchesComplianceLevel *string `type:"string" enum:"PatchComplianceLevel"`

	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool `type:"boolean"`

	// The ID of the patch baseline to update.
	//
	// BaselineId is a required field
	BaselineId *string `min:"20" type:"string" required:"true"`

	// A description of the patch baseline.
	Description *string `min:"1" type:"string"`

	// A set of global filters used to include patches in the baseline.
	GlobalFilters *PatchFilterGroup `type:"structure"`

	// The name of the patch baseline.
	Name *string `min:"3" type:"string"`

	// A list of explicitly rejected patches for the baseline.
	//
	// For information about accepted formats for lists of approved patches and
	// rejected patches, see Package Name Formats for Approved and Rejected Patch
	// Lists (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html)
	// in the AWS Systems Manager User Guide.
	RejectedPatches []*string `type:"list"`

	// The action for Patch Manager to take on patches included in the RejectedPackages
	// list.
	//
	//    * ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed
	//    only if it is a dependency of another package. It is considered compliant
	//    with the patch baseline, and its status is reported as InstalledOther.
	//    This is the default action if no option is specified.
	//
	//    * BLOCK: Packages in the RejectedPatches list, and packages that include
	//    them as dependencies, are not installed under any circumstances. If a
	//    package was installed before it was added to the Rejected patches list,
	//    it is considered non-compliant with the patch baseline, and its status
	//    is reported as InstalledRejected.
	RejectedPatchesAction *string `type:"string" enum:"PatchAction"`

	// If True, then all fields that are required by the CreatePatchBaseline action
	// are also required for this API request. Optional fields that are not specified
	// are set to null.
	Replace *bool `type:"boolean"`

	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*PatchSource `type:"list"`
	// contains filtered or unexported fields
}

func (UpdatePatchBaselineInput) GoString added in v1.6.4

func (s UpdatePatchBaselineInput) GoString() string

GoString returns the string representation

func (*UpdatePatchBaselineInput) SetApprovalRules added in v1.6.4

SetApprovalRules sets the ApprovalRules field's value.

func (*UpdatePatchBaselineInput) SetApprovedPatches added in v1.6.4

func (s *UpdatePatchBaselineInput) SetApprovedPatches(v []*string) *UpdatePatchBaselineInput

SetApprovedPatches sets the ApprovedPatches field's value.

func (*UpdatePatchBaselineInput) SetApprovedPatchesComplianceLevel added in v1.10.8

func (s *UpdatePatchBaselineInput) SetApprovedPatchesComplianceLevel(v string) *UpdatePatchBaselineInput

SetApprovedPatchesComplianceLevel sets the ApprovedPatchesComplianceLevel field's value.

func (*UpdatePatchBaselineInput) SetApprovedPatchesEnableNonSecurity added in v1.12.72

func (s *UpdatePatchBaselineInput) SetApprovedPatchesEnableNonSecurity(v bool) *UpdatePatchBaselineInput

SetApprovedPatchesEnableNonSecurity sets the ApprovedPatchesEnableNonSecurity field's value.

func (*UpdatePatchBaselineInput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*UpdatePatchBaselineInput) SetDescription added in v1.6.4

SetDescription sets the Description field's value.

func (*UpdatePatchBaselineInput) SetGlobalFilters added in v1.6.4

SetGlobalFilters sets the GlobalFilters field's value.

func (*UpdatePatchBaselineInput) SetName added in v1.6.4

SetName sets the Name field's value.

func (*UpdatePatchBaselineInput) SetRejectedPatches added in v1.6.4

func (s *UpdatePatchBaselineInput) SetRejectedPatches(v []*string) *UpdatePatchBaselineInput

SetRejectedPatches sets the RejectedPatches field's value.

func (*UpdatePatchBaselineInput) SetRejectedPatchesAction added in v1.99.0

func (s *UpdatePatchBaselineInput) SetRejectedPatchesAction(v string) *UpdatePatchBaselineInput

SetRejectedPatchesAction sets the RejectedPatchesAction field's value.

func (*UpdatePatchBaselineInput) SetReplace added in v1.12.72

SetReplace sets the Replace field's value.

func (*UpdatePatchBaselineInput) SetSources added in v1.12.72

SetSources sets the Sources field's value.

func (UpdatePatchBaselineInput) String added in v1.6.4

func (s UpdatePatchBaselineInput) String() string

String returns the string representation

func (*UpdatePatchBaselineInput) Validate added in v1.6.4

func (s *UpdatePatchBaselineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePatchBaselineOutput added in v1.6.4

type UpdatePatchBaselineOutput struct {

	// A set of rules used to include patches in the baseline.
	ApprovalRules *PatchRuleGroup `type:"structure"`

	// A list of explicitly approved patches for the baseline.
	ApprovedPatches []*string `type:"list"`

	// The compliance severity level assigned to the patch baseline after the update
	// completed.
	ApprovedPatchesComplianceLevel *string `type:"string" enum:"PatchComplianceLevel"`

	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the instances. The default value is 'false'. Applies
	// to Linux instances only.
	ApprovedPatchesEnableNonSecurity *bool `type:"boolean"`

	// The ID of the deleted patch baseline.
	BaselineId *string `min:"20" type:"string"`

	// The date when the patch baseline was created.
	CreatedDate *time.Time `type:"timestamp"`

	// A description of the Patch Baseline.
	Description *string `min:"1" type:"string"`

	// A set of global filters used to exclude patches from the baseline.
	GlobalFilters *PatchFilterGroup `type:"structure"`

	// The date when the patch baseline was last modified.
	ModifiedDate *time.Time `type:"timestamp"`

	// The name of the patch baseline.
	Name *string `min:"3" type:"string"`

	// The operating system rule used by the updated patch baseline.
	OperatingSystem *string `type:"string" enum:"OperatingSystem"`

	// A list of explicitly rejected patches for the baseline.
	RejectedPatches []*string `type:"list"`

	// 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 *string `type:"string" enum:"PatchAction"`

	// Information about the patches to use to update the instances, including target
	// operating systems and source repositories. Applies to Linux instances only.
	Sources []*PatchSource `type:"list"`
	// contains filtered or unexported fields
}

func (UpdatePatchBaselineOutput) GoString added in v1.6.4

func (s UpdatePatchBaselineOutput) GoString() string

GoString returns the string representation

func (*UpdatePatchBaselineOutput) SetApprovalRules added in v1.6.4

SetApprovalRules sets the ApprovalRules field's value.

func (*UpdatePatchBaselineOutput) SetApprovedPatches added in v1.6.4

func (s *UpdatePatchBaselineOutput) SetApprovedPatches(v []*string) *UpdatePatchBaselineOutput

SetApprovedPatches sets the ApprovedPatches field's value.

func (*UpdatePatchBaselineOutput) SetApprovedPatchesComplianceLevel added in v1.10.8

func (s *UpdatePatchBaselineOutput) SetApprovedPatchesComplianceLevel(v string) *UpdatePatchBaselineOutput

SetApprovedPatchesComplianceLevel sets the ApprovedPatchesComplianceLevel field's value.

func (*UpdatePatchBaselineOutput) SetApprovedPatchesEnableNonSecurity added in v1.12.72

func (s *UpdatePatchBaselineOutput) SetApprovedPatchesEnableNonSecurity(v bool) *UpdatePatchBaselineOutput

SetApprovedPatchesEnableNonSecurity sets the ApprovedPatchesEnableNonSecurity field's value.

func (*UpdatePatchBaselineOutput) SetBaselineId added in v1.6.4

SetBaselineId sets the BaselineId field's value.

func (*UpdatePatchBaselineOutput) SetCreatedDate added in v1.6.4

SetCreatedDate sets the CreatedDate field's value.

func (*UpdatePatchBaselineOutput) SetDescription added in v1.6.4

SetDescription sets the Description field's value.

func (*UpdatePatchBaselineOutput) SetGlobalFilters added in v1.6.4

SetGlobalFilters sets the GlobalFilters field's value.

func (*UpdatePatchBaselineOutput) SetModifiedDate added in v1.6.4

SetModifiedDate sets the ModifiedDate field's value.

func (*UpdatePatchBaselineOutput) SetName added in v1.6.4

SetName sets the Name field's value.

func (*UpdatePatchBaselineOutput) SetOperatingSystem added in v1.10.8

SetOperatingSystem sets the OperatingSystem field's value.

func (*UpdatePatchBaselineOutput) SetRejectedPatches added in v1.6.4

func (s *UpdatePatchBaselineOutput) SetRejectedPatches(v []*string) *UpdatePatchBaselineOutput

SetRejectedPatches sets the RejectedPatches field's value.

func (*UpdatePatchBaselineOutput) SetRejectedPatchesAction added in v1.99.0

func (s *UpdatePatchBaselineOutput) SetRejectedPatchesAction(v string) *UpdatePatchBaselineOutput

SetRejectedPatchesAction sets the RejectedPatchesAction field's value.

func (*UpdatePatchBaselineOutput) SetSources added in v1.12.72

SetSources sets the Sources field's value.

func (UpdatePatchBaselineOutput) String added in v1.6.4

func (s UpdatePatchBaselineOutput) String() string

String returns the string representation

type UpdateServiceSettingInput added in v1.99.0

type UpdateServiceSettingInput struct {

	// The ID of the service setting to update.
	//
	// SettingId is a required field
	SettingId *string `min:"1" type:"string" required:"true"`

	// The new value to specify for the service setting.
	//
	// SettingValue is a required field
	SettingValue *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request body of the UpdateServiceSetting API action.

func (UpdateServiceSettingInput) GoString added in v1.99.0

func (s UpdateServiceSettingInput) GoString() string

GoString returns the string representation

func (*UpdateServiceSettingInput) SetSettingId added in v1.99.0

SetSettingId sets the SettingId field's value.

func (*UpdateServiceSettingInput) SetSettingValue added in v1.99.0

SetSettingValue sets the SettingValue field's value.

func (UpdateServiceSettingInput) String added in v1.99.0

func (s UpdateServiceSettingInput) String() string

String returns the string representation

func (*UpdateServiceSettingInput) Validate added in v1.99.0

func (s *UpdateServiceSettingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServiceSettingOutput added in v1.99.0

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

The result body of the UpdateServiceSetting API action.

func (UpdateServiceSettingOutput) GoString added in v1.99.0

func (s UpdateServiceSettingOutput) GoString() string

GoString returns the string representation

func (UpdateServiceSettingOutput) String added in v1.99.0

String returns the string representation

Directories

Path Synopsis
Package ssmiface provides an interface to enable mocking the Amazon Simple Systems Manager (SSM) service client for testing your code.
Package ssmiface provides an interface to enable mocking the Amazon Simple Systems Manager (SSM) service client for testing your code.

Jump to

Keyboard shortcuts

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