ssm

package
v1.5.11 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package ssm provides a client for Amazon Simple Systems Management Service.

Index

Examples

Constants

View Source 
const (
	// AssociationFilterKeyInstanceId is a AssociationFilterKey enum value
	AssociationFilterKeyInstanceId = "InstanceId"

	// AssociationFilterKeyName is a AssociationFilterKey enum value
	AssociationFilterKeyName = "Name"
)
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 (
	// CommandFilterKeyInvokedAfter is a CommandFilterKey enum value
	CommandFilterKeyInvokedAfter = "InvokedAfter"

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

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

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

	// CommandInvocationStatusCancelling is a CommandInvocationStatus enum value
	CommandInvocationStatusCancelling = "Cancelling"

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

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

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

	// CommandInvocationStatusFailed is a CommandInvocationStatus enum value
	CommandInvocationStatusFailed = "Failed"
)
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"

	// CommandStatusCancelling is a CommandStatus enum value
	CommandStatusCancelling = "Cancelling"

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

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

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

	// CommandStatusFailed is a CommandStatus enum value
	CommandStatusFailed = "Failed"
)
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"
)
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"

	// DocumentStatusDeleting is a DocumentStatus enum value
	DocumentStatusDeleting = "Deleting"
)
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"
)
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 (
	// 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 (
	// DocumentPermissionTypeShare is a DocumentPermissionType enum value
	DocumentPermissionTypeShare = "Share"
)
View Source 
const (
	// ResourceTypeForTaggingManagedInstance is a ResourceTypeForTagging enum value
	ResourceTypeForTaggingManagedInstance = "ManagedInstance"
)
View Source 
const ServiceName = "ssm"

A ServiceName is the name of the service the client will make API calls to.

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 SSM when you submitted the activation.
	ActivationId *string `type:"string"`

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

	// 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" timestampFormat:"unix"`

	// 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"`
	// 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) 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.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// Specifies the type of resource you are tagging.
	//
	// 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.
	//
	// 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 

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

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 

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

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 of the instance.
	InstanceId *string `type:"string"`

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

Describes an association of an SSM document and an instance.

func (Association) GoString added in v0.6.5 

func (s Association) GoString() string

GoString returns the string representation

func (*Association) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId 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) String added in v0.6.5 

func (s Association) String() string

String returns the string representation

type AssociationDescription 

type AssociationDescription struct {

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

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

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

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

	// The association status.
	Status *AssociationStatus `type:"structure"`
	// 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) SetDate added in v1.5.0 

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

SetDate sets the Date field's value.

func (*AssociationDescription) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (*AssociationDescription) SetName added in v1.5.0 

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

SetName sets the Name 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) SetStatus added in v1.5.0 

func (s *AssociationDescription) SetStatus(v *AssociationStatus) *AssociationDescription

SetStatus sets the Status field's value.

func (AssociationDescription) String added in v0.6.5 

func (s AssociationDescription) String() string

String returns the string representation

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 

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

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 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" timestampFormat:"unix" required:"true"`

	// The reason for the status.
	//
	// Message is a required field
	Message *string `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 

func (s *AssociationStatus) SetDate(v time.Time) *AssociationStatus

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 

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

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 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 `min:"1" 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 Command added in v0.9.17 

type Command struct {

	// 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 name of the SSM document requested for execution.
	DocumentName *string `type:"string"`

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

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

	// 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"`

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

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

	// The IAM service role that SSM 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"`
	// 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) 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) SetDocumentName added in v1.5.0 

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

SetDocumentName sets the DocumentName 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) 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) 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) 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. For example, requested date and time.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true" enum:"CommandFilterKey"`

	// The filter value. For example: June 30, 2015.
	//
	// 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 {

	// 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 instance ID in which this invocation was requested.
	InstanceId *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" timestampFormat:"unix"`

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

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

	// 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 executes 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 executed.

func (CommandInvocation) GoString added in v0.9.17 

func (s CommandInvocation) GoString() string

GoString returns the string representation

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) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId 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) SetStatus added in v1.5.0 

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

SetStatus sets the Status 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.
	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"`

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

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

	// The time the plugin started executing.
	ResponseStartDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The status of this plugin. You can execute a document with multiple plugins.
	Status *string `type:"string" enum:"CommandPluginStatus"`
	// 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) 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) SetStatus added in v1.5.0 

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

SetStatus sets the Status field's value.

func (CommandPlugin) String added in v0.9.17 

func (s CommandPlugin) 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.
	DefaultInstanceName *string `type:"string"`

	// A user-defined description of the resource that you want to register with
	// Amazon EC2.
	Description *string `type:"string"`

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

	// 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"`
	// 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 

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

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) 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 `locationNameList:"entries" 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 

func (s *CreateAssociationBatchInput) SetEntries(v []*CreateAssociationBatchRequestEntry) *CreateAssociationBatchInput

SetEntries sets the Entries field's value.

func (CreateAssociationBatchInput) String added in v0.6.5 

func (s CreateAssociationBatchInput) String() string

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 `locationNameList:"FailedCreateAssociationEntry" type:"list"`

	// Information about the associations that succeeded.
	Successful []*AssociationDescription `locationNameList:"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 

func (s *CreateAssociationBatchOutput) SetFailed(v []*FailedCreateAssociation) *CreateAssociationBatchOutput

SetFailed sets the Failed field's value.

func (*CreateAssociationBatchOutput) SetSuccessful added in v1.5.0 

func (s *CreateAssociationBatchOutput) SetSuccessful(v []*AssociationDescription) *CreateAssociationBatchOutput

SetSuccessful sets the Successful field's value.

func (CreateAssociationBatchOutput) String added in v0.6.5 

func (s CreateAssociationBatchOutput) String() string

String returns the string representation

type CreateAssociationBatchRequestEntry 

type CreateAssociationBatchRequestEntry struct {

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

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

	// A description of the parameters for a document.
	Parameters map[string][]*string `type:"map"`
	// contains filtered or unexported fields
}

Describes the association of an SSM document and an instance.

func (CreateAssociationBatchRequestEntry) GoString added in v0.6.5 

func (s CreateAssociationBatchRequestEntry) GoString() string

GoString returns the string representation

func (*CreateAssociationBatchRequestEntry) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (*CreateAssociationBatchRequestEntry) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*CreateAssociationBatchRequestEntry) SetParameters added in v1.5.0 

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

SetParameters sets the Parameters field's value.

func (CreateAssociationBatchRequestEntry) String added in v0.6.5 

func (s CreateAssociationBatchRequestEntry) String() string

String returns the string representation

type CreateAssociationInput 

type CreateAssociationInput struct {

	// The instance ID.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The name of the SSM document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The parameters for the documents runtime configuration.
	Parameters map[string][]*string `type:"map"`
	// 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) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (*CreateAssociationInput) SetName added in v1.5.0 

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

SetName sets the Name 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) 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 

func (s *CreateAssociationOutput) SetAssociationDescription(v *AssociationDescription) *CreateAssociationOutput

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 valid JSON string.
	//
	// Content is a required field
	Content *string `min:"1" type:"string" required:"true"`

	// A name for the SSM document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// 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) SetContent added in v1.5.0 

func (s *CreateDocumentInput) SetContent(v string) *CreateDocumentInput

SetContent sets the Content field's value.

func (*CreateDocumentInput) SetName added in v1.5.0 

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

SetName sets the Name 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 SSM 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 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 ID of the instance.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The name of the SSM document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// 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) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (*DeleteAssociationInput) SetName added in v1.5.0 

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

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

func (*DeleteAssociationInput) Validate added in v1.1.21 

func (s *DeleteAssociationInput) Validate() error

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

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 name of the SSM document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// 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) SetName added in v1.5.0 

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

SetName sets the Name 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 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 

func (s DeregisterManagedInstanceInput) GoString() string

GoString returns the string representation

func (*DeregisterManagedInstanceInput) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (DeregisterManagedInstanceInput) String added in v1.2.2 

func (s DeregisterManagedInstanceInput) String() string

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 

func (s DeregisterManagedInstanceOutput) GoString() string

GoString returns the string representation

func (DeregisterManagedInstanceOutput) String added in v1.2.2 

func (s DeregisterManagedInstanceOutput) String() string

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 

func (s *DescribeActivationsFilter) SetFilterKey(v string) *DescribeActivationsFilter

SetFilterKey sets the FilterKey field's value.

func (*DescribeActivationsFilter) SetFilterValues added in v1.5.0 

func (s *DescribeActivationsFilter) SetFilterValues(v []*string) *DescribeActivationsFilter

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 

func (s *DescribeActivationsInput) SetFilters(v []*DescribeActivationsFilter) *DescribeActivationsInput

SetFilters sets the Filters field's value.

func (*DescribeActivationsInput) SetMaxResults added in v1.5.0 

func (s *DescribeActivationsInput) SetMaxResults(v int64) *DescribeActivationsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeActivationsInput) SetNextToken added in v1.5.0 

func (s *DescribeActivationsInput) SetNextToken(v string) *DescribeActivationsInput

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 

func (s *DescribeActivationsOutput) SetActivationList(v []*Activation) *DescribeActivationsOutput

SetActivationList sets the ActivationList field's value.

func (*DescribeActivationsOutput) SetNextToken added in v1.5.0 

func (s *DescribeActivationsOutput) SetNextToken(v string) *DescribeActivationsOutput

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 DescribeAssociationInput 

type DescribeAssociationInput struct {

	// The instance ID.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The name of the SSM document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// 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) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (*DescribeAssociationInput) SetName added in v1.5.0 

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

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

func (*DescribeAssociationInput) Validate added in v1.1.21 

func (s *DescribeAssociationInput) Validate() error

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

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 

func (s *DescribeAssociationOutput) SetAssociationDescription(v *AssociationDescription) *DescribeAssociationOutput

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 DescribeDocumentInput 

type DescribeDocumentInput struct {

	// The name of the SSM document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// 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) SetName added in v1.5.0 

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

SetName sets the Name 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 SSM 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 

func (s *DescribeDocumentOutput) SetDocument(v *DocumentDescription) *DescribeDocumentOutput

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 

func (s DescribeDocumentPermissionInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentPermissionInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*DescribeDocumentPermissionInput) SetPermissionType added in v1.5.0 

func (s *DescribeDocumentPermissionInput) SetPermissionType(v string) *DescribeDocumentPermissionInput

SetPermissionType sets the PermissionType field's value.

func (DescribeDocumentPermissionInput) String added in v1.1.26 

func (s DescribeDocumentPermissionInput) String() string

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 `locationNameList:"AccountId" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeDocumentPermissionOutput) GoString added in v1.1.26 

func (s DescribeDocumentPermissionOutput) GoString() string

GoString returns the string representation

func (*DescribeDocumentPermissionOutput) SetAccountIds added in v1.5.0 

func (s *DescribeDocumentPermissionOutput) SetAccountIds(v []*string) *DescribeDocumentPermissionOutput

SetAccountIds sets the AccountIds field's value.

func (DescribeDocumentPermissionOutput) String added in v1.1.26 

func (s DescribeDocumentPermissionOutput) String() string

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.
	InstanceInformationFilterList []*InstanceInformationFilter `locationNameList:"InstanceInformationFilter" 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:"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 

func (s DescribeInstanceInformationInput) GoString() string

GoString returns the string representation

func (*DescribeInstanceInformationInput) SetInstanceInformationFilterList added in v1.5.0 

func (s *DescribeInstanceInformationInput) SetInstanceInformationFilterList(v []*InstanceInformationFilter) *DescribeInstanceInformationInput

SetInstanceInformationFilterList sets the InstanceInformationFilterList field's value.

func (*DescribeInstanceInformationInput) SetMaxResults added in v1.5.0 

func (s *DescribeInstanceInformationInput) SetMaxResults(v int64) *DescribeInstanceInformationInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeInstanceInformationInput) SetNextToken added in v1.5.0 

func (s *DescribeInstanceInformationInput) SetNextToken(v string) *DescribeInstanceInformationInput

SetNextToken sets the NextToken field's value.

func (DescribeInstanceInformationInput) String added in v0.9.17 

func (s DescribeInstanceInformationInput) String() string

String returns the string representation

func (*DescribeInstanceInformationInput) Validate added in v1.1.21 

func (s *DescribeInstanceInformationInput) Validate() error

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 `locationNameList:"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 

func (s DescribeInstanceInformationOutput) GoString() string

GoString returns the string representation

func (*DescribeInstanceInformationOutput) SetInstanceInformationList added in v1.5.0 

func (s *DescribeInstanceInformationOutput) SetInstanceInformationList(v []*InstanceInformation) *DescribeInstanceInformationOutput

SetInstanceInformationList sets the InstanceInformationList field's value.

func (*DescribeInstanceInformationOutput) SetNextToken added in v1.5.0 

func (s *DescribeInstanceInformationOutput) SetNextToken(v string) *DescribeInstanceInformationOutput

SetNextToken sets the NextToken field's value.

func (DescribeInstanceInformationOutput) String added in v0.9.17 

func (s DescribeInstanceInformationOutput) String() string

String returns the string representation

type DocumentDescription 

type DocumentDescription struct {

	// The date when the SSM document was created.
	CreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`

	// A description of the document.
	Description *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"`

	// Sha256 or Sha1.
	//
	// Sha1 hashes have been deprecated.
	HashType *string `type:"string" enum:"DocumentHashType"`

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

	// The AWS user account of the person who created the document.
	Owner *string `type:"string"`

	// A description of the parameters for a document.
	Parameters []*DocumentParameter `locationNameList:"DocumentParameter" type:"list"`

	// The list of OS platforms compatible with this SSM document.
	PlatformTypes []*string `locationNameList:"PlatformType" type:"list"`

	// The SHA1 hash of the document, which you can use for verification purposes.
	Sha1 *string `type:"string"`

	// The status of the SSM document.
	Status *string `type:"string" enum:"DocumentStatus"`
	// contains filtered or unexported fields
}

Describes an SSM document.

func (DocumentDescription) GoString added in v0.6.5 

func (s DocumentDescription) GoString() string

GoString returns the string representation

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) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*DocumentDescription) SetHash added in v1.5.0 

func (s *DocumentDescription) SetHash(v string) *DocumentDescription

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) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*DocumentDescription) SetOwner added in v1.5.0 

func (s *DocumentDescription) SetOwner(v string) *DocumentDescription

SetOwner sets the Owner field's value.

func (*DocumentDescription) SetParameters added in v1.5.0 

func (s *DocumentDescription) SetParameters(v []*DocumentParameter) *DocumentDescription

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) SetSha1 added in v1.5.0 

func (s *DocumentDescription) SetSha1(v string) *DocumentDescription

SetSha1 sets the Sha1 field's value.

func (*DocumentDescription) SetStatus added in v1.5.0 

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

SetStatus sets the Status 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 name of the SSM document.
	Name *string `type:"string"`

	// The AWS user account of the person who created the document.
	Owner *string `type:"string"`

	// The operating system platform.
	PlatformTypes []*string `locationNameList:"PlatformType" type:"list"`
	// contains filtered or unexported fields
}

Describes the name of an SSM document.

func (DocumentIdentifier) GoString added in v0.6.5 

func (s DocumentIdentifier) GoString() string

GoString returns the string representation

func (*DocumentIdentifier) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*DocumentIdentifier) SetOwner added in v1.5.0 

func (s *DocumentIdentifier) SetOwner(v string) *DocumentIdentifier

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) String added in v0.6.5 

func (s DocumentIdentifier) String() string

String returns the string representation

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 the SSM document that execute 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 

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

SetName sets the Name field's value.

func (*DocumentParameter) SetType added in v1.5.0 

func (s *DocumentParameter) SetType(v string) *DocumentParameter

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

func (s *FailedCreateAssociation) SetEntry(v *CreateAssociationBatchRequestEntry) *FailedCreateAssociation

SetEntry sets the Entry field's value.

func (*FailedCreateAssociation) SetFault added in v1.5.0 

func (s *FailedCreateAssociation) SetFault(v string) *FailedCreateAssociation

SetFault sets the Fault field's value.

func (*FailedCreateAssociation) SetMessage added in v1.5.0 

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

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 GetDocumentInput 

type GetDocumentInput struct {

	// The name of the SSM document.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// 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) SetName added in v1.5.0 

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

SetName sets the Name 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 {

	// The contents of the SSM document.
	Content *string `min:"1" type:"string"`

	// The name of the SSM document.
	Name *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) SetContent added in v1.5.0 

func (s *GetDocumentOutput) SetContent(v string) *GetDocumentOutput

SetContent sets the Content field's value.

func (*GetDocumentOutput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (GetDocumentOutput) String added in v0.6.5 

func (s GetDocumentOutput) String() string

String returns the string representation

type InstanceInformation added in v0.9.17 

type InstanceInformation struct {

	// The activation ID created by SSM when the server or VM was registered.
	ActivationId *string `type:"string"`

	// The version of the SSM agent running on your Linux instance.
	AgentVersion *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 EC2 instances
	// or managed instances.
	IamRole *string `type:"string"`

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

	// Indicates whether latest version of the SSM agent is running on your instance.
	IsLatestVersion *bool `type:"boolean"`

	// The date and time when agent last pinged SSM service.
	LastPingDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The name of the managed instance.
	Name *string `type:"string"`

	// Connection status of the 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" timestampFormat:"unix"`

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

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

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) SetLastPingDateTime added in v1.5.0 

func (s *InstanceInformation) SetLastPingDateTime(v time.Time) *InstanceInformation

SetLastPingDateTime sets the LastPingDateTime field's value.

func (*InstanceInformation) SetName added in v1.5.0 

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

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" locationNameList:"InstanceInformationFilterValue" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Describes a filter for a specific list of instances.

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 

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

SetKey sets the Key field's value.

func (*InstanceInformationFilter) SetValueSet added in v1.5.0 

func (s *InstanceInformationFilter) SetValueSet(v []*string) *InstanceInformationFilter

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 ListAssociationsInput 

type ListAssociationsInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	//
	// AssociationFilterList is a required field
	AssociationFilterList []*AssociationFilter `locationNameList:"AssociationFilter" min:"1" type:"list" 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 (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 

func (s *ListAssociationsInput) SetNextToken(v string) *ListAssociationsInput

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 `locationNameList:"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 

func (s *ListAssociationsOutput) SetNextToken(v string) *ListAssociationsOutput

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 

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

SetCommandId sets the CommandId field's value.

func (*ListCommandInvocationsInput) SetDetails added in v1.5.0 

func (s *ListCommandInvocationsInput) SetDetails(v bool) *ListCommandInvocationsInput

SetDetails sets the Details field's value.

func (*ListCommandInvocationsInput) SetFilters added in v1.5.0 

func (s *ListCommandInvocationsInput) SetFilters(v []*CommandFilter) *ListCommandInvocationsInput

SetFilters sets the Filters field's value.

func (*ListCommandInvocationsInput) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (*ListCommandInvocationsInput) SetMaxResults added in v1.5.0 

func (s *ListCommandInvocationsInput) SetMaxResults(v int64) *ListCommandInvocationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCommandInvocationsInput) SetNextToken added in v1.5.0 

func (s *ListCommandInvocationsInput) SetNextToken(v string) *ListCommandInvocationsInput

SetNextToken sets the NextToken field's value.

func (ListCommandInvocationsInput) String added in v0.9.17 

func (s ListCommandInvocationsInput) String() string

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 

func (s *ListCommandInvocationsOutput) SetCommandInvocations(v []*CommandInvocation) *ListCommandInvocationsOutput

SetCommandInvocations sets the CommandInvocations field's value.

func (*ListCommandInvocationsOutput) SetNextToken added in v1.5.0 

func (s *ListCommandInvocationsOutput) SetNextToken(v string) *ListCommandInvocationsOutput

SetNextToken sets the NextToken field's value.

func (ListCommandInvocationsOutput) String added in v0.9.17 

func (s ListCommandInvocationsOutput) String() string

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 ListDocumentsInput 

type ListDocumentsInput struct {

	// One or more filters. Use a filter to return a more specific list of results.
	DocumentFilterList []*DocumentFilter `locationNameList:"DocumentFilter" 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 (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) 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 SSM documents.
	DocumentIdentifiers []*DocumentIdentifier `locationNameList:"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 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 

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

SetResourceId sets the ResourceId field's value.

func (*ListTagsForResourceInput) SetResourceType added in v1.5.0 

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

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 

func (s *ListTagsForResourceOutput) SetTagList(v []*Tag) *ListTagsForResourceOutput

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 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 `locationNameList:"AccountId" 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 `locationNameList:"AccountId" 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 

func (s ModifyDocumentPermissionInput) GoString() string

GoString returns the string representation

func (*ModifyDocumentPermissionInput) SetAccountIdsToAdd added in v1.5.0 

func (s *ModifyDocumentPermissionInput) SetAccountIdsToAdd(v []*string) *ModifyDocumentPermissionInput

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 

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

SetName sets the Name field's value.

func (*ModifyDocumentPermissionInput) SetPermissionType added in v1.5.0 

func (s *ModifyDocumentPermissionInput) SetPermissionType(v string) *ModifyDocumentPermissionInput

SetPermissionType sets the PermissionType field's value.

func (ModifyDocumentPermissionInput) String added in v1.1.26 

func (s ModifyDocumentPermissionInput) String() string

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 

func (s ModifyDocumentPermissionOutput) GoString() string

GoString returns the string representation

func (ModifyDocumentPermissionOutput) String added in v1.1.26 

func (s ModifyDocumentPermissionOutput) String() string

String returns the string representation

type NotificationConfig added in v1.2.6 

type NotificationConfig struct {

	// An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic.
	// SSM 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 Monitoring Commands (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-commands.html)
	// in the Amazon Elastic Compute Cloud 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 RemoveTagsFromResourceInput added in v1.2.2 

type RemoveTagsFromResourceInput struct {

	// The resource ID for which you want to remove tags.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// The type of resource of which you want to remove a tag.
	//
	// 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 

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

SetResourceId sets the ResourceId field's value.

func (*RemoveTagsFromResourceInput) SetResourceType added in v1.5.0 

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

SetResourceType sets the ResourceType field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys added in v1.5.0 

func (s *RemoveTagsFromResourceInput) SetTagKeys(v []*string) *RemoveTagsFromResourceInput

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String added in v1.2.2 

func (s RemoveTagsFromResourceInput) String() string

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 

func (s RemoveTagsFromResourceOutput) String() string

String returns the string representation

type SSM 

type SSM struct {
	*client.Client
}

Amazon EC2 Simple Systems Manager (SSM) enables you to remotely manage the configuration of your Amazon EC2 instances, virtual machines (VMs), or servers in your on-premises environment or in an environment provided by other cloud providers using scripts, commands, or the Amazon EC2 console. SSM includes an on-demand solution called Amazon EC2 Run Command and a lightweight instance configuration solution called SSM Config.

This references is intended to be used with the EC2 Run Command User Guide for Linux (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/execute-remote-commands.html) or Windows (http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/execute-remote-commands.html).

You must register your on-premises servers and VMs through an activation process before you can configure them using Run Command. Registered servers and VMs are called managed instances. For more information, see Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Linux (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/managed-instances.html) or Setting Up Run Command On Managed Instances (On-Premises Servers and VMs) on Windows (http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/managed-instances.html).

Run Command

Run Command provides an on-demand experience for executing commands. You can use pre-defined SSM documents to perform the actions listed later in this section, or you can create your own documents. With these documents, you can remotely configure your instances by sending commands using the Commands page in the Amazon EC2 console (http://console.aws.amazon.com/ec2/), AWS Tools for Windows PowerShell (http://docs.aws.amazon.com/powershell/latest/reference/items/Amazon_Simple_Systems_Management_cmdlets.html), the AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/ssm/index.html), or AWS SDKs.

Run Command reports the status of the command execution for each instance targeted by a command. You can also audit the command execution to understand who executed commands, when, and what changes were made. By switching between different SSM documents, you can quickly configure your instances with different types of commands. To get started with Run Command, verify that your environment meets the prerequisites for remotely running commands on EC2 instances (Linux (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/remote-commands-prereq.html) or Windows (http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/remote-commands-prereq.html)).

SSM Config

SSM Config is a lightweight instance configuration solution. SSM Config is currently only available for Windows instances. With SSM Config, you can specify a setup configuration for your instances. SSM Config is similar to EC2 User Data, which is another way of running one-time scripts or applying settings during instance launch. SSM Config is an extension of this capability. Using SSM documents, you can specify which actions the system should perform on your instances, including which applications to install, which AWS Directory Service directory to join, which Microsoft PowerShell modules to install, etc. If an instance is missing one or more of these configurations, the system makes those changes. By default, the system checks every five minutes to see if there is a new configuration to apply as defined in a new SSM document. If so, the system updates the instances accordingly. In this way, you can remotely maintain a consistent configuration baseline on your instances. SSM Config is available using the AWS CLI or the AWS Tools for Windows PowerShell. For more information, see Managing Windows Instance Configuration (http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-configuration-manage.html).

SSM Config and Run Command include the following pre-defined documents.

Linux

AWS-RunShellScript to run shell scripts

  • AWS-UpdateSSMAgent to update the Amazon SSM agent

Windows

  • AWS-JoinDirectoryServiceDomain to join an AWS Directory

  • AWS-RunPowerShellScript to run PowerShell commands or scripts

  • AWS-UpdateEC2Config to update the EC2Config service

  • AWS-ConfigureWindowsUpdate to configure Windows Update settings

  • AWS-InstallApplication to install, repair, or uninstall software using an MSI package

  • AWS-InstallPowerShellModule to install PowerShell modules

  • AWS-ConfigureCloudWatch to configure Amazon CloudWatch Logs to monitor applications and systems

  • AWS-ListWindowsInventory to collect information about an EC2 instance running in Windows.

  • AWS-FindWindowsUpdates to scan an instance and determines which updates are missing.

  • AWS-InstallMissingWindowsUpdates to install missing updates on your EC2 instance.

  • AWS-InstallSpecificWindowsUpdates to install one or more specific updates.

The commands or scripts specified in SSM documents run with administrative 

privilege on your instances because the Amazon SSM agent runs as root
on Linux and the EC2Config service runs in the Local System account on
Windows. If a user has permission to execute any of the pre-defined SSM
documents (any document that begins with AWS-*) then that user also has
administrator access to the instance. Delegate access to Run Command and
SSM Config judiciously. This becomes extremely important if you create
your own SSM documents. Amazon Web Services does not provide guidance
about how to create secure SSM documents. You create SSM documents and
delegate access to Run Command at your own risk. As a security best practice,
we recommend that you assign access to "AWS-*" documents, especially the
AWS-RunShellScript document on Linux and the AWS-RunPowerShellScript document
on Windows, to trusted administrators only. You can create SSM documents
for specific tasks and delegate access to non-administrators.

For information about creating and sharing SSM documents, see the following 

topics in the SSM User Guide:

* Creating SSM Documents (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-ssm-doc.html)
and    * Sharing SSM Documents (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssm-sharing.html)
(Linux)

* Creating SSM Documents (http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/create-ssm-doc.html)
and    * Sharing SSM Documents (http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ssm-sharing.html)
(Windows)

The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client'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 Management Service.

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances. Tags enable you to categorize your managed instances 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 10 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 Management Service's API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • InvalidResourceType The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.

  • InvalidResourceId The resource ID is not valid. Verify that you entered the correct ID and try again.

  • InternalServerError An error occurred on the server side.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.AddTagsToResourceInput{
		ResourceId:   aws.String("ResourceId"),             // Required
		ResourceType: aws.String("ResourceTypeForTagging"), // Required
		Tags: []*ssm.Tag{ // Required
			{ // Required
				Key:   aws.String("TagKey"),   // Required
				Value: aws.String("TagValue"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.AddTagsToResource(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See AddTagsToResource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddTagsToResource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) CancelCommand added in v0.9.17 

func (c *SSM) CancelCommand(input *CancelCommandInput) (*CancelCommandOutput, error)

* InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

* DuplicateInstanceId You cannot specify an instance ID in more than one association.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.CancelCommandInput{
		CommandId: aws.String("CommandId"), // Required
		InstanceIds: []*string{
			aws.String("InstanceId"), // Required
			// More values...
		},
	}
	resp, err := svc.CancelCommand(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See CancelCommand for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CancelCommand method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) CreateActivation added in v1.2.2 

func (c *SSM) CreateActivation(input *CreateActivationInput) (*CreateActivationOutput, error)

CreateActivation API operation for Amazon Simple Systems Management Service.

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 Managed Instances (Linux) (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/managed-instances.html) or Setting Up Managed Instances (Windows) (http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/managed-instances.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 Management Service's API operation CreateActivation for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.
Example 
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.CreateActivationInput{
		IamRole:             aws.String("IamRole"), // Required
		DefaultInstanceName: aws.String("DefaultInstanceName"),
		Description:         aws.String("ActivationDescription"),
		ExpirationDate:      aws.Time(time.Now()),
		RegistrationLimit:   aws.Int64(1),
	}
	resp, err := svc.CreateActivation(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateActivation for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateActivation method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) CreateAssociation 

func (c *SSM) CreateAssociation(input *CreateAssociationInput) (*CreateAssociationOutput, error)

CreateAssociation API operation for Amazon Simple Systems Management Service.

Associates the specified SSM document with the specified instance.

When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) 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 throws 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 Management Service's API operation CreateAssociation for usage and error information.

Returned Error Codes:

  • AssociationAlreadyExists The specified association already exists.

  • AssociationLimitExceeded You can have at most 2,000 active associations.

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • UnsupportedPlatformType The document does not support the platform type of the given instance ID(s). For example, you sent an SSM document for a Windows instance to a Linux instance.

  • InvalidParameters You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.CreateAssociationInput{
		InstanceId: aws.String("InstanceId"),   // Required
		Name:       aws.String("DocumentName"), // Required
		Parameters: map[string][]*string{
			"Key": { // Required
				aws.String("ParameterValue"), // Required
				// More values...
			},
			// More values...
		},
	}
	resp, err := svc.CreateAssociation(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) CreateAssociationBatch 

func (c *SSM) CreateAssociationBatch(input *CreateAssociationBatchInput) (*CreateAssociationBatchOutput, error)

CreateAssociationBatch API operation for Amazon Simple Systems Management Service.

Associates the specified SSM document with the specified instances.

When you associate an SSM document with an instance, the configuration agent on the instance (SSM agent for Linux and EC2Config service for Windows) 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 throws 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 Management Service's API operation CreateAssociationBatch for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • InvalidParameters You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.

  • DuplicateInstanceId You cannot specify an instance ID in more than one association.

  • AssociationLimitExceeded You can have at most 2,000 active associations.

  • UnsupportedPlatformType The document does not support the platform type of the given instance ID(s). For example, you sent an SSM document for a Windows instance to a Linux instance.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.CreateAssociationBatchInput{
		Entries: []*ssm.CreateAssociationBatchRequestEntry{ // Required
			{ // Required
				InstanceId: aws.String("InstanceId"),
				Name:       aws.String("DocumentName"),
				Parameters: map[string][]*string{
					"Key": { // Required
						aws.String("ParameterValue"), // Required
						// More values...
					},
					// More values...
				},
			},
			// More values...
		},
	}
	resp, err := svc.CreateAssociationBatch(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateAssociationBatch for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAssociationBatch method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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 can be used to capture response data after the request's "Send" method is called.

See CreateAssociation for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateAssociation method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) CreateDocument 

func (c *SSM) CreateDocument(input *CreateDocumentInput) (*CreateDocumentOutput, error)

CreateDocument API operation for Amazon Simple Systems Management Service.

Creates an SSM document.

After you create an SSM 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 Management Service's API operation CreateDocument for usage and error information.

Returned Error Codes:

  • DocumentAlreadyExists The specified SSM document already exists.

  • MaxDocumentSizeExceeded The size limit of an SSM document is 64 KB.

  • InternalServerError An error occurred on the server side.

  • InvalidDocumentContent The content for the SSM document is not valid.

  • DocumentLimitExceeded You can have at most 200 active SSM documents.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.CreateDocumentInput{
		Content: aws.String("DocumentContent"), // Required
		Name:    aws.String("DocumentName"),    // Required
	}
	resp, err := svc.CreateDocument(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateDocument for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDocument method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DeleteActivation added in v1.2.2 

func (c *SSM) DeleteActivation(input *DeleteActivationInput) (*DeleteActivationOutput, error)

DeleteActivation API operation for Amazon Simple Systems Management Service.

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 Management Service's API operation DeleteActivation for usage and error information.

Returned Error Codes:

  • InvalidActivationId The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.

  • InvalidActivation The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.

  • InternalServerError An error occurred on the server side.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DeleteActivationInput{
		ActivationId: aws.String("ActivationId"), // Required
	}
	resp, err := svc.DeleteActivation(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteActivation for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteActivation method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DeleteAssociation 

func (c *SSM) DeleteAssociation(input *DeleteAssociationInput) (*DeleteAssociationOutput, error)

DeleteAssociation API operation for Amazon Simple Systems Management Service.

Disassociates the specified SSM document from the specified instance.

When you disassociate an SSM 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 Management Service's API operation DeleteAssociation for usage and error information.

Returned Error Codes:

  • AssociationDoesNotExist The specified association does not exist.

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • TooManyUpdates There are concurrent updates for a resource that supports one update at a time.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DeleteAssociationInput{
		InstanceId: aws.String("InstanceId"),   // Required
		Name:       aws.String("DocumentName"), // Required
	}
	resp, err := svc.DeleteAssociation(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteAssociation for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteAssociation method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DeleteDocument 

func (c *SSM) DeleteDocument(input *DeleteDocumentInput) (*DeleteDocumentOutput, error)

DeleteDocument API operation for Amazon Simple Systems Management Service.

Deletes the SSM document and all instance associations to the document.

Before you delete the SSM 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 Management Service's API operation DeleteDocument for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

  • InvalidDocumentOperation You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

  • AssociatedInstances You must disassociate an SSM document from all instances before you can delete it.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DeleteDocumentInput{
		Name: aws.String("DocumentName"), // Required
	}
	resp, err := svc.DeleteDocument(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteDocument for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDocument method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DeregisterManagedInstance added in v1.2.2 

func (c *SSM) DeregisterManagedInstance(input *DeregisterManagedInstanceInput) (*DeregisterManagedInstanceOutput, error)

DeregisterManagedInstance API operation for Amazon Simple Systems Management Service.

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 the 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 Management Service's API operation DeregisterManagedInstance for usage and error information.

Returned Error Codes:

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • InternalServerError An error occurred on the server side.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DeregisterManagedInstanceInput{
		InstanceId: aws.String("ManagedInstanceId"), // Required
	}
	resp, err := svc.DeregisterManagedInstance(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeregisterManagedInstance for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeregisterManagedInstance method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DescribeActivations added in v1.2.2 

func (c *SSM) DescribeActivations(input *DescribeActivationsInput) (*DescribeActivationsOutput, error)

DescribeActivations API operation for Amazon Simple Systems Management Service.

Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.

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 Management Service's API operation DescribeActivations for usage and error information.

Returned Error Codes:

  • InvalidFilter The filter name is not valid. Verify the you entered the correct name and try again.

  • InvalidNextToken The specified token is not valid.

  • InternalServerError An error occurred on the server side.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DescribeActivationsInput{
		Filters: []*ssm.DescribeActivationsFilter{
			{ // Required
				FilterKey: aws.String("DescribeActivationsFilterKeys"),
				FilterValues: []*string{
					aws.String("String"), // Required
					// More values...
				},
			},
			// More values...
		},
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.DescribeActivations(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) DescribeActivationsPages added in v1.2.2 

func (c *SSM) DescribeActivationsPages(input *DescribeActivationsInput, fn func(p *DescribeActivationsOutput, lastPage bool) (shouldContinue 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 *DescribeActivationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

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 can be used to capture response data after the request's "Send" method is called.

See DescribeActivations for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeActivations method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DescribeAssociation 

func (c *SSM) DescribeAssociation(input *DescribeAssociationInput) (*DescribeAssociationOutput, error)

DescribeAssociation API operation for Amazon Simple Systems Management Service.

Describes the associations for the specified SSM 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 Management Service's API operation DescribeAssociation for usage and error information.

Returned Error Codes:

  • AssociationDoesNotExist The specified association does not exist.

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DescribeAssociationInput{
		InstanceId: aws.String("InstanceId"),   // Required
		Name:       aws.String("DocumentName"), // Required
	}
	resp, err := svc.DescribeAssociation(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DescribeAssociation for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAssociation method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DescribeDocument 

func (c *SSM) DescribeDocument(input *DescribeDocumentInput) (*DescribeDocumentOutput, error)

DescribeDocument API operation for Amazon Simple Systems Management Service.

Describes the specified 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 Management Service's API operation DescribeDocument for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DescribeDocumentInput{
		Name: aws.String("DocumentARN"), // Required
	}
	resp, err := svc.DescribeDocument(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) DescribeDocumentPermission added in v1.1.26 

func (c *SSM) DescribeDocumentPermission(input *DescribeDocumentPermissionInput) (*DescribeDocumentPermissionOutput, error)

DescribeDocumentPermission API operation for Amazon Simple Systems Management Service.

Describes the permissions for an SSM document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user’s 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 Management Service's API operation DescribeDocumentPermission for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

  • InvalidPermissionType The permission type is not supported. Share is the only supported permission type.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DescribeDocumentPermissionInput{
		Name:           aws.String("DocumentName"),           // Required
		PermissionType: aws.String("DocumentPermissionType"), // Required
	}
	resp, err := svc.DescribeDocumentPermission(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DescribeDocumentPermission for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeDocumentPermission method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

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 can be used to capture response data after the request's "Send" method is called.

See DescribeDocument for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeDocument method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) DescribeInstanceInformation added in v0.9.17 

func (c *SSM) DescribeInstanceInformation(input *DescribeInstanceInformationInput) (*DescribeInstanceInformationOutput, error)

DescribeInstanceInformation API operation for Amazon Simple Systems Management Service.

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.

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 Management Service's API operation DescribeInstanceInformation for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • InvalidNextToken The specified token is not valid.

  • InvalidInstanceInformationFilterValue The specified filter value is not valid.

  • InvalidFilterKey The specified key is not valid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.DescribeInstanceInformationInput{
		InstanceInformationFilterList: []*ssm.InstanceInformationFilter{
			{ // Required
				Key: aws.String("InstanceInformationFilterKey"), // Required
				ValueSet: []*string{ // Required
					aws.String("InstanceInformationFilterValue"), // Required
					// More values...
				},
			},
			// More values...
		},
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.DescribeInstanceInformation(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) DescribeInstanceInformationPages added in v1.2.7 

func (c *SSM) DescribeInstanceInformationPages(input *DescribeInstanceInformationInput, fn func(p *DescribeInstanceInformationOutput, lastPage bool) (shouldContinue 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 *DescribeInstanceInformationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

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 can be used to capture response data after the request's "Send" method is called.

See DescribeInstanceInformation for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeInstanceInformation method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) GetDocument 

func (c *SSM) GetDocument(input *GetDocumentInput) (*GetDocumentOutput, error)

GetDocument API operation for Amazon Simple Systems Management Service.

Gets the contents of the specified 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 Management Service's API operation GetDocument for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.GetDocumentInput{
		Name: aws.String("DocumentARN"), // Required
	}
	resp, err := svc.GetDocument(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetDocument for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDocument method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) ListAssociations 

func (c *SSM) ListAssociations(input *ListAssociationsInput) (*ListAssociationsOutput, error)

ListAssociations API operation for Amazon Simple Systems Management Service.

Lists the associations for the specified SSM 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 Management Service's API operation ListAssociations for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidNextToken The specified token is not valid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.ListAssociationsInput{
		AssociationFilterList: []*ssm.AssociationFilter{ // Required
			{ // Required
				Key:   aws.String("AssociationFilterKey"),   // Required
				Value: aws.String("AssociationFilterValue"), // Required
			},
			// More values...
		},
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.ListAssociations(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) ListAssociationsPages added in v1.1.0 

func (c *SSM) ListAssociationsPages(input *ListAssociationsInput, fn func(p *ListAssociationsOutput, lastPage bool) (shouldContinue 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 *ListAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

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 can be used to capture response data after the request's "Send" method is called.

See ListAssociations for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListAssociations method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) ListCommandInvocations added in v0.9.17 

func (c *SSM) ListCommandInvocations(input *ListCommandInvocationsInput) (*ListCommandInvocationsOutput, error)

* InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

* InvalidFilterKey The specified key is not valid.

* InvalidNextToken The specified token is not valid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.ListCommandInvocationsInput{
		CommandId: aws.String("CommandId"),
		Details:   aws.Bool(true),
		Filters: []*ssm.CommandFilter{
			{ // Required
				Key:   aws.String("CommandFilterKey"),   // Required
				Value: aws.String("CommandFilterValue"), // Required
			},
			// More values...
		},
		InstanceId: aws.String("InstanceId"),
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.ListCommandInvocations(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) ListCommandInvocationsPages added in v1.1.0 

func (c *SSM) ListCommandInvocationsPages(input *ListCommandInvocationsInput, fn func(p *ListCommandInvocationsOutput, lastPage bool) (shouldContinue 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 *ListCommandInvocationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

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 can be used to capture response data after the request's "Send" method is called.

See ListCommandInvocations for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListCommandInvocations method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) ListCommands added in v0.9.17 

func (c *SSM) ListCommands(input *ListCommandsInput) (*ListCommandsOutput, error)

* InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

* InvalidFilterKey The specified key is not valid.

* InvalidNextToken The specified token is not valid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.ListCommandsInput{
		CommandId: aws.String("CommandId"),
		Filters: []*ssm.CommandFilter{
			{ // Required
				Key:   aws.String("CommandFilterKey"),   // Required
				Value: aws.String("CommandFilterValue"), // Required
			},
			// More values...
		},
		InstanceId: aws.String("InstanceId"),
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.ListCommands(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) ListCommandsPages added in v1.1.0 

func (c *SSM) ListCommandsPages(input *ListCommandsInput, fn func(p *ListCommandsOutput, lastPage bool) (shouldContinue 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 *ListCommandsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

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 can be used to capture response data after the request's "Send" method is called.

See ListCommands for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListCommands method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) ListDocuments 

func (c *SSM) ListDocuments(input *ListDocumentsInput) (*ListDocumentsOutput, error)

ListDocuments API operation for Amazon Simple Systems Management Service.

Describes one or more of your SSM 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 Management Service's API operation ListDocuments for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidNextToken The specified token is not valid.

  • InvalidFilterKey The specified key is not valid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.ListDocumentsInput{
		DocumentFilterList: []*ssm.DocumentFilter{
			{ // Required
				Key:   aws.String("DocumentFilterKey"),   // Required
				Value: aws.String("DocumentFilterValue"), // Required
			},
			// More values...
		},
		MaxResults: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.ListDocuments(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SSM) ListDocumentsPages added in v1.1.0 

func (c *SSM) ListDocumentsPages(input *ListDocumentsInput, fn func(p *ListDocumentsOutput, lastPage bool) (shouldContinue 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 *ListDocumentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

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 can be used to capture response data after the request's "Send" method is called.

See ListDocuments for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListDocuments method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) ListTagsForResource added in v1.2.2 

func (c *SSM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Simple Systems Management Service.

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 Management Service's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • InvalidResourceType The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.

  • InvalidResourceId The resource ID is not valid. Verify that you entered the correct ID and try again.

  • InternalServerError An error occurred on the server side.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.ListTagsForResourceInput{
		ResourceId:   aws.String("ResourceId"),             // Required
		ResourceType: aws.String("ResourceTypeForTagging"), // Required
	}
	resp, err := svc.ListTagsForResource(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See ListTagsForResource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListTagsForResource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) ModifyDocumentPermission added in v1.1.26 

func (c *SSM) ModifyDocumentPermission(input *ModifyDocumentPermissionInput) (*ModifyDocumentPermissionOutput, error)

ModifyDocumentPermission API operation for Amazon Simple Systems Management Service.

Share a 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 Management Service's API operation ModifyDocumentPermission for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidDocument The specified document does not exist.

  • InvalidPermissionType The permission type is not supported. Share is the only supported permission type.

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

  • DocumentLimitExceeded You can have at most 200 active SSM documents.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.ModifyDocumentPermissionInput{
		Name:           aws.String("DocumentName"),           // Required
		PermissionType: aws.String("DocumentPermissionType"), // Required
		AccountIdsToAdd: []*string{
			aws.String("AccountId"), // Required
			// More values...
		},
		AccountIdsToRemove: []*string{
			aws.String("AccountId"), // Required
			// More values...
		},
	}
	resp, err := svc.ModifyDocumentPermission(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See ModifyDocumentPermission for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyDocumentPermission method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) RemoveTagsFromResource added in v1.2.2 

func (c *SSM) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResource API operation for Amazon Simple Systems Management Service.

Removes all tags 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 Management Service's API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • InvalidResourceType The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.

  • InvalidResourceId The resource ID is not valid. Verify that you entered the correct ID and try again.

  • InternalServerError An error occurred on the server side.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.RemoveTagsFromResourceInput{
		ResourceId:   aws.String("ResourceId"),             // Required
		ResourceType: aws.String("ResourceTypeForTagging"), // Required
		TagKeys: []*string{ // Required
			aws.String("TagKey"), // Required
			// More values...
		},
	}
	resp, err := svc.RemoveTagsFromResource(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See RemoveTagsFromResource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveTagsFromResource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) SendCommand added in v0.9.17 

func (c *SSM) SendCommand(input *SendCommandInput) (*SendCommandOutput, error)

SendCommand API operation for Amazon Simple Systems Management Service.

Executes commands on one or more remote 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 Management Service's API operation SendCommand for usage and error information.

Returned Error Codes:

  • DuplicateInstanceId You cannot specify an instance ID in more than one association.

  • InternalServerError An error occurred on the server side.

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • InvalidDocument The specified document does not exist.

  • InvalidOutputFolder The S3 bucket does not exist.

  • InvalidParameters You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.

  • UnsupportedPlatformType The document does not support the platform type of the given instance ID(s). For example, you sent an SSM document for a Windows instance to a Linux instance.

  • MaxDocumentSizeExceeded The size limit of an SSM document is 64 KB.

  • 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 SSM notifications, see Configuring SNS Notifications SSM (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/rc-sns.html) in the Amazon Elastic Compute Cloud User Guide .

  • InvalidNotificationConfig One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.SendCommandInput{
		DocumentName: aws.String("DocumentARN"), // Required
		InstanceIds: []*string{ // Required
			aws.String("InstanceId"), // Required
			// More values...
		},
		Comment:          aws.String("Comment"),
		DocumentHash:     aws.String("DocumentHash"),
		DocumentHashType: aws.String("DocumentHashType"),
		NotificationConfig: &ssm.NotificationConfig{
			NotificationArn: aws.String("NotificationArn"),
			NotificationEvents: []*string{
				aws.String("NotificationEvent"), // Required
				// More values...
			},
			NotificationType: aws.String("NotificationType"),
		},
		OutputS3BucketName: aws.String("S3BucketName"),
		OutputS3KeyPrefix:  aws.String("S3KeyPrefix"),
		Parameters: map[string][]*string{
			"Key": { // Required
				aws.String("ParameterValue"), // Required
				// More values...
			},
			// More values...
		},
		ServiceRoleArn: aws.String("ServiceRole"),
		TimeoutSeconds: aws.Int64(1),
	}
	resp, err := svc.SendCommand(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See SendCommand for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SendCommand method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) UpdateAssociationStatus 

func (c *SSM) UpdateAssociationStatus(input *UpdateAssociationStatusInput) (*UpdateAssociationStatusOutput, error)

UpdateAssociationStatus API operation for Amazon Simple Systems Management Service.

Updates the status of the SSM 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 Management Service's API operation UpdateAssociationStatus for usage and error information.

Returned Error Codes:

  • InternalServerError An error occurred on the server side.

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • InvalidDocument The specified document does not exist.

  • AssociationDoesNotExist The specified association does not exist.

  • StatusUnchanged The updated status is the same as the current status.

  • TooManyUpdates There are concurrent updates for a resource that supports one update at a time.

Example 
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.UpdateAssociationStatusInput{
		AssociationStatus: &ssm.AssociationStatus{ // Required
			Date:           aws.Time(time.Now()),                // Required
			Message:        aws.String("StatusMessage"),         // Required
			Name:           aws.String("AssociationStatusName"), // Required
			AdditionalInfo: aws.String("StatusAdditionalInfo"),
		},
		InstanceId: aws.String("InstanceId"),   // Required
		Name:       aws.String("DocumentName"), // Required
	}
	resp, err := svc.UpdateAssociationStatus(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateAssociationStatus for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateAssociationStatus method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

func (*SSM) UpdateManagedInstanceRole added in v1.2.2 

func (c *SSM) UpdateManagedInstanceRole(input *UpdateManagedInstanceRoleInput) (*UpdateManagedInstanceRoleOutput, error)

UpdateManagedInstanceRole API operation for Amazon Simple Systems Management Service.

Assigns or changes an Amazon Identity and Access Management (IAM) role to 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 Management Service's API operation UpdateManagedInstanceRole for usage and error information.

Returned Error Codes:

  • InvalidInstanceId The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

  • InternalServerError An error occurred on the server side.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/ssm"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := ssm.New(sess)

	params := &ssm.UpdateManagedInstanceRoleInput{
		IamRole:    aws.String("IamRole"),           // Required
		InstanceId: aws.String("ManagedInstanceId"), // Required
	}
	resp, err := svc.UpdateManagedInstanceRole(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateManagedInstanceRole for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateManagedInstanceRole method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// 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)
}

type SendCommandInput added in v0.9.17 

type SendCommandInput struct {

	// 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 SSM document to execute. This can be an SSM public
	// document or a custom document.
	//
	// DocumentName is a required field
	DocumentName *string `type:"string" required:"true"`

	// Required. The instance IDs where the command should execute. You can specify
	// a maximum of 50 IDs.
	//
	// InstanceIds is a required field
	InstanceIds []*string `min:"1" type:"list" required:"true"`

	// 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"`

	// The required and optional parameters specified in the SSM document being
	// executed.
	Parameters map[string][]*string `type:"map"`

	// The IAM role that SSM uses to send notifications.
	ServiceRoleArn *string `type:"string"`

	// If this time is reached and the command has not already started executing,
	// it will not execute.
	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) 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) SetInstanceIds added in v1.5.0 

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

SetInstanceIds sets the InstanceIds 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) 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) 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 SSM. 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 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 managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment.

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 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 SSM 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 

func (s *UpdateAssociationStatusInput) SetAssociationStatus(v *AssociationStatus) *UpdateAssociationStatusInput

SetAssociationStatus sets the AssociationStatus field's value.

func (*UpdateAssociationStatusInput) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (*UpdateAssociationStatusInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (UpdateAssociationStatusInput) String added in v0.6.5 

func (s UpdateAssociationStatusInput) String() string

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 

func (s UpdateAssociationStatusOutput) GoString() string

GoString returns the string representation

func (*UpdateAssociationStatusOutput) SetAssociationDescription added in v1.5.0 

func (s *UpdateAssociationStatusOutput) SetAssociationDescription(v *AssociationDescription) *UpdateAssociationStatusOutput

SetAssociationDescription sets the AssociationDescription field's value.

func (UpdateAssociationStatusOutput) String added in v0.6.5 

func (s UpdateAssociationStatusOutput) String() string

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 

func (s UpdateManagedInstanceRoleInput) GoString() string

GoString returns the string representation

func (*UpdateManagedInstanceRoleInput) SetIamRole added in v1.5.0 

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

SetIamRole sets the IamRole field's value.

func (*UpdateManagedInstanceRoleInput) SetInstanceId added in v1.5.0 

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

SetInstanceId sets the InstanceId field's value.

func (UpdateManagedInstanceRoleInput) String added in v1.2.2 

func (s UpdateManagedInstanceRoleInput) String() string

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 

func (s UpdateManagedInstanceRoleOutput) GoString() string

GoString returns the string representation

func (UpdateManagedInstanceRoleOutput) String added in v1.2.2 

func (s UpdateManagedInstanceRoleOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package ssmiface provides an interface to enable mocking the Amazon Simple Systems Management Service service client for testing your code.
 Package ssmiface provides an interface to enable mocking the Amazon Simple Systems Management Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.