types

package
v1.54.3 Latest Latest
Warning

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

 Go to latest Published: Sep 27, 2024 License: Apache-2.0 Imports: 4 Imported by: 155

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountSharingInfo 

type AccountSharingInfo struct {

	// The Amazon Web Services account ID where the current document is shared.
	AccountId *string

	// The version of the current document shared with the account.
	SharedDocumentVersion *string
	// contains filtered or unexported fields
}

Information includes the Amazon Web Services account ID where the current document is shared and the version shared with that account.

type Activation 

type Activation struct {

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

	// The date the activation was created.
	CreatedDate *time.Time

	// A name for the managed node when it is created.
	DefaultInstanceName *string

	// A user defined description of the activation.
	Description *string

	// The date when this activation can no longer be used to register managed nodes.
	ExpirationDate *time.Time

	// Whether or not the activation is expired.
	Expired bool

	// The Identity and Access Management (IAM) role to assign to the managed node.
	IamRole *string

	// The maximum number of managed nodes that can be registered using this
	// activation.
	RegistrationLimit *int32

	// The number of managed nodes already registered with this activation.
	RegistrationsCount *int32

	// Tags assigned to the activation.
	Tags []Tag
	// contains filtered or unexported fields
}

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

type Alarm added in v1.30.0 

type Alarm struct {

	// The name of your CloudWatch alarm.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A CloudWatch alarm you apply to an automation or command.

type AlarmConfiguration added in v1.30.0 

type AlarmConfiguration struct {

	// The name of the CloudWatch alarm specified in the configuration.
	//
	// This member is required.
	Alarms []Alarm

	// When this value is true, your automation or command continues to run in cases
	// where we can’t retrieve alarm status information from CloudWatch. In cases where
	// we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the
	// automation or command continues to run, regardless of this value. Default is
	// false.
	IgnorePollAlarmFailure bool
	// contains filtered or unexported fields
}

The details for the CloudWatch alarm you want to apply to an automation or command.

type AlarmStateInformation added in v1.30.0 

type AlarmStateInformation struct {

	// The name of your CloudWatch alarm.
	//
	// This member is required.
	Name *string

	// The state of your CloudWatch alarm.
	//
	// This member is required.
	State ExternalAlarmState
	// contains filtered or unexported fields
}

The details about the state of your CloudWatch alarm.

type AlreadyExistsException 

type AlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.

func (*AlreadyExistsException) Error 

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode 

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault 

func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*AlreadyExistsException) ErrorMessage 

func (e *AlreadyExistsException) ErrorMessage() string

type AssociatedInstances 

type AssociatedInstances struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You must disassociate a document from all managed nodes before you can delete it.

func (*AssociatedInstances) Error 

func (e *AssociatedInstances) Error() string

func (*AssociatedInstances) ErrorCode 

func (e *AssociatedInstances) ErrorCode() string

func (*AssociatedInstances) ErrorFault 

func (e *AssociatedInstances) ErrorFault() smithy.ErrorFault

func (*AssociatedInstances) ErrorMessage 

func (e *AssociatedInstances) ErrorMessage() string

type Association 

type Association struct {

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

	// The association name.
	AssociationName *string

	// The association version.
	AssociationVersion *string

	// The version of the document used in the association. If you change a document
	// version for a State Manager association, Systems Manager immediately runs the
	// association unless you previously specifed the apply-only-at-cron-interval
	// parameter.
	//
	// State Manager doesn't support running associations that use a new version of a
	// document if that document is shared from another account. State Manager always
	// runs the default version of a document if shared from another account, even
	// though the Systems Manager console shows that a new version was processed. If
	// you want to run an association using a new version of a document shared form
	// another account, you must set the document version to default .
	DocumentVersion *string

	// The number of hours that an association can run on specified targets. After the
	// resulting cutoff time passes, associations that are currently running are
	// cancelled, and no pending executions are started on remaining targets.
	Duration *int32

	// The managed node ID.
	InstanceId *string

	// The date on which the association was last run.
	LastExecutionDate *time.Time

	// The name of the SSM document.
	Name *string

	// Information about the association.
	Overview *AssociationOverview

	// A cron expression that specifies a schedule when the association runs. The
	// schedule runs in Coordinated Universal Time (UTC).
	ScheduleExpression *string

	// Number of days to wait after the scheduled day to run an association.
	ScheduleOffset *int32

	// A key-value mapping of document parameters to target resources. Both Targets
	// and TargetMaps can't be specified together.
	TargetMaps []map[string][]string

	// The managed nodes targeted by the request to create an association. You can
	// target all managed nodes in an Amazon Web Services account by specifying the
	// InstanceIds key with a value of * .
	Targets []Target
	// contains filtered or unexported fields
}

Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

type AssociationAlreadyExists 

type AssociationAlreadyExists struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified association already exists.

func (*AssociationAlreadyExists) Error 

func (e *AssociationAlreadyExists) Error() string

func (*AssociationAlreadyExists) ErrorCode 

func (e *AssociationAlreadyExists) ErrorCode() string

func (*AssociationAlreadyExists) ErrorFault 

func (e *AssociationAlreadyExists) ErrorFault() smithy.ErrorFault

func (*AssociationAlreadyExists) ErrorMessage 

func (e *AssociationAlreadyExists) ErrorMessage() string

type AssociationComplianceSeverity 

type AssociationComplianceSeverity string
const (
	AssociationComplianceSeverityCritical    AssociationComplianceSeverity = "CRITICAL"
	AssociationComplianceSeverityHigh        AssociationComplianceSeverity = "HIGH"
	AssociationComplianceSeverityMedium      AssociationComplianceSeverity = "MEDIUM"
	AssociationComplianceSeverityLow         AssociationComplianceSeverity = "LOW"
	AssociationComplianceSeverityUnspecified AssociationComplianceSeverity = "UNSPECIFIED"
)

Enum values for AssociationComplianceSeverity

func (AssociationComplianceSeverity) Values added in v0.29.0 

func (AssociationComplianceSeverity) Values() []AssociationComplianceSeverity

Values returns all known values for AssociationComplianceSeverity. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationDescription 

type AssociationDescription struct {

	// The details for the CloudWatch alarm you want to apply to an automation or
	// command.
	AlarmConfiguration *AlarmConfiguration

	// By default, when you create a new associations, the system runs it immediately
	// after it is created and then according to the schedule you specified. Specify
	// this option if you don't want an association to run immediately after you create
	// it. This parameter isn't supported for rate expressions.
	ApplyOnlyAtCronInterval bool

	// The association ID.
	AssociationId *string

	// The association name.
	AssociationName *string

	// The association version.
	AssociationVersion *string

	// Choose the parameter that will define how your automation will branch out. This
	// target is required for associations that use an Automation runbook and target
	// resources by using rate controls. Automation is a capability of Amazon Web
	// Services Systems Manager.
	AutomationTargetParameterName *string

	// The names or Amazon Resource Names (ARNs) of the Change Calendar type documents
	// your associations are gated under. The associations only run when that change
	// calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar].
	//
	// [Amazon Web Services Systems Manager Change Calendar]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
	CalendarNames []string

	// The severity level that is assigned to the association.
	ComplianceSeverity AssociationComplianceSeverity

	// The date when the association was made.
	Date *time.Time

	// The document version.
	DocumentVersion *string

	// The number of hours that an association can run on specified targets. After the
	// resulting cutoff time passes, associations that are currently running are
	// cancelled, and no pending executions are started on remaining targets.
	Duration *int32

	// The managed node ID.
	InstanceId *string

	// The date on which the association was last run.
	LastExecutionDate *time.Time

	// The last date on which the association was successfully run.
	LastSuccessfulExecutionDate *time.Time

	// The date when the association was last updated.
	LastUpdateAssociationDate *time.Time

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

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

	// The name of the SSM document.
	Name *string

	// An S3 bucket where you want to store the output details of the request.
	OutputLocation *InstanceAssociationOutputLocation

	// Information about the association.
	Overview *AssociationOverview

	// A description of the parameters for a document.
	Parameters map[string][]string

	// A cron expression that specifies a schedule when the association runs.
	ScheduleExpression *string

	// Number of days to wait after the scheduled day to run an association.
	ScheduleOffset *int32

	// The association status.
	Status *AssociationStatus

	// The mode for generating association compliance. You can specify AUTO or MANUAL .
	// In AUTO mode, the system uses the status of the association execution to
	// determine the compliance status. If the association execution runs successfully,
	// then the association is COMPLIANT . If the association execution doesn't run
	// successfully, the association is NON-COMPLIANT .
	//
	// In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API
	// operation. In this case, compliance data isn't managed by State Manager, a
	// capability of Amazon Web Services Systems Manager. It is managed by your direct
	// call to the PutComplianceItemsAPI operation.
	//
	// By default, all associations use AUTO mode.
	SyncCompliance AssociationSyncCompliance

	// The combination of Amazon Web Services Regions and Amazon Web Services accounts
	// where you want to run the association.
	TargetLocations []TargetLocation

	// A key-value mapping of document parameters to target resources. Both Targets
	// and TargetMaps can't be specified together.
	TargetMaps []map[string][]string

	// The managed nodes targeted by the request.
	Targets []Target

	// The CloudWatch alarm that was invoked during the association.
	TriggeredAlarms []AlarmStateInformation
	// contains filtered or unexported fields
}

Describes the parameters for a document.

type AssociationDoesNotExist 

type AssociationDoesNotExist struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified association doesn't exist.

func (*AssociationDoesNotExist) Error 

func (e *AssociationDoesNotExist) Error() string

func (*AssociationDoesNotExist) ErrorCode 

func (e *AssociationDoesNotExist) ErrorCode() string

func (*AssociationDoesNotExist) ErrorFault 

func (e *AssociationDoesNotExist) ErrorFault() smithy.ErrorFault

func (*AssociationDoesNotExist) ErrorMessage 

func (e *AssociationDoesNotExist) ErrorMessage() string

type AssociationExecution 

type AssociationExecution struct {

	// The details for the CloudWatch alarm you want to apply to an automation or
	// command.
	AlarmConfiguration *AlarmConfiguration

	// The association ID.
	AssociationId *string

	// The association version.
	AssociationVersion *string

	// The time the execution started.
	CreatedTime *time.Time

	// Detailed status information about the execution.
	DetailedStatus *string

	// The execution ID for the association.
	ExecutionId *string

	// The date of the last execution.
	LastExecutionDate *time.Time

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

	// The status of the association execution.
	Status *string

	// The CloudWatch alarms that were invoked by the association.
	TriggeredAlarms []AlarmStateInformation
	// contains filtered or unexported fields
}

Includes information about the specified association.

type AssociationExecutionDoesNotExist 

type AssociationExecutionDoesNotExist struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified execution ID doesn't exist. Verify the ID number and try again.

func (*AssociationExecutionDoesNotExist) Error 

func (e *AssociationExecutionDoesNotExist) Error() string

func (*AssociationExecutionDoesNotExist) ErrorCode 

func (e *AssociationExecutionDoesNotExist) ErrorCode() string

func (*AssociationExecutionDoesNotExist) ErrorFault 

func (e *AssociationExecutionDoesNotExist) ErrorFault() smithy.ErrorFault

func (*AssociationExecutionDoesNotExist) ErrorMessage 

func (e *AssociationExecutionDoesNotExist) ErrorMessage() string

type AssociationExecutionFilter 

type AssociationExecutionFilter struct {

	// The key value used in the request.
	//
	// This member is required.
	Key AssociationExecutionFilterKey

	// The filter type specified in the request.
	//
	// This member is required.
	Type AssociationFilterOperatorType

	// The value specified for the key.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Filters used in the request.

type AssociationExecutionFilterKey 

type AssociationExecutionFilterKey string
const (
	AssociationExecutionFilterKeyExecutionId AssociationExecutionFilterKey = "ExecutionId"
	AssociationExecutionFilterKeyStatus      AssociationExecutionFilterKey = "Status"
	AssociationExecutionFilterKeyCreatedTime AssociationExecutionFilterKey = "CreatedTime"
)

Enum values for AssociationExecutionFilterKey

func (AssociationExecutionFilterKey) Values added in v0.29.0 

func (AssociationExecutionFilterKey) Values() []AssociationExecutionFilterKey

Values returns all known values for AssociationExecutionFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationExecutionTarget 

type AssociationExecutionTarget struct {

	// The association ID.
	AssociationId *string

	// The association version.
	AssociationVersion *string

	// Detailed information about the execution status.
	DetailedStatus *string

	// The execution ID.
	ExecutionId *string

	// The date of the last execution.
	LastExecutionDate *time.Time

	// The location where the association details are saved.
	OutputSource *OutputSource

	// The resource ID, for example, the managed node ID where the association ran.
	ResourceId *string

	// The resource type, for example, EC2.
	ResourceType *string

	// The association execution status.
	Status *string
	// contains filtered or unexported fields
}

Includes information about the specified association execution.

type AssociationExecutionTargetsFilter 

type AssociationExecutionTargetsFilter struct {

	// The key value used in the request.
	//
	// This member is required.
	Key AssociationExecutionTargetsFilterKey

	// The value specified for the key.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Filters for the association execution.

type AssociationExecutionTargetsFilterKey 

type AssociationExecutionTargetsFilterKey string
const (
	AssociationExecutionTargetsFilterKeyStatus       AssociationExecutionTargetsFilterKey = "Status"
	AssociationExecutionTargetsFilterKeyResourceId   AssociationExecutionTargetsFilterKey = "ResourceId"
	AssociationExecutionTargetsFilterKeyResourceType AssociationExecutionTargetsFilterKey = "ResourceType"
)

Enum values for AssociationExecutionTargetsFilterKey

func (AssociationExecutionTargetsFilterKey) Values added in v0.29.0 

func (AssociationExecutionTargetsFilterKey) Values() []AssociationExecutionTargetsFilterKey

Values returns all known values for AssociationExecutionTargetsFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationFilter 

type AssociationFilter struct {

	// The name of the filter.
	//
	// InstanceId has been deprecated.
	//
	// This member is required.
	Key AssociationFilterKey

	// The filter value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Describes a filter.

type AssociationFilterKey 

type AssociationFilterKey string
const (
	AssociationFilterKeyInstanceId         AssociationFilterKey = "InstanceId"
	AssociationFilterKeyName               AssociationFilterKey = "Name"
	AssociationFilterKeyAssociationId      AssociationFilterKey = "AssociationId"
	AssociationFilterKeyStatus             AssociationFilterKey = "AssociationStatusName"
	AssociationFilterKeyLastExecutedBefore AssociationFilterKey = "LastExecutedBefore"
	AssociationFilterKeyLastExecutedAfter  AssociationFilterKey = "LastExecutedAfter"
	AssociationFilterKeyAssociationName    AssociationFilterKey = "AssociationName"
	AssociationFilterKeyResourceGroupName  AssociationFilterKey = "ResourceGroupName"
)

Enum values for AssociationFilterKey

func (AssociationFilterKey) Values added in v0.29.0 

func (AssociationFilterKey) Values() []AssociationFilterKey

Values returns all known values for AssociationFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationFilterOperatorType 

type AssociationFilterOperatorType string
const (
	AssociationFilterOperatorTypeEqual       AssociationFilterOperatorType = "EQUAL"
	AssociationFilterOperatorTypeLessThan    AssociationFilterOperatorType = "LESS_THAN"
	AssociationFilterOperatorTypeGreaterThan AssociationFilterOperatorType = "GREATER_THAN"
)

Enum values for AssociationFilterOperatorType

func (AssociationFilterOperatorType) Values added in v0.29.0 

func (AssociationFilterOperatorType) Values() []AssociationFilterOperatorType

Values returns all known values for AssociationFilterOperatorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationLimitExceeded 

type AssociationLimitExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You can have at most 2,000 active associations.

func (*AssociationLimitExceeded) Error 

func (e *AssociationLimitExceeded) Error() string

func (*AssociationLimitExceeded) ErrorCode 

func (e *AssociationLimitExceeded) ErrorCode() string

func (*AssociationLimitExceeded) ErrorFault 

func (e *AssociationLimitExceeded) ErrorFault() smithy.ErrorFault

func (*AssociationLimitExceeded) ErrorMessage 

func (e *AssociationLimitExceeded) ErrorMessage() string

type AssociationOverview 

type AssociationOverview struct {

	// Returns the number of targets for the association status. For example, if you
	// created an association with two managed nodes, and one of them was successful,
	// this would return the count of managed nodes by status.
	AssociationStatusAggregatedCount map[string]int32

	// A detailed status of the association.
	DetailedStatus *string

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

Information about the association.

type AssociationStatus 

type AssociationStatus struct {

	// The date when the status changed.
	//
	// This member is required.
	Date *time.Time

	// The reason for the status.
	//
	// This member is required.
	Message *string

	// The status.
	//
	// This member is required.
	Name AssociationStatusName

	// A user-defined string.
	AdditionalInfo *string
	// contains filtered or unexported fields
}

Describes an association status.

type AssociationStatusName 

type AssociationStatusName string
const (
	AssociationStatusNamePending AssociationStatusName = "Pending"
	AssociationStatusNameSuccess AssociationStatusName = "Success"
	AssociationStatusNameFailed  AssociationStatusName = "Failed"
)

Enum values for AssociationStatusName

func (AssociationStatusName) Values added in v0.29.0 

func (AssociationStatusName) Values() []AssociationStatusName

Values returns all known values for AssociationStatusName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationSyncCompliance 

type AssociationSyncCompliance string
const (
	AssociationSyncComplianceAuto   AssociationSyncCompliance = "AUTO"
	AssociationSyncComplianceManual AssociationSyncCompliance = "MANUAL"
)

Enum values for AssociationSyncCompliance

func (AssociationSyncCompliance) Values added in v0.29.0 

func (AssociationSyncCompliance) Values() []AssociationSyncCompliance

Values returns all known values for AssociationSyncCompliance. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssociationVersionInfo 

type AssociationVersionInfo struct {

	// By default, when you create a new associations, the system runs it immediately
	// after it is created and then according to the schedule you specified. Specify
	// this option if you don't want an association to run immediately after you create
	// it. This parameter isn't supported for rate expressions.
	ApplyOnlyAtCronInterval bool

	// The ID created by the system when the association was created.
	AssociationId *string

	// The name specified for the association version when the association version was
	// created.
	AssociationName *string

	// The association version.
	AssociationVersion *string

	// The names or Amazon Resource Names (ARNs) of the Change Calendar type documents
	// your associations are gated under. The associations for this version only run
	// when that Change Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar].
	//
	// [Amazon Web Services Systems Manager Change Calendar]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
	CalendarNames []string

	// The severity level that is assigned to the association.
	ComplianceSeverity AssociationComplianceSeverity

	// The date the association version was created.
	CreatedDate *time.Time

	// The version of an Amazon Web Services Systems Manager document (SSM document)
	// used when the association version was created.
	DocumentVersion *string

	// The number of hours that an association can run on specified targets. After the
	// resulting cutoff time passes, associations that are currently running are
	// cancelled, and no pending executions are started on remaining targets.
	Duration *int32

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

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

	// The name specified when the association was created.
	Name *string

	// The location in Amazon S3 specified for the association when the association
	// version was created.
	OutputLocation *InstanceAssociationOutputLocation

	// Parameters specified when the association version was created.
	Parameters map[string][]string

	// The cron or rate schedule specified for the association when the association
	// version was created.
	ScheduleExpression *string

	// Number of days to wait after the scheduled day to run an association.
	ScheduleOffset *int32

	// The mode for generating association compliance. You can specify AUTO or MANUAL .
	// In AUTO mode, the system uses the status of the association execution to
	// determine the compliance status. If the association execution runs successfully,
	// then the association is COMPLIANT . If the association execution doesn't run
	// successfully, the association is NON-COMPLIANT .
	//
	// In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API
	// operation. In this case, compliance data isn't managed by State Manager, a
	// capability of Amazon Web Services Systems Manager. It is managed by your direct
	// call to the PutComplianceItemsAPI operation.
	//
	// By default, all associations use AUTO mode.
	SyncCompliance AssociationSyncCompliance

	// The combination of Amazon Web Services Regions and Amazon Web Services accounts
	// where you wanted to run the association when this association version was
	// created.
	TargetLocations []TargetLocation

	// A key-value mapping of document parameters to target resources. Both Targets
	// and TargetMaps can't be specified together.
	TargetMaps []map[string][]string

	// The targets specified for the association when the association version was
	// created.
	Targets []Target
	// contains filtered or unexported fields
}

Information about the association version.

type AssociationVersionLimitExceeded 

type AssociationVersionLimitExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

func (*AssociationVersionLimitExceeded) Error 

func (e *AssociationVersionLimitExceeded) Error() string

func (*AssociationVersionLimitExceeded) ErrorCode 

func (e *AssociationVersionLimitExceeded) ErrorCode() string

func (*AssociationVersionLimitExceeded) ErrorFault 

func (e *AssociationVersionLimitExceeded) ErrorFault() smithy.ErrorFault

func (*AssociationVersionLimitExceeded) ErrorMessage 

func (e *AssociationVersionLimitExceeded) ErrorMessage() string

type AttachmentContent 

type AttachmentContent struct {

	// The cryptographic hash value of the document content.
	Hash *string

	// The hash algorithm used to calculate the hash value.
	HashType AttachmentHashType

	// The name of an attachment.
	Name *string

	// The size of an attachment in bytes.
	Size int64

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

A structure that includes attributes that describe a document attachment.

type AttachmentHashType 

type AttachmentHashType string
const (
	AttachmentHashTypeSha256 AttachmentHashType = "Sha256"
)

Enum values for AttachmentHashType

func (AttachmentHashType) Values added in v0.29.0 

func (AttachmentHashType) Values() []AttachmentHashType

Values returns all known values for AttachmentHashType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AttachmentInformation 

type AttachmentInformation struct {

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

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

type AttachmentsSource 

type AttachmentsSource struct {

	// The key of a key-value pair that identifies the location of an attachment to a
	// document.
	Key AttachmentsSourceKey

	// The name of the document attachment file.
	Name *string

	// The value of a key-value pair that identifies the location of an attachment to
	// a document. The format for Value depends on the type of key you specify.
	//
	//   - For the key SourceUrl, the value is an S3 bucket location. For example:
	//
	// "Values": [ "s3://amzn-s3-demo-bucket/my-prefix" ]
	//
	//   - For the key S3FileUrl, the value is a file in an S3 bucket. For example:
	//
	// "Values": [ "s3://amzn-s3-demo-bucket/my-prefix/my-file.py" ]
	//
	//   - For the key AttachmentReference, the value is constructed from the name of
	//   another SSM document in your account, a version number of that document, and a
	//   file attached to that document version that you want to reuse. For example:
	//
	// "Values": [ "MyOtherDocument/3/my-other-file.py" ]
	//
	// However, if the SSM document is shared with you from another account, the full
	//   SSM document ARN must be specified instead of the document name only. For
	//   example:
	//
	// "Values": [
	//   "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py"
	//   ]
	Values []string
	// contains filtered or unexported fields
}

Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.

type AttachmentsSourceKey 

type AttachmentsSourceKey string
const (
	AttachmentsSourceKeySourceUrl           AttachmentsSourceKey = "SourceUrl"
	AttachmentsSourceKeyS3FileUrl           AttachmentsSourceKey = "S3FileUrl"
	AttachmentsSourceKeyAttachmentReference AttachmentsSourceKey = "AttachmentReference"
)

Enum values for AttachmentsSourceKey

func (AttachmentsSourceKey) Values added in v0.29.0 

func (AttachmentsSourceKey) Values() []AttachmentsSourceKey

Values returns all known values for AttachmentsSourceKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutomationDefinitionNotApprovedException added in v0.31.0 

type AutomationDefinitionNotApprovedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.

func (*AutomationDefinitionNotApprovedException) Error added in v0.31.0 

func (e *AutomationDefinitionNotApprovedException) Error() string

func (*AutomationDefinitionNotApprovedException) ErrorCode added in v0.31.0 

func (e *AutomationDefinitionNotApprovedException) ErrorCode() string

func (*AutomationDefinitionNotApprovedException) ErrorFault added in v0.31.0 

func (e *AutomationDefinitionNotApprovedException) ErrorFault() smithy.ErrorFault

func (*AutomationDefinitionNotApprovedException) ErrorMessage added in v0.31.0 

func (e *AutomationDefinitionNotApprovedException) ErrorMessage() string

type AutomationDefinitionNotFoundException 

type AutomationDefinitionNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An Automation runbook with the specified name couldn't be found.

func (*AutomationDefinitionNotFoundException) Error 

func (e *AutomationDefinitionNotFoundException) Error() string

func (*AutomationDefinitionNotFoundException) ErrorCode 

func (e *AutomationDefinitionNotFoundException) ErrorCode() string

func (*AutomationDefinitionNotFoundException) ErrorFault 

func (e *AutomationDefinitionNotFoundException) ErrorFault() smithy.ErrorFault

func (*AutomationDefinitionNotFoundException) ErrorMessage 

func (e *AutomationDefinitionNotFoundException) ErrorMessage() string

type AutomationDefinitionVersionNotFoundException 

type AutomationDefinitionVersionNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An Automation runbook with the specified name and version couldn't be found.

func (*AutomationDefinitionVersionNotFoundException) Error 

func (e *AutomationDefinitionVersionNotFoundException) Error() string

func (*AutomationDefinitionVersionNotFoundException) ErrorCode 

func (e *AutomationDefinitionVersionNotFoundException) ErrorCode() string

func (*AutomationDefinitionVersionNotFoundException) ErrorFault 

func (e *AutomationDefinitionVersionNotFoundException) ErrorFault() smithy.ErrorFault

func (*AutomationDefinitionVersionNotFoundException) ErrorMessage 

func (e *AutomationDefinitionVersionNotFoundException) ErrorMessage() string

type AutomationExecution 

type AutomationExecution struct {

	// The details for the CloudWatch alarm applied to your automation.
	AlarmConfiguration *AlarmConfiguration

	// The ID of a State Manager association used in the Automation operation.
	AssociationId *string

	// The execution ID.
	AutomationExecutionId *string

	// The execution status of the Automation.
	AutomationExecutionStatus AutomationExecutionStatus

	// The subtype of the Automation operation. Currently, the only supported value is
	// ChangeRequest .
	AutomationSubtype AutomationSubtype

	// The name of the Change Manager change request.
	ChangeRequestName *string

	// The action of the step that is currently running.
	CurrentAction *string

	// The name of the step that is currently running.
	CurrentStepName *string

	// The name of the Automation runbook used during the execution.
	DocumentName *string

	// The version of the document to use during execution.
	DocumentVersion *string

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

	// The time the execution finished.
	ExecutionEndTime *time.Time

	// The time the execution started.
	ExecutionStartTime *time.Time

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

	// The MaxConcurrency value specified by the user when the execution started.
	MaxConcurrency *string

	// The MaxErrors value specified by the user when the execution started.
	MaxErrors *string

	// The automation execution mode.
	Mode ExecutionMode

	// The ID of an OpsItem that is created to represent a Change Manager change
	// request.
	OpsItemId *string

	// The list of execution outputs as defined in the Automation runbook.
	Outputs map[string][]string

	// The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
	Parameters map[string][]string

	// The AutomationExecutionId of the parent automation.
	ParentAutomationExecutionId *string

	// An aggregate of step execution statuses displayed in the Amazon Web Services
	// Systems Manager console for a multi-Region and multi-account Automation
	// execution.
	ProgressCounters *ProgressCounters

	// A list of resolved targets in the rate control execution.
	ResolvedTargets *ResolvedTargets

	// Information about the Automation runbooks that are run as part of a runbook
	// workflow.
	//
	// The Automation runbooks specified for the runbook workflow can't run until all
	// required approvals for the change request have been received.
	Runbooks []Runbook

	// The date and time the Automation operation is scheduled to start.
	ScheduledTime *time.Time

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

	// A boolean value that indicates if the response contains the full list of the
	// Automation step executions. If true, use the DescribeAutomationStepExecutions
	// API operation to get the full list of step executions.
	StepExecutionsTruncated bool

	// The target of the execution.
	Target *string

	// The combination of Amazon Web Services Regions and/or Amazon Web Services
	// accounts where you want to run the Automation.
	TargetLocations []TargetLocation

	// A publicly accessible URL for a file that contains the TargetLocations body.
	// Currently, only files in presigned Amazon S3 buckets are supported
	TargetLocationsURL *string

	// The specified key-value mapping of document parameters to target resources.
	TargetMaps []map[string][]string

	// The parameter name.
	TargetParameterName *string

	// The specified targets.
	Targets []Target

	// The CloudWatch alarm that was invoked by the automation.
	TriggeredAlarms []AlarmStateInformation

	// Variables defined for the automation.
	Variables map[string][]string
	// contains filtered or unexported fields
}

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

type AutomationExecutionFilter 

type AutomationExecutionFilter struct {

	// One or more keys to limit the results.
	//
	// This member is required.
	Key AutomationExecutionFilterKey

	// The values used to limit the execution information associated with the filter's
	// key.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

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

type AutomationExecutionFilterKey 

type AutomationExecutionFilterKey string
const (
	AutomationExecutionFilterKeyDocumentNamePrefix  AutomationExecutionFilterKey = "DocumentNamePrefix"
	AutomationExecutionFilterKeyExecutionStatus     AutomationExecutionFilterKey = "ExecutionStatus"
	AutomationExecutionFilterKeyExecutionId         AutomationExecutionFilterKey = "ExecutionId"
	AutomationExecutionFilterKeyParentExecutionId   AutomationExecutionFilterKey = "ParentExecutionId"
	AutomationExecutionFilterKeyCurrentAction       AutomationExecutionFilterKey = "CurrentAction"
	AutomationExecutionFilterKeyStartTimeBefore     AutomationExecutionFilterKey = "StartTimeBefore"
	AutomationExecutionFilterKeyStartTimeAfter      AutomationExecutionFilterKey = "StartTimeAfter"
	AutomationExecutionFilterKeyAutomationType      AutomationExecutionFilterKey = "AutomationType"
	AutomationExecutionFilterKeyTagKey              AutomationExecutionFilterKey = "TagKey"
	AutomationExecutionFilterKeyTargetResourceGroup AutomationExecutionFilterKey = "TargetResourceGroup"
	AutomationExecutionFilterKeyAutomationSubtype   AutomationExecutionFilterKey = "AutomationSubtype"
	AutomationExecutionFilterKeyOpsItemId           AutomationExecutionFilterKey = "OpsItemId"
)

Enum values for AutomationExecutionFilterKey

func (AutomationExecutionFilterKey) Values added in v0.29.0 

func (AutomationExecutionFilterKey) Values() []AutomationExecutionFilterKey

Values returns all known values for AutomationExecutionFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutomationExecutionLimitExceededException 

type AutomationExecutionLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The number of simultaneously running Automation executions exceeded the allowable limit.

func (*AutomationExecutionLimitExceededException) Error 

func (e *AutomationExecutionLimitExceededException) Error() string

func (*AutomationExecutionLimitExceededException) ErrorCode 

func (e *AutomationExecutionLimitExceededException) ErrorCode() string

func (*AutomationExecutionLimitExceededException) ErrorFault 

func (e *AutomationExecutionLimitExceededException) ErrorFault() smithy.ErrorFault

func (*AutomationExecutionLimitExceededException) ErrorMessage 

func (e *AutomationExecutionLimitExceededException) ErrorMessage() string

type AutomationExecutionMetadata 

type AutomationExecutionMetadata struct {

	// The details for the CloudWatch alarm applied to your automation.
	AlarmConfiguration *AlarmConfiguration

	// The ID of a State Manager association used in the Automation operation.
	AssociationId *string

	// The execution ID.
	AutomationExecutionId *string

	// The status of the execution.
	AutomationExecutionStatus AutomationExecutionStatus

	// The subtype of the Automation operation. Currently, the only supported value is
	// ChangeRequest .
	AutomationSubtype AutomationSubtype

	// Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an
	// Automation that runs in multiple Amazon Web Services Regions and Amazon Web
	// Services accounts. For more information, see [Running automations in multiple Amazon Web Services Regions and accounts]in the Amazon Web Services Systems
	// Manager User Guide.
	//
	// [Running automations in multiple Amazon Web Services Regions and accounts]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html
	AutomationType AutomationType

	// The name of the Change Manager change request.
	ChangeRequestName *string

	// The action of the step that is currently running.
	CurrentAction *string

	// The name of the step that is currently running.
	CurrentStepName *string

	// The name of the Automation runbook used during execution.
	DocumentName *string

	// The document version used during the execution.
	DocumentVersion *string

	// The IAM role ARN of the user who ran the automation.
	ExecutedBy *string

	// The time the execution finished. This isn't populated if the execution is still
	// in progress.
	ExecutionEndTime *time.Time

	// The time the execution started.
	ExecutionStartTime *time.Time

	// The list of execution outputs as defined in the Automation runbook.
	FailureMessage *string

	// An S3 bucket where execution information is stored.
	LogFile *string

	// The MaxConcurrency value specified by the user when starting the automation.
	MaxConcurrency *string

	// The MaxErrors value specified by the user when starting the automation.
	MaxErrors *string

	// The Automation execution mode.
	Mode ExecutionMode

	// The ID of an OpsItem that is created to represent a Change Manager change
	// request.
	OpsItemId *string

	// The list of execution outputs as defined in the Automation runbook.
	Outputs map[string][]string

	// The execution ID of the parent automation.
	ParentAutomationExecutionId *string

	// A list of targets that resolved during the execution.
	ResolvedTargets *ResolvedTargets

	// Information about the Automation runbooks that are run during a runbook
	// workflow in Change Manager.
	//
	// The Automation runbooks specified for the runbook workflow can't run until all
	// required approvals for the change request have been received.
	Runbooks []Runbook

	// The date and time the Automation operation is scheduled to start.
	ScheduledTime *time.Time

	// The list of execution outputs as defined in the Automation runbook.
	Target *string

	// A publicly accessible URL for a file that contains the TargetLocations body.
	// Currently, only files in presigned Amazon S3 buckets are supported
	TargetLocationsURL *string

	// The specified key-value mapping of document parameters to target resources.
	TargetMaps []map[string][]string

	// The list of execution outputs as defined in the Automation runbook.
	TargetParameterName *string

	// The targets defined by the user when starting the automation.
	Targets []Target

	// The CloudWatch alarm that was invoked by the automation.
	TriggeredAlarms []AlarmStateInformation
	// contains filtered or unexported fields
}

Details about a specific Automation execution.

type AutomationExecutionNotFoundException 

type AutomationExecutionNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There is no automation execution information for the requested automation execution ID.

func (*AutomationExecutionNotFoundException) Error 

func (e *AutomationExecutionNotFoundException) Error() string

func (*AutomationExecutionNotFoundException) ErrorCode 

func (e *AutomationExecutionNotFoundException) ErrorCode() string

func (*AutomationExecutionNotFoundException) ErrorFault 

func (e *AutomationExecutionNotFoundException) ErrorFault() smithy.ErrorFault

func (*AutomationExecutionNotFoundException) ErrorMessage 

func (e *AutomationExecutionNotFoundException) ErrorMessage() string

type AutomationExecutionStatus 

type AutomationExecutionStatus string
const (
	AutomationExecutionStatusPending                        AutomationExecutionStatus = "Pending"
	AutomationExecutionStatusInprogress                     AutomationExecutionStatus = "InProgress"
	AutomationExecutionStatusWaiting                        AutomationExecutionStatus = "Waiting"
	AutomationExecutionStatusSuccess                        AutomationExecutionStatus = "Success"
	AutomationExecutionStatusTimedout                       AutomationExecutionStatus = "TimedOut"
	AutomationExecutionStatusCancelling                     AutomationExecutionStatus = "Cancelling"
	AutomationExecutionStatusCancelled                      AutomationExecutionStatus = "Cancelled"
	AutomationExecutionStatusFailed                         AutomationExecutionStatus = "Failed"
	AutomationExecutionStatusPendingApproval                AutomationExecutionStatus = "PendingApproval"
	AutomationExecutionStatusApproved                       AutomationExecutionStatus = "Approved"
	AutomationExecutionStatusRejected                       AutomationExecutionStatus = "Rejected"
	AutomationExecutionStatusScheduled                      AutomationExecutionStatus = "Scheduled"
	AutomationExecutionStatusRunbookInprogress              AutomationExecutionStatus = "RunbookInProgress"
	AutomationExecutionStatusPendingChangeCalendarOverride  AutomationExecutionStatus = "PendingChangeCalendarOverride"
	AutomationExecutionStatusChangeCalendarOverrideApproved AutomationExecutionStatus = "ChangeCalendarOverrideApproved"
	AutomationExecutionStatusChangeCalendarOverrideRejected AutomationExecutionStatus = "ChangeCalendarOverrideRejected"
	AutomationExecutionStatusCompletedWithSuccess           AutomationExecutionStatus = "CompletedWithSuccess"
	AutomationExecutionStatusCompletedWithFailure           AutomationExecutionStatus = "CompletedWithFailure"
	AutomationExecutionStatusExited                         AutomationExecutionStatus = "Exited"
)

Enum values for AutomationExecutionStatus

func (AutomationExecutionStatus) Values added in v0.29.0 

func (AutomationExecutionStatus) Values() []AutomationExecutionStatus

Values returns all known values for AutomationExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutomationStepNotFoundException 

type AutomationStepNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified step name and execution ID don't exist. Verify the information and try again.

func (*AutomationStepNotFoundException) Error 

func (e *AutomationStepNotFoundException) Error() string

func (*AutomationStepNotFoundException) ErrorCode 

func (e *AutomationStepNotFoundException) ErrorCode() string

func (*AutomationStepNotFoundException) ErrorFault 

func (e *AutomationStepNotFoundException) ErrorFault() smithy.ErrorFault

func (*AutomationStepNotFoundException) ErrorMessage 

func (e *AutomationStepNotFoundException) ErrorMessage() string

type AutomationSubtype added in v0.31.0 

type AutomationSubtype string
const (
	AutomationSubtypeChangeRequest AutomationSubtype = "ChangeRequest"
)

Enum values for AutomationSubtype

func (AutomationSubtype) Values added in v0.31.0 

func (AutomationSubtype) Values() []AutomationSubtype

Values returns all known values for AutomationSubtype. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutomationType 

type AutomationType string
const (
	AutomationTypeCrossAccount AutomationType = "CrossAccount"
	AutomationTypeLocal        AutomationType = "Local"
)

Enum values for AutomationType

func (AutomationType) Values added in v0.29.0 

func (AutomationType) Values() []AutomationType

Values returns all known values for AutomationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BaselineOverride added in v1.2.0 

type BaselineOverride struct {

	// A set of rules defining the approval rules for a patch baseline.
	ApprovalRules *PatchRuleGroup

	// A list of explicitly approved patches for the baseline.
	//
	// For information about accepted formats for lists of approved patches and
	// rejected patches, see [Package name formats for approved and rejected patch lists]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Package name formats for approved and rejected patch lists]: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html
	ApprovedPatches []string

	// Defines the compliance level for approved patches. When an approved patch is
	// reported as missing, this value describes the severity of the compliance
	// violation.
	ApprovedPatchesComplianceLevel PatchComplianceLevel

	// Indicates whether the list of approved patches includes non-security updates
	// that should be applied to the managed nodes. The default value is false .
	// Applies to Linux managed nodes only.
	ApprovedPatchesEnableNonSecurity bool

	// A set of patch filters, typically used for approval rules.
	GlobalFilters *PatchFilterGroup

	// The operating system rule used by the patch baseline override.
	OperatingSystem OperatingSystem

	// A list of explicitly rejected patches for the baseline.
	//
	// For information about accepted formats for lists of approved patches and
	// rejected patches, see [Package name formats for approved and rejected patch lists]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Package name formats for approved and rejected patch lists]: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html
	RejectedPatches []string

	// The action for Patch Manager to take on patches included in the RejectedPackages
	// list. A patch can be allowed only if it is a dependency of another package, or
	// blocked entirely along with packages that include it as a dependency.
	RejectedPatchesAction PatchAction

	// Information about the patches to use to update the managed nodes, including
	// target operating systems and source repositories. Applies to Linux managed nodes
	// only.
	Sources []PatchSource
	// contains filtered or unexported fields
}

Defines the basic information about a patch baseline override.

type CalendarState 

type CalendarState string
const (
	CalendarStateOpen   CalendarState = "OPEN"
	CalendarStateClosed CalendarState = "CLOSED"
)

Enum values for CalendarState

func (CalendarState) Values added in v0.29.0 

func (CalendarState) Values() []CalendarState

Values returns all known values for CalendarState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CloudWatchOutputConfig 

type CloudWatchOutputConfig struct {

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

	// Enables Systems Manager to send command output to CloudWatch Logs.
	CloudWatchOutputEnabled bool
	// contains filtered or unexported fields
}

Configuration options for sending command output to Amazon CloudWatch Logs.

type Command 

type Command struct {

	// The details for the CloudWatch alarm applied to your command.
	AlarmConfiguration *AlarmConfiguration

	// Amazon CloudWatch Logs information where you want Amazon Web Services Systems
	// Manager to send the command output.
	CloudWatchOutputConfig *CloudWatchOutputConfig

	// A unique identifier for this command.
	CommandId *string

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

	// The number of targets for which the command invocation reached a terminal
	// state. Terminal states include the following: Success, Failed, Execution Timed
	// Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.
	CompletedCount int32

	// The number of targets for which the status is Delivery Timed Out.
	DeliveryTimedOutCount int32

	// The name of the document requested for execution.
	DocumentName *string

	// The Systems Manager document (SSM document) version.
	DocumentVersion *string

	// The number of targets for which the status is Failed or Execution Timed Out.
	ErrorCount int32

	// If a command expires, it changes status to DeliveryTimedOut for all invocations
	// that have the status InProgress , Pending , or Delayed . ExpiresAfter is
	// calculated based on the total timeout for the overall command. For more
	// information, see [Understanding command timeout values]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Understanding command timeout values]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html?icmpid=docs_ec2_console#monitor-about-status-timeouts
	ExpiresAfter *time.Time

	// The managed node IDs against which this command was requested.
	InstanceIds []string

	// The maximum number of managed nodes that are allowed to run the command at the
	// same time. You can specify a number of managed nodes, such as 10, or a
	// percentage of nodes, such as 10%. The default value is 50. For more information
	// about how to use MaxConcurrency , see [Amazon Web Services Systems Manager Run Command] in the Amazon Web Services Systems
	// Manager User Guide.
	//
	// [Amazon Web Services Systems Manager Run Command]: https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html
	MaxConcurrency *string

	// The maximum number of errors allowed before the system stops sending the
	// command to additional targets. You can specify a number of errors, such as 10,
	// or a percentage or errors, such as 10%. The default value is 0 . For more
	// information about how to use MaxErrors , see [Amazon Web Services Systems Manager Run Command] in the Amazon Web Services
	// Systems Manager User Guide.
	//
	// [Amazon Web Services Systems Manager Run Command]: https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html
	MaxErrors *string

	// Configurations for sending notifications about command status changes.
	NotificationConfig *NotificationConfig

	// The S3 bucket where the responses to the command executions should be stored.
	// This was requested when issuing the command.
	OutputS3BucketName *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

	// (Deprecated) You can no longer specify this parameter. The system ignores it.
	// Instead, Systems Manager automatically determines the Amazon Web Services Region
	// of the S3 bucket.
	OutputS3Region *string

	// The parameter values to be inserted in the document when running the command.
	Parameters map[string][]string

	// The date and time the command was requested.
	RequestedDateTime *time.Time

	// The Identity and Access Management (IAM) service role that Run Command, a
	// capability of Amazon Web Services Systems Manager, uses to act on your behalf
	// when sending notifications about command status changes.
	ServiceRole *string

	// The status of the command.
	Status CommandStatus

	// A detailed status of the command execution. StatusDetails includes more
	// information than Status because it includes states resulting from error and
	// concurrency control parameters. StatusDetails can show different results than
	// Status. For more information about these statuses, see [Understanding command statuses]in the Amazon Web
	// Services Systems Manager User Guide. StatusDetails can be one of the following
	// values:
	//
	//   - Pending: The command hasn't been sent to any managed nodes.
	//
	//   - In Progress: The command has been sent to at least one managed node but
	//   hasn't reached a final state on all managed nodes.
	//
	//   - Success: The command successfully ran on all invocations. This is a
	//   terminal state.
	//
	//   - Delivery Timed Out: The value of MaxErrors or more command invocations
	//   shows a status of Delivery Timed Out. This is a terminal state.
	//
	//   - Execution Timed Out: The value of MaxErrors or more command invocations
	//   shows a status of Execution Timed Out. This is a terminal state.
	//
	//   - Failed: The value of MaxErrors or more command invocations shows a status
	//   of Failed. This is a terminal state.
	//
	//   - Incomplete: The command was attempted on all managed nodes and one or more
	//   invocations doesn't have a value of Success but not enough invocations failed
	//   for the status to be Failed. This is a terminal state.
	//
	//   - Cancelled: The command was terminated before it was completed. This is a
	//   terminal state.
	//
	//   - Rate Exceeded: The number of managed nodes targeted by the command exceeded
	//   the account limit for pending invocations. The system has canceled the command
	//   before running it on any managed node. This is a terminal state.
	//
	//   - Delayed: The system attempted to send the command to the managed node but
	//   wasn't successful. The system retries again.
	//
	// [Understanding command statuses]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html
	StatusDetails *string

	// The number of targets for the command.
	TargetCount int32

	// An array of search criteria that targets managed nodes using a Key,Value
	// combination that you specify. Targets is required if you don't provide one or
	// more managed node IDs in the call.
	Targets []Target

	// The TimeoutSeconds value specified for a command.
	TimeoutSeconds *int32

	// The CloudWatch alarm that was invoked by the command.
	TriggeredAlarms []AlarmStateInformation
	// contains filtered or unexported fields
}

Describes a command request.

type CommandFilter 

type CommandFilter struct {

	// The name of the filter.
	//
	// The ExecutionStage filter can't be used with the ListCommandInvocations
	// operation, only with ListCommands .
	//
	// This member is required.
	Key CommandFilterKey

	// The filter value. Valid values for each filter key are as follows:
	//
	//   - InvokedAfter: Specify a timestamp to limit your results. For example,
	//   specify 2024-07-07T00:00:00Z to see a list of command executions occurring
	//   July 7, 2021, and later.
	//
	//   - InvokedBefore: Specify a timestamp to limit your results. For example,
	//   specify 2024-07-07T00:00:00Z to see a list of command executions from before
	//   July 7, 2021.
	//
	//   - Status: Specify a valid command status to see a list of all command
	//   executions with that status. The status choices depend on the API you call.
	//
	// The status values you can specify for ListCommands are:
	//
	//   - Pending
	//
	//   - InProgress
	//
	//   - Success
	//
	//   - Cancelled
	//
	//   - Failed
	//
	//   - TimedOut (this includes both Delivery and Execution time outs)
	//
	//   - AccessDenied
	//
	//   - DeliveryTimedOut
	//
	//   - ExecutionTimedOut
	//
	//   - Incomplete
	//
	//   - NoInstancesInTag
	//
	//   - LimitExceeded
	//
	// The status values you can specify for ListCommandInvocations are:
	//
	//   - Pending
	//
	//   - InProgress
	//
	//   - Delayed
	//
	//   - Success
	//
	//   - Cancelled
	//
	//   - Failed
	//
	//   - TimedOut (this includes both Delivery and Execution time outs)
	//
	//   - AccessDenied
	//
	//   - DeliveryTimedOut
	//
	//   - ExecutionTimedOut
	//
	//   - Undeliverable
	//
	//   - InvalidPlatform
	//
	//   - Terminated
	//
	//   - DocumentName: Specify name of the Amazon Web Services Systems Manager
	//   document (SSM document) for which you want to see command execution results. For
	//   example, specify AWS-RunPatchBaseline to see command executions that used this
	//   SSM document to perform security patching operations on managed nodes.
	//
	//   - ExecutionStage: Specify one of the following values ( ListCommands
	//   operations only):
	//
	//   - Executing : Returns a list of command executions that are currently still
	//   running.
	//
	//   - Complete : Returns a list of command executions that have already completed.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Describes a command filter.

A managed node ID can't be specified when a command status is Pending because the command hasn't run on the node yet.

type CommandFilterKey 

type CommandFilterKey string
const (
	CommandFilterKeyInvokedAfter   CommandFilterKey = "InvokedAfter"
	CommandFilterKeyInvokedBefore  CommandFilterKey = "InvokedBefore"
	CommandFilterKeyStatus         CommandFilterKey = "Status"
	CommandFilterKeyExecutionStage CommandFilterKey = "ExecutionStage"
	CommandFilterKeyDocumentName   CommandFilterKey = "DocumentName"
)

Enum values for CommandFilterKey

func (CommandFilterKey) Values added in v0.29.0 

func (CommandFilterKey) Values() []CommandFilterKey

Values returns all known values for CommandFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommandInvocation 

type CommandInvocation struct {

	// Amazon CloudWatch Logs information where you want Amazon Web Services Systems
	// Manager to send the command output.
	CloudWatchOutputConfig *CloudWatchOutputConfig

	// The command against which this invocation was requested.
	CommandId *string

	// Plugins processed by the command.
	CommandPlugins []CommandPlugin

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

	// The document name that was requested for execution.
	DocumentName *string

	// The Systems Manager document (SSM document) version.
	DocumentVersion *string

	// The managed node ID in which this invocation was requested.
	InstanceId *string

	// The fully qualified host name of the managed node.
	InstanceName *string

	// Configurations for sending notifications about command status changes on a per
	// managed node basis.
	NotificationConfig *NotificationConfig

	// The time and date the request was sent to this managed node.
	RequestedDateTime *time.Time

	// The Identity and Access Management (IAM) service role that Run Command, a
	// capability of Amazon Web Services Systems Manager, uses to act on your behalf
	// when sending notifications about command status changes on a per managed node
	// basis.
	ServiceRole *string

	// The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon
	// S3), if the S3 bucket was defined for the parent command. For an invocation,
	// StandardErrorUrl is populated if there is just one plugin defined for the
	// command, and the S3 bucket was defined for the command.
	StandardErrorUrl *string

	// The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon
	// S3), if the S3 bucket was defined for the parent command. For an invocation,
	// StandardOutputUrl is populated if there is just one plugin defined for the
	// command, and the S3 bucket was defined for the command.
	StandardOutputUrl *string

	// Whether or not the invocation succeeded, failed, or is pending.
	Status CommandInvocationStatus

	// A detailed status of the command execution for each invocation (each managed
	// node targeted by the command). StatusDetails includes more information than
	// Status because it includes states resulting from error and concurrency control
	// parameters. StatusDetails can show different results than Status. For more
	// information about these statuses, see [Understanding command statuses]in the Amazon Web Services Systems
	// Manager User Guide. StatusDetails can be one of the following values:
	//
	//   - Pending: The command hasn't been sent to the managed node.
	//
	//   - In Progress: The command has been sent to the managed node but hasn't
	//   reached a terminal state.
	//
	//   - Success: The execution of the command or plugin was successfully completed.
	//   This is a terminal state.
	//
	//   - Delivery Timed Out: The command wasn't delivered to the managed node before
	//   the delivery timeout expired. Delivery timeouts don't count against the parent
	//   command's MaxErrors limit, but they do contribute to whether the parent
	//   command status is Success or Incomplete. This is a terminal state.
	//
	//   - Execution Timed Out: Command execution started on the managed node, but the
	//   execution wasn't complete before the execution timeout expired. Execution
	//   timeouts count against the MaxErrors limit of the parent command. This is a
	//   terminal state.
	//
	//   - Failed: The command wasn't successful on the managed node. For a plugin,
	//   this indicates that the result code wasn't zero. For a command invocation, this
	//   indicates that the result code for one or more plugins wasn't zero. Invocation
	//   failures count against the MaxErrors limit of the parent command. This is a
	//   terminal state.
	//
	//   - Cancelled: The command was terminated before it was completed. This is a
	//   terminal state.
	//
	//   - Undeliverable: The command can't be delivered to the managed node. The
	//   managed node might not exist or might not be responding. Undeliverable
	//   invocations don't count against the parent command's MaxErrors limit and don't
	//   contribute to whether the parent command status is Success or Incomplete. This
	//   is a terminal state.
	//
	//   - Terminated: The parent command exceeded its MaxErrors limit and subsequent
	//   command invocations were canceled by the system. This is a terminal state.
	//
	//   - Delayed: The system attempted to send the command to the managed node but
	//   wasn't successful. The system retries again.
	//
	// [Understanding command statuses]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html
	StatusDetails *string

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

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

type CommandInvocationStatus 

type CommandInvocationStatus string
const (
	CommandInvocationStatusPending    CommandInvocationStatus = "Pending"
	CommandInvocationStatusInProgress CommandInvocationStatus = "InProgress"
	CommandInvocationStatusDelayed    CommandInvocationStatus = "Delayed"
	CommandInvocationStatusSuccess    CommandInvocationStatus = "Success"
	CommandInvocationStatusCancelled  CommandInvocationStatus = "Cancelled"
	CommandInvocationStatusTimedOut   CommandInvocationStatus = "TimedOut"
	CommandInvocationStatusFailed     CommandInvocationStatus = "Failed"
	CommandInvocationStatusCancelling CommandInvocationStatus = "Cancelling"
)

Enum values for CommandInvocationStatus

func (CommandInvocationStatus) Values added in v0.29.0 

func (CommandInvocationStatus) Values() []CommandInvocationStatus

Values returns all known values for CommandInvocationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommandPlugin 

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

	// Output of the plugin execution.
	Output *string

	// The S3 bucket where the responses to the command executions should be stored.
	// This was requested when issuing the command. For example, in the following
	// response:
	//
	//     amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript
	//
	// amzn-s3-demo-bucket is the name of the S3 bucket;
	//
	// my-prefix is the name of the S3 prefix;
	//
	// i-02573cafcfEXAMPLE is the managed node ID;
	//
	// awsrunShellScript is the name of the plugin.
	OutputS3BucketName *string

	// The S3 directory path inside the bucket where the responses to the command
	// executions should be stored. This was requested when issuing the command. For
	// example, in the following response:
	//
	//     amzn-s3-demo-bucket/my-prefix/i-02573cafcfEXAMPLE/awsrunShellScript
	//
	// amzn-s3-demo-bucket is the name of the S3 bucket;
	//
	// my-prefix is the name of the S3 prefix;
	//
	// i-02573cafcfEXAMPLE is the managed node ID;
	//
	// awsrunShellScript is the name of the plugin.
	OutputS3KeyPrefix *string

	// (Deprecated) You can no longer specify this parameter. The system ignores it.
	// Instead, Amazon Web Services Systems Manager automatically determines the S3
	// bucket region.
	OutputS3Region *string

	// A numeric response code generated after running the plugin.
	ResponseCode int32

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

	// The time the plugin started running.
	ResponseStartDateTime *time.Time

	// The URL for the complete text written by the plugin to stderr. If execution
	// isn't yet complete, then this string is empty.
	StandardErrorUrl *string

	// The URL for the complete text written by the plugin to stdout in Amazon S3. If
	// the S3 bucket for the command wasn't specified, then this string is empty.
	StandardOutputUrl *string

	// The status of this plugin. You can run a document with multiple plugins.
	Status CommandPluginStatus

	// A detailed status of the plugin execution. StatusDetails includes more
	// information than Status because it includes states resulting from error and
	// concurrency control parameters. StatusDetails can show different results than
	// Status. For more information about these statuses, see [Understanding command statuses]in the Amazon Web
	// Services Systems Manager User Guide. StatusDetails can be one of the following
	// values:
	//
	//   - Pending: The command hasn't been sent to the managed node.
	//
	//   - In Progress: The command has been sent to the managed node but hasn't
	//   reached a terminal state.
	//
	//   - Success: The execution of the command or plugin was successfully completed.
	//   This is a terminal state.
	//
	//   - Delivery Timed Out: The command wasn't delivered to the managed node before
	//   the delivery timeout expired. Delivery timeouts don't count against the parent
	//   command's MaxErrors limit, but they do contribute to whether the parent
	//   command status is Success or Incomplete. This is a terminal state.
	//
	//   - Execution Timed Out: Command execution started on the managed node, but the
	//   execution wasn't complete before the execution timeout expired. Execution
	//   timeouts count against the MaxErrors limit of the parent command. This is a
	//   terminal state.
	//
	//   - Failed: The command wasn't successful on the managed node. For a plugin,
	//   this indicates that the result code wasn't zero. For a command invocation, this
	//   indicates that the result code for one or more plugins wasn't zero. Invocation
	//   failures count against the MaxErrors limit of the parent command. This is a
	//   terminal state.
	//
	//   - Cancelled: The command was terminated before it was completed. This is a
	//   terminal state.
	//
	//   - Undeliverable: The command can't be delivered to the managed node. The
	//   managed node might not exist, or it might not be responding. Undeliverable
	//   invocations don't count against the parent command's MaxErrors limit, and they
	//   don't contribute to whether the parent command status is Success or Incomplete.
	//   This is a terminal state.
	//
	//   - Terminated: The parent command exceeded its MaxErrors limit and subsequent
	//   command invocations were canceled by the system. This is a terminal state.
	//
	// [Understanding command statuses]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html
	StatusDetails *string
	// contains filtered or unexported fields
}

Describes plugin details.

type CommandPluginStatus 

type CommandPluginStatus string
const (
	CommandPluginStatusPending    CommandPluginStatus = "Pending"
	CommandPluginStatusInProgress CommandPluginStatus = "InProgress"
	CommandPluginStatusSuccess    CommandPluginStatus = "Success"
	CommandPluginStatusTimedOut   CommandPluginStatus = "TimedOut"
	CommandPluginStatusCancelled  CommandPluginStatus = "Cancelled"
	CommandPluginStatusFailed     CommandPluginStatus = "Failed"
)

Enum values for CommandPluginStatus

func (CommandPluginStatus) Values added in v0.29.0 

func (CommandPluginStatus) Values() []CommandPluginStatus

Values returns all known values for CommandPluginStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CommandStatus 

type CommandStatus string
const (
	CommandStatusPending    CommandStatus = "Pending"
	CommandStatusInProgress CommandStatus = "InProgress"
	CommandStatusSuccess    CommandStatus = "Success"
	CommandStatusCancelled  CommandStatus = "Cancelled"
	CommandStatusFailed     CommandStatus = "Failed"
	CommandStatusTimedOut   CommandStatus = "TimedOut"
	CommandStatusCancelling CommandStatus = "Cancelling"
)

Enum values for CommandStatus

func (CommandStatus) Values added in v0.29.0 

func (CommandStatus) Values() []CommandStatus

Values returns all known values for CommandStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ComplianceExecutionSummary 

type ComplianceExecutionSummary struct {

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

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

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

A summary of the call execution that includes an execution ID, the type of execution (for example, Command ), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

type ComplianceItem 

type ComplianceItem struct {

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

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

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

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

	// An ID for the resource. For a managed node, this is the node ID.
	ResourceId *string

	// The type of resource. ManagedInstance is currently the only supported resource
	// type.
	ResourceType *string

	// The severity of the compliance status. Severity can be one of the following:
	// Critical, High, Medium, Low, Informational, Unspecified.
	Severity ComplianceSeverity

	// The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT,
	// or an empty string (for Windows patches that aren't applicable).
	Status ComplianceStatus

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

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

type ComplianceItemEntry 

type ComplianceItemEntry struct {

	// The severity of the compliance status. Severity can be one of the following:
	// Critical, High, Medium, Low, Informational, Unspecified.
	//
	// This member is required.
	Severity ComplianceSeverity

	// The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.
	//
	// This member is required.
	Status ComplianceStatus

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

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

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

Information about a compliance item.

type ComplianceQueryOperatorType 

type ComplianceQueryOperatorType string
const (
	ComplianceQueryOperatorTypeEqual       ComplianceQueryOperatorType = "EQUAL"
	ComplianceQueryOperatorTypeNotEqual    ComplianceQueryOperatorType = "NOT_EQUAL"
	ComplianceQueryOperatorTypeBeginWith   ComplianceQueryOperatorType = "BEGIN_WITH"
	ComplianceQueryOperatorTypeLessThan    ComplianceQueryOperatorType = "LESS_THAN"
	ComplianceQueryOperatorTypeGreaterThan ComplianceQueryOperatorType = "GREATER_THAN"
)

Enum values for ComplianceQueryOperatorType

func (ComplianceQueryOperatorType) Values added in v0.29.0 

func (ComplianceQueryOperatorType) Values() []ComplianceQueryOperatorType

Values returns all known values for ComplianceQueryOperatorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ComplianceSeverity 

type ComplianceSeverity string
const (
	ComplianceSeverityCritical      ComplianceSeverity = "CRITICAL"
	ComplianceSeverityHigh          ComplianceSeverity = "HIGH"
	ComplianceSeverityMedium        ComplianceSeverity = "MEDIUM"
	ComplianceSeverityLow           ComplianceSeverity = "LOW"
	ComplianceSeverityInformational ComplianceSeverity = "INFORMATIONAL"
	ComplianceSeverityUnspecified   ComplianceSeverity = "UNSPECIFIED"
)

Enum values for ComplianceSeverity

func (ComplianceSeverity) Values added in v0.29.0 

func (ComplianceSeverity) Values() []ComplianceSeverity

Values returns all known values for ComplianceSeverity. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ComplianceStatus 

type ComplianceStatus string
const (
	ComplianceStatusCompliant    ComplianceStatus = "COMPLIANT"
	ComplianceStatusNonCompliant ComplianceStatus = "NON_COMPLIANT"
)

Enum values for ComplianceStatus

func (ComplianceStatus) Values added in v0.29.0 

func (ComplianceStatus) Values() []ComplianceStatus

Values returns all known values for ComplianceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ComplianceStringFilter 

type ComplianceStringFilter struct {

	// The name of the filter.
	Key *string

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

	// The value for which to search.
	Values []string
	// contains filtered or unexported fields
}

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

type ComplianceSummaryItem 

type ComplianceSummaryItem struct {

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

	// A list of COMPLIANT items for the specified compliance type.
	CompliantSummary *CompliantSummary

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

A summary of compliance information by compliance type.

type ComplianceTypeCountLimitExceededException 

type ComplianceTypeCountLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You specified too many custom compliance types. You can specify a maximum of 10 different types.

func (*ComplianceTypeCountLimitExceededException) Error 

func (e *ComplianceTypeCountLimitExceededException) Error() string

func (*ComplianceTypeCountLimitExceededException) ErrorCode 

func (e *ComplianceTypeCountLimitExceededException) ErrorCode() string

func (*ComplianceTypeCountLimitExceededException) ErrorFault 

func (e *ComplianceTypeCountLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ComplianceTypeCountLimitExceededException) ErrorMessage 

func (e *ComplianceTypeCountLimitExceededException) ErrorMessage() string

type ComplianceUploadType 

type ComplianceUploadType string
const (
	ComplianceUploadTypeComplete ComplianceUploadType = "COMPLETE"
	ComplianceUploadTypePartial  ComplianceUploadType = "PARTIAL"
)

Enum values for ComplianceUploadType

func (ComplianceUploadType) Values added in v0.29.0 

func (ComplianceUploadType) Values() []ComplianceUploadType

Values returns all known values for ComplianceUploadType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CompliantSummary 

type CompliantSummary struct {

	// The total number of resources that are compliant.
	CompliantCount int32

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

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

type ConnectionStatus 

type ConnectionStatus string
const (
	ConnectionStatusConnected    ConnectionStatus = "connected"
	ConnectionStatusNotConnected ConnectionStatus = "notconnected"
)

Enum values for ConnectionStatus

func (ConnectionStatus) Values added in v0.29.0 

func (ConnectionStatus) Values() []ConnectionStatus

Values returns all known values for ConnectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CreateAssociationBatchRequestEntry 

type CreateAssociationBatchRequestEntry struct {

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

	// The details for the CloudWatch alarm you want to apply to an automation or
	// command.
	AlarmConfiguration *AlarmConfiguration

	// By default, when you create a new associations, the system runs it immediately
	// after it is created and then according to the schedule you specified. Specify
	// this option if you don't want an association to run immediately after you create
	// it. This parameter isn't supported for rate expressions.
	ApplyOnlyAtCronInterval bool

	// Specify a descriptive name for the association.
	AssociationName *string

	// Specify the target for the association. This target is required for
	// associations that use an Automation runbook and target resources by using rate
	// controls. Automation is a capability of Amazon Web Services Systems Manager.
	AutomationTargetParameterName *string

	// The names or Amazon Resource Names (ARNs) of the Change Calendar type documents
	// your associations are gated under. The associations only run when that Change
	// Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar].
	//
	// [Amazon Web Services Systems Manager Change Calendar]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar
	CalendarNames []string

	// The severity level to assign to the association.
	ComplianceSeverity AssociationComplianceSeverity

	// The document version.
	DocumentVersion *string

	// The number of hours the association can run before it is canceled. Duration
	// applies to associations that are currently running, and any pending and in
	// progress commands on all targets. If a target was taken offline for the
	// association to run, it is made available again immediately, without a reboot.
	//
	// The Duration parameter applies only when both these conditions are true:
	//
	//   - The association for which you specify a duration is cancelable according to
	//   the parameters of the SSM command document or Automation runbook associated with
	//   this execution.
	//
	//   - The command specifies the [ApplyOnlyAtCronInterval]parameter, which means that the association
	//   doesn't run immediately after it is created, but only according to the specified
	//   schedule.
	//
	// [ApplyOnlyAtCronInterval]: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociationBatchRequestEntry.html#systemsmanager-Type-CreateAssociationBatchRequestEntry-ApplyOnlyAtCronInterval
	Duration *int32

	// The managed node ID.
	//
	// InstanceId has been deprecated. To specify a managed node ID for an
	// association, use the Targets parameter. Requests that include the parameter
	// InstanceID with Systems Manager documents (SSM documents) that use schema
	// version 2.0 or later will fail. In addition, if you use the parameter InstanceId
	// , you can't use the parameters AssociationName , DocumentVersion , MaxErrors ,
	// MaxConcurrency , OutputLocation , or ScheduleExpression . To use these
	// parameters, you must use the Targets parameter.
	InstanceId *string

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

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

	// An S3 bucket where you want to store the results of this request.
	OutputLocation *InstanceAssociationOutputLocation

	// A description of the parameters for a document.
	Parameters map[string][]string

	// A cron expression that specifies a schedule when the association runs.
	ScheduleExpression *string

	// Number of days to wait after the scheduled day to run an association.
	ScheduleOffset *int32

	// The mode for generating association compliance. You can specify AUTO or MANUAL .
	// In AUTO mode, the system uses the status of the association execution to
	// determine the compliance status. If the association execution runs successfully,
	// then the association is COMPLIANT . If the association execution doesn't run
	// successfully, the association is NON-COMPLIANT .
	//
	// In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API
	// operation. In this case, compliance data isn't managed by State Manager, a
	// capability of Amazon Web Services Systems Manager. It is managed by your direct
	// call to the PutComplianceItemsAPI operation.
	//
	// By default, all associations use AUTO mode.
	SyncCompliance AssociationSyncCompliance

	// Use this action to create an association in multiple Regions and multiple
	// accounts.
	TargetLocations []TargetLocation

	// A key-value mapping of document parameters to target resources. Both Targets
	// and TargetMaps can't be specified together.
	TargetMaps []map[string][]string

	// The managed nodes targeted by the request.
	Targets []Target
	// contains filtered or unexported fields
}

Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

type CustomSchemaCountLimitExceededException 

type CustomSchemaCountLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

func (*CustomSchemaCountLimitExceededException) Error 

func (e *CustomSchemaCountLimitExceededException) Error() string

func (*CustomSchemaCountLimitExceededException) ErrorCode 

func (e *CustomSchemaCountLimitExceededException) ErrorCode() string

func (*CustomSchemaCountLimitExceededException) ErrorFault 

func (e *CustomSchemaCountLimitExceededException) ErrorFault() smithy.ErrorFault

func (*CustomSchemaCountLimitExceededException) ErrorMessage 

func (e *CustomSchemaCountLimitExceededException) ErrorMessage() string

type DescribeActivationsFilter 

type DescribeActivationsFilter struct {

	// The name of the filter.
	FilterKey DescribeActivationsFilterKeys

	// The filter values.
	FilterValues []string
	// contains filtered or unexported fields
}

Filter for the DescribeActivation API.

type DescribeActivationsFilterKeys 

type DescribeActivationsFilterKeys string
const (
	DescribeActivationsFilterKeysActivationIds       DescribeActivationsFilterKeys = "ActivationIds"
	DescribeActivationsFilterKeysDefaultInstanceName DescribeActivationsFilterKeys = "DefaultInstanceName"
	DescribeActivationsFilterKeysIamRole             DescribeActivationsFilterKeys = "IamRole"
)

Enum values for DescribeActivationsFilterKeys

func (DescribeActivationsFilterKeys) Values added in v0.29.0 

func (DescribeActivationsFilterKeys) Values() []DescribeActivationsFilterKeys

Values returns all known values for DescribeActivationsFilterKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentAlreadyExists 

type DocumentAlreadyExists struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified document already exists.

func (*DocumentAlreadyExists) Error 

func (e *DocumentAlreadyExists) Error() string

func (*DocumentAlreadyExists) ErrorCode 

func (e *DocumentAlreadyExists) ErrorCode() string

func (*DocumentAlreadyExists) ErrorFault 

func (e *DocumentAlreadyExists) ErrorFault() smithy.ErrorFault

func (*DocumentAlreadyExists) ErrorMessage 

func (e *DocumentAlreadyExists) ErrorMessage() string

type DocumentDefaultVersionDescription 

type DocumentDefaultVersionDescription struct {

	// The default version of the document.
	DefaultVersion *string

	// The default version of the artifact associated with the document.
	DefaultVersionName *string

	// The name of the document.
	Name *string
	// contains filtered or unexported fields
}

A default version of a document.

type DocumentDescription 

type DocumentDescription struct {

	// The version of the document currently approved for use in the organization.
	ApprovedVersion *string

	// Details about the document attachments, including names, locations, sizes, and
	// so on.
	AttachmentsInformation []AttachmentInformation

	// The user in your organization who created the document.
	Author *string

	// The classification of a document to help you identify and categorize its use.
	Category []string

	// The value that identifies a document's category.
	CategoryEnum []string

	// The date when the document was created.
	CreatedDate *time.Time

	// The default version.
	DefaultVersion *string

	// A description of the document.
	Description *string

	// The friendly name of the SSM document. This value can differ for each version
	// of the document. If you want to update this value, see UpdateDocument.
	DisplayName *string

	// The document format, either JSON or YAML.
	DocumentFormat DocumentFormat

	// The type of document.
	DocumentType DocumentType

	// The document version.
	DocumentVersion *string

	// The Sha256 or Sha1 hash created by the system when the document was created.
	//
	// Sha1 hashes have been deprecated.
	Hash *string

	// The hash type of the document. Valid values include Sha256 or Sha1 .
	//
	// Sha1 hashes have been deprecated.
	HashType DocumentHashType

	// The latest version of the document.
	LatestVersion *string

	// The name of the SSM document.
	Name *string

	// The Amazon Web Services user that created the document.
	Owner *string

	// A description of the parameters for a document.
	Parameters []DocumentParameter

	// The version of the document that is currently under review.
	PendingReviewVersion *string

	// The list of operating system (OS) platforms compatible with this SSM document.
	PlatformTypes []PlatformType

	// A list of SSM documents required by a document. For example, an
	// ApplicationConfiguration document requires an ApplicationConfigurationSchema
	// document.
	Requires []DocumentRequires

	// Details about the review of a document.
	ReviewInformation []ReviewInformation

	// The current status of the review.
	ReviewStatus ReviewStatus

	// The schema version.
	SchemaVersion *string

	// The SHA1 hash of the document, which you can use for verification.
	Sha1 *string

	// The status of the SSM document.
	Status DocumentStatus

	// A message returned by Amazon Web Services Systems Manager that explains the
	// Status value. For example, a Failed status might be explained by the
	// StatusInformation message, "The specified S3 bucket doesn't exist. Verify that
	// the URL of the S3 bucket is correct."
	StatusInformation *string

	// The tags, or metadata, that have been applied to the document.
	Tags []Tag

	// The target type which defines the kinds of resources the document can run on.
	// For example, /AWS::EC2::Instance . For a list of valid resource types, see [Amazon Web Services resource and property types reference] in
	// the CloudFormation User Guide.
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	TargetType *string

	// The version of the artifact associated with the document.
	VersionName *string
	// contains filtered or unexported fields
}

Describes an Amazon Web Services Systems Manager document (SSM document).

type DocumentFilter 

type DocumentFilter struct {

	// The name of the filter.
	//
	// This member is required.
	Key DocumentFilterKey

	// The value of the filter.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

This data type is deprecated. Instead, use DocumentKeyValuesFilter.

type DocumentFilterKey 

type DocumentFilterKey string
const (
	DocumentFilterKeyName          DocumentFilterKey = "Name"
	DocumentFilterKeyOwner         DocumentFilterKey = "Owner"
	DocumentFilterKeyPlatformTypes DocumentFilterKey = "PlatformTypes"
	DocumentFilterKeyDocumentType  DocumentFilterKey = "DocumentType"
)

Enum values for DocumentFilterKey

func (DocumentFilterKey) Values added in v0.29.0 

func (DocumentFilterKey) Values() []DocumentFilterKey

Values returns all known values for DocumentFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentFormat 

type DocumentFormat string
const (
	DocumentFormatYaml DocumentFormat = "YAML"
	DocumentFormatJson DocumentFormat = "JSON"
	DocumentFormatText DocumentFormat = "TEXT"
)

Enum values for DocumentFormat

func (DocumentFormat) Values added in v0.29.0 

func (DocumentFormat) Values() []DocumentFormat

Values returns all known values for DocumentFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentHashType 

type DocumentHashType string
const (
	DocumentHashTypeSha256 DocumentHashType = "Sha256"
	DocumentHashTypeSha1   DocumentHashType = "Sha1"
)

Enum values for DocumentHashType

func (DocumentHashType) Values added in v0.29.0 

func (DocumentHashType) Values() []DocumentHashType

Values returns all known values for DocumentHashType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentIdentifier 

type DocumentIdentifier struct {

	// The user in your organization who created the document.
	Author *string

	// The date the SSM document was created.
	CreatedDate *time.Time

	// An optional field where you can specify a friendly name for the SSM document.
	// This value can differ for each version of the document. If you want to update
	// this value, see UpdateDocument.
	DisplayName *string

	// The document format, either JSON or YAML.
	DocumentFormat DocumentFormat

	// The document type.
	DocumentType DocumentType

	// The document version.
	DocumentVersion *string

	// The name of the SSM document.
	Name *string

	// The Amazon Web Services user that created the document.
	Owner *string

	// The operating system platform.
	PlatformTypes []PlatformType

	// A list of SSM documents required by a document. For example, an
	// ApplicationConfiguration document requires an ApplicationConfigurationSchema
	// document.
	Requires []DocumentRequires

	// The current status of a document review.
	ReviewStatus ReviewStatus

	// The schema version.
	SchemaVersion *string

	// The tags, or metadata, that have been applied to the document.
	Tags []Tag

	// The target type which defines the kinds of resources the document can run on.
	// For example, /AWS::EC2::Instance . For a list of valid resource types, see [Amazon Web Services resource and property types reference] in
	// the CloudFormation User Guide.
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	TargetType *string

	// An optional field specifying the version of the artifact associated with the
	// document. For example, 12.6. This value is unique across all versions of a
	// document, and can't be changed.
	VersionName *string
	// contains filtered or unexported fields
}

Describes the name of a SSM document.

type DocumentKeyValuesFilter 

type DocumentKeyValuesFilter struct {

	// The name of the filter key.
	Key *string

	// The value for the filter key.
	Values []string
	// contains filtered or unexported fields
}

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

For keys, you can specify one or more tags that have been applied to a document.

You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:

DocumentType

  • ApplicationConfiguration

  • ApplicationConfigurationSchema

  • Automation

  • ChangeCalendar

  • Command

  • Package

  • Policy

  • Session

Owner Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self .

  • Amazon

  • Private

  • Public

  • Self

  • ThirdParty

PlatformTypes

  • Linux

  • Windows

Name is another Amazon Web Services-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with Te , run the following command: 

aws ssm list-documents --filters Key=Name,Values=Te

You can also use the TargetType Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types referencein the CloudFormation User Guide.

If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.

To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName .

For example, if you created a key called region and are using the Amazon Web Services CLI to call the list-documents command: 

aws ssm list-documents --filters Key=tag:region,Values=east,west
Key=Owner,Values=Self

type DocumentLimitExceeded 

type DocumentLimitExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You can have at most 500 active SSM documents.

func (*DocumentLimitExceeded) Error 

func (e *DocumentLimitExceeded) Error() string

func (*DocumentLimitExceeded) ErrorCode 

func (e *DocumentLimitExceeded) ErrorCode() string

func (*DocumentLimitExceeded) ErrorFault 

func (e *DocumentLimitExceeded) ErrorFault() smithy.ErrorFault

func (*DocumentLimitExceeded) ErrorMessage 

func (e *DocumentLimitExceeded) ErrorMessage() string

type DocumentMetadataEnum added in v0.31.0 

type DocumentMetadataEnum string
const (
	DocumentMetadataEnumDocumentReviews DocumentMetadataEnum = "DocumentReviews"
)

Enum values for DocumentMetadataEnum

func (DocumentMetadataEnum) Values added in v0.31.0 

func (DocumentMetadataEnum) Values() []DocumentMetadataEnum

Values returns all known values for DocumentMetadataEnum. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentMetadataResponseInfo added in v0.31.0 

type DocumentMetadataResponseInfo struct {

	// Details about a reviewer's response to a document review request.
	ReviewerResponse []DocumentReviewerResponseSource
	// contains filtered or unexported fields
}

Details about the response to a document review request.

type DocumentParameter 

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

	// A description of what the parameter does, how to use it, the default value, and
	// whether or not the parameter is optional.
	Description *string

	// The name of the parameter.
	Name *string

	// The type of parameter. The type can be either String or StringList.
	Type DocumentParameterType
	// contains filtered or unexported fields
}

Parameters specified in a Systems Manager document that run on the server when the command is run.

type DocumentParameterType 

type DocumentParameterType string
const (
	DocumentParameterTypeString     DocumentParameterType = "String"
	DocumentParameterTypeStringList DocumentParameterType = "StringList"
)

Enum values for DocumentParameterType

func (DocumentParameterType) Values added in v0.29.0 

func (DocumentParameterType) Values() []DocumentParameterType

Values returns all known values for DocumentParameterType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentPermissionLimit 

type DocumentPermissionLimit struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.

By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.

If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.

func (*DocumentPermissionLimit) Error 

func (e *DocumentPermissionLimit) Error() string

func (*DocumentPermissionLimit) ErrorCode 

func (e *DocumentPermissionLimit) ErrorCode() string

func (*DocumentPermissionLimit) ErrorFault 

func (e *DocumentPermissionLimit) ErrorFault() smithy.ErrorFault

func (*DocumentPermissionLimit) ErrorMessage 

func (e *DocumentPermissionLimit) ErrorMessage() string

type DocumentPermissionType 

type DocumentPermissionType string
const (
	DocumentPermissionTypeShare DocumentPermissionType = "Share"
)

Enum values for DocumentPermissionType

func (DocumentPermissionType) Values added in v0.29.0 

func (DocumentPermissionType) Values() []DocumentPermissionType

Values returns all known values for DocumentPermissionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentRequires 

type DocumentRequires struct {

	// The name of the required SSM document. The name can be an Amazon Resource Name
	// (ARN).
	//
	// This member is required.
	Name *string

	// The document type of the required SSM document.
	RequireType *string

	// The document version required by the current document.
	Version *string

	// An optional field specifying the version of the artifact associated with the
	// document. For example, 12.6. This value is unique across all versions of a
	// document, and can't be changed.
	VersionName *string
	// contains filtered or unexported fields
}

An SSM document required by the current document.

type DocumentReviewAction added in v0.31.0 

type DocumentReviewAction string
const (
	DocumentReviewActionSendForReview DocumentReviewAction = "SendForReview"
	DocumentReviewActionUpdateReview  DocumentReviewAction = "UpdateReview"
	DocumentReviewActionApprove       DocumentReviewAction = "Approve"
	DocumentReviewActionReject        DocumentReviewAction = "Reject"
)

Enum values for DocumentReviewAction

func (DocumentReviewAction) Values added in v0.31.0 

func (DocumentReviewAction) Values() []DocumentReviewAction

Values returns all known values for DocumentReviewAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentReviewCommentSource added in v0.31.0 

type DocumentReviewCommentSource struct {

	// The content of a comment entered by a user who requests a review of a new
	// document version, or who reviews the new version.
	Content *string

	// The type of information added to a review request. Currently, only the value
	// Comment is supported.
	Type DocumentReviewCommentType
	// contains filtered or unexported fields
}

Information about comments added to a document review request.

type DocumentReviewCommentType added in v0.31.0 

type DocumentReviewCommentType string
const (
	DocumentReviewCommentTypeComment DocumentReviewCommentType = "Comment"
)

Enum values for DocumentReviewCommentType

func (DocumentReviewCommentType) Values added in v0.31.0 

func (DocumentReviewCommentType) Values() []DocumentReviewCommentType

Values returns all known values for DocumentReviewCommentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentReviewerResponseSource added in v0.31.0 

type DocumentReviewerResponseSource struct {

	// The comment entered by a reviewer as part of their document review response.
	Comment []DocumentReviewCommentSource

	// The date and time that a reviewer entered a response to a document review
	// request.
	CreateTime *time.Time

	// The current review status of a new custom SSM document created by a member of
	// your organization, or of the latest version of an existing SSM document.
	//
	// Only one version of a document can be in the APPROVED state at a time. When a
	// new version is approved, the status of the previous version changes to REJECTED.
	//
	// Only one version of a document can be in review, or PENDING, at a time.
	ReviewStatus ReviewStatus

	// The user in your organization assigned to review a document request.
	Reviewer *string

	// The date and time that a reviewer last updated a response to a document review
	// request.
	UpdatedTime *time.Time
	// contains filtered or unexported fields
}

Information about a reviewer's response to a document review request.

type DocumentReviews added in v0.31.0 

type DocumentReviews struct {

	// The action to take on a document approval review request.
	//
	// This member is required.
	Action DocumentReviewAction

	// A comment entered by a user in your organization about the document review
	// request.
	Comment []DocumentReviewCommentSource
	// contains filtered or unexported fields
}

Information about a document approval review.

type DocumentStatus 

type DocumentStatus string
const (
	DocumentStatusCreating DocumentStatus = "Creating"
	DocumentStatusActive   DocumentStatus = "Active"
	DocumentStatusUpdating DocumentStatus = "Updating"
	DocumentStatusDeleting DocumentStatus = "Deleting"
	DocumentStatusFailed   DocumentStatus = "Failed"
)

Enum values for DocumentStatus

func (DocumentStatus) Values added in v0.29.0 

func (DocumentStatus) Values() []DocumentStatus

Values returns all known values for DocumentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentType 

type DocumentType string
const (
	DocumentTypeCommand                        DocumentType = "Command"
	DocumentTypePolicy                         DocumentType = "Policy"
	DocumentTypeAutomation                     DocumentType = "Automation"
	DocumentTypeSession                        DocumentType = "Session"
	DocumentTypePackage                        DocumentType = "Package"
	DocumentTypeApplicationConfiguration       DocumentType = "ApplicationConfiguration"
	DocumentTypeApplicationConfigurationSchema DocumentType = "ApplicationConfigurationSchema"
	DocumentTypeDeploymentStrategy             DocumentType = "DeploymentStrategy"
	DocumentTypeChangeCalendar                 DocumentType = "ChangeCalendar"
	DocumentTypeChangeTemplate                 DocumentType = "Automation.ChangeTemplate"
	DocumentTypeProblemAnalysis                DocumentType = "ProblemAnalysis"
	DocumentTypeProblemAnalysisTemplate        DocumentType = "ProblemAnalysisTemplate"
	DocumentTypeCloudFormation                 DocumentType = "CloudFormation"
	DocumentTypeConformancePackTemplate        DocumentType = "ConformancePackTemplate"
	DocumentTypeQuickSetup                     DocumentType = "QuickSetup"
)

Enum values for DocumentType

func (DocumentType) Values added in v0.29.0 

func (DocumentType) Values() []DocumentType

Values returns all known values for DocumentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DocumentVersionInfo 

type DocumentVersionInfo struct {

	// The date the document was created.
	CreatedDate *time.Time

	// The friendly name of the SSM document. This value can differ for each version
	// of the document. If you want to update this value, see UpdateDocument.
	DisplayName *string

	// The document format, either JSON or YAML.
	DocumentFormat DocumentFormat

	// The document version.
	DocumentVersion *string

	// An identifier for the default version of the document.
	IsDefaultVersion bool

	// The document name.
	Name *string

	// The current status of the approval review for the latest version of the
	// document.
	ReviewStatus ReviewStatus

	// The status of the SSM document, such as Creating , Active , Failed , and
	// Deleting .
	Status DocumentStatus

	// A message returned by Amazon Web Services Systems Manager that explains the
	// Status value. For example, a Failed status might be explained by the
	// StatusInformation message, "The specified S3 bucket doesn't exist. Verify that
	// the URL of the S3 bucket is correct."
	StatusInformation *string

	// The version of the artifact associated with the document. For example, 12.6.
	// This value is unique across all versions of a document, and can't be changed.
	VersionName *string
	// contains filtered or unexported fields
}

Version information about the document.

type DocumentVersionLimitExceeded 

type DocumentVersionLimitExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The document has too many versions. Delete one or more document versions and try again.

func (*DocumentVersionLimitExceeded) Error 

func (e *DocumentVersionLimitExceeded) Error() string

func (*DocumentVersionLimitExceeded) ErrorCode 

func (e *DocumentVersionLimitExceeded) ErrorCode() string

func (*DocumentVersionLimitExceeded) ErrorFault 

func (e *DocumentVersionLimitExceeded) ErrorFault() smithy.ErrorFault

func (*DocumentVersionLimitExceeded) ErrorMessage 

func (e *DocumentVersionLimitExceeded) ErrorMessage() string

type DoesNotExistException 

type DoesNotExistException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

For information about resource quotas in Amazon Web Services Systems Manager, see Systems Manager service quotasin the Amazon Web Services General Reference.

func (*DoesNotExistException) Error 

func (e *DoesNotExistException) Error() string

func (*DoesNotExistException) ErrorCode 

func (e *DoesNotExistException) ErrorCode() string

func (*DoesNotExistException) ErrorFault 

func (e *DoesNotExistException) ErrorFault() smithy.ErrorFault

func (*DoesNotExistException) ErrorMessage 

func (e *DoesNotExistException) ErrorMessage() string

type DuplicateDocumentContent 

type DuplicateDocumentContent struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The content of the association document matches another document. Change the content of the document and try again.

func (*DuplicateDocumentContent) Error 

func (e *DuplicateDocumentContent) Error() string

func (*DuplicateDocumentContent) ErrorCode 

func (e *DuplicateDocumentContent) ErrorCode() string

func (*DuplicateDocumentContent) ErrorFault 

func (e *DuplicateDocumentContent) ErrorFault() smithy.ErrorFault

func (*DuplicateDocumentContent) ErrorMessage 

func (e *DuplicateDocumentContent) ErrorMessage() string

type DuplicateDocumentVersionName 

type DuplicateDocumentVersionName struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The version name has already been used in this document. Specify a different version name, and then try again.

func (*DuplicateDocumentVersionName) Error 

func (e *DuplicateDocumentVersionName) Error() string

func (*DuplicateDocumentVersionName) ErrorCode 

func (e *DuplicateDocumentVersionName) ErrorCode() string

func (*DuplicateDocumentVersionName) ErrorFault 

func (e *DuplicateDocumentVersionName) ErrorFault() smithy.ErrorFault

func (*DuplicateDocumentVersionName) ErrorMessage 

func (e *DuplicateDocumentVersionName) ErrorMessage() string

type DuplicateInstanceId 

type DuplicateInstanceId struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You can't specify a managed node ID in more than one association.

func (*DuplicateInstanceId) Error 

func (e *DuplicateInstanceId) Error() string

func (*DuplicateInstanceId) ErrorCode 

func (e *DuplicateInstanceId) ErrorCode() string

func (*DuplicateInstanceId) ErrorFault 

func (e *DuplicateInstanceId) ErrorFault() smithy.ErrorFault

func (*DuplicateInstanceId) ErrorMessage 

func (e *DuplicateInstanceId) ErrorMessage() string

type EffectivePatch 

type EffectivePatch struct {

	// Provides metadata for a patch, including information such as the KB ID,
	// severity, classification and a URL for where more information can be obtained
	// about the patch.
	Patch *Patch

	// The status of the patch in a patch baseline. This includes information about
	// whether the patch is currently approved, due to be approved by a rule,
	// explicitly approved, or explicitly rejected and the date the patch was or will
	// be approved.
	PatchStatus *PatchStatus
	// contains filtered or unexported fields
}

The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

type ExecutionMode 

type ExecutionMode string
const (
	ExecutionModeAuto        ExecutionMode = "Auto"
	ExecutionModeInteractive ExecutionMode = "Interactive"
)

Enum values for ExecutionMode

func (ExecutionMode) Values added in v0.29.0 

func (ExecutionMode) Values() []ExecutionMode

Values returns all known values for ExecutionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExternalAlarmState added in v1.30.0 

type ExternalAlarmState string
const (
	ExternalAlarmStateUnknown ExternalAlarmState = "UNKNOWN"
	ExternalAlarmStateAlarm   ExternalAlarmState = "ALARM"
)

Enum values for ExternalAlarmState

func (ExternalAlarmState) Values added in v1.30.0 

func (ExternalAlarmState) Values() []ExternalAlarmState

Values returns all known values for ExternalAlarmState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FailedCreateAssociation 

type FailedCreateAssociation struct {

	// The association.
	Entry *CreateAssociationBatchRequestEntry

	// The source of the failure.
	Fault Fault

	// A description of the failure.
	Message *string
	// contains filtered or unexported fields
}

Describes a failed association.

type FailureDetails 

type FailureDetails struct {

	// Detailed information about the Automation step failure.
	Details map[string][]string

	// The stage of the Automation execution when the failure occurred. The stages
	// include the following: InputValidation, PreVerification, Invocation,
	// PostVerification.
	FailureStage *string

	// The type of Automation failure. Failure types include the following: Action,
	// Permission, Throttling, Verification, Internal.
	FailureType *string
	// contains filtered or unexported fields
}

Information about an Automation failure.

type Fault 

type Fault string
const (
	FaultClient  Fault = "Client"
	FaultServer  Fault = "Server"
	FaultUnknown Fault = "Unknown"
)

Enum values for Fault

func (Fault) Values added in v0.29.0 

func (Fault) Values() []Fault

Values returns all known values for Fault. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FeatureNotAvailableException 

type FeatureNotAvailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service isn't available.

func (*FeatureNotAvailableException) Error 

func (e *FeatureNotAvailableException) Error() string

func (*FeatureNotAvailableException) ErrorCode 

func (e *FeatureNotAvailableException) ErrorCode() string

func (*FeatureNotAvailableException) ErrorFault 

func (e *FeatureNotAvailableException) ErrorFault() smithy.ErrorFault

func (*FeatureNotAvailableException) ErrorMessage 

func (e *FeatureNotAvailableException) ErrorMessage() string

type GetResourcePoliciesResponseEntry added in v1.33.0 

type GetResourcePoliciesResponseEntry struct {

	// A resource policy helps you to define the IAM entity (for example, an Amazon
	// Web Services account) that can manage your Systems Manager resources. Currently,
	// OpsItemGroup is the only resource that supports Systems Manager resource
	// policies. The resource policy for OpsItemGroup enables Amazon Web Services
	// accounts to view and interact with OpsCenter operational work items (OpsItems).
	Policy *string

	// ID of the current policy version. The hash helps to prevent a situation where
	// multiple users attempt to overwrite a policy. You must provide this hash when
	// updating or deleting a policy.
	PolicyHash *string

	// A policy ID.
	PolicyId *string
	// contains filtered or unexported fields
}

A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

type HierarchyLevelLimitExceededException 

type HierarchyLevelLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.

func (*HierarchyLevelLimitExceededException) Error 

func (e *HierarchyLevelLimitExceededException) Error() string

func (*HierarchyLevelLimitExceededException) ErrorCode 

func (e *HierarchyLevelLimitExceededException) ErrorCode() string

func (*HierarchyLevelLimitExceededException) ErrorFault 

func (e *HierarchyLevelLimitExceededException) ErrorFault() smithy.ErrorFault

func (*HierarchyLevelLimitExceededException) ErrorMessage 

func (e *HierarchyLevelLimitExceededException) ErrorMessage() string

type HierarchyTypeMismatchException 

type HierarchyTypeMismatchException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.

func (*HierarchyTypeMismatchException) Error 

func (e *HierarchyTypeMismatchException) Error() string

func (*HierarchyTypeMismatchException) ErrorCode 

func (e *HierarchyTypeMismatchException) ErrorCode() string

func (*HierarchyTypeMismatchException) ErrorFault 

func (e *HierarchyTypeMismatchException) ErrorFault() smithy.ErrorFault

func (*HierarchyTypeMismatchException) ErrorMessage 

func (e *HierarchyTypeMismatchException) ErrorMessage() string

type IdempotentParameterMismatch 

type IdempotentParameterMismatch struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

func (*IdempotentParameterMismatch) Error 

func (e *IdempotentParameterMismatch) Error() string

func (*IdempotentParameterMismatch) ErrorCode 

func (e *IdempotentParameterMismatch) ErrorCode() string

func (*IdempotentParameterMismatch) ErrorFault 

func (e *IdempotentParameterMismatch) ErrorFault() smithy.ErrorFault

func (*IdempotentParameterMismatch) ErrorMessage 

func (e *IdempotentParameterMismatch) ErrorMessage() string

type IncompatiblePolicyException 

type IncompatiblePolicyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.

func (*IncompatiblePolicyException) Error 

func (e *IncompatiblePolicyException) Error() string

func (*IncompatiblePolicyException) ErrorCode 

func (e *IncompatiblePolicyException) ErrorCode() string

func (*IncompatiblePolicyException) ErrorFault 

func (e *IncompatiblePolicyException) ErrorFault() smithy.ErrorFault

func (*IncompatiblePolicyException) ErrorMessage 

func (e *IncompatiblePolicyException) ErrorMessage() string

type InstanceAggregatedAssociationOverview 

type InstanceAggregatedAssociationOverview struct {

	// Detailed status information about the aggregated associations.
	DetailedStatus *string

	// The number of associations for the managed nodes.
	InstanceAssociationStatusAggregatedCount map[string]int32
	// contains filtered or unexported fields
}

Status information about the aggregated associations.

type InstanceAssociation 

type InstanceAssociation struct {

	// The association ID.
	AssociationId *string

	// Version information for the association on the managed node.
	AssociationVersion *string

	// The content of the association document for the managed nodes.
	Content *string

	// The managed node ID.
	InstanceId *string
	// contains filtered or unexported fields
}

One or more association documents on the managed node.

type InstanceAssociationOutputLocation 

type InstanceAssociationOutputLocation struct {

	// An S3 bucket where you want to store the results of this request.
	S3Location *S3OutputLocation
	// contains filtered or unexported fields
}

An S3 bucket where you want to store the results of this request.

For the minimal permissions required to enable Amazon S3 output for an association, see Create an association (console)in the Systems Manager User Guide.

type InstanceAssociationOutputUrl 

type InstanceAssociationOutputUrl struct {

	// The URL of S3 bucket where you want to store the results of this request.
	S3OutputUrl *S3OutputUrl
	// contains filtered or unexported fields
}

The URL of S3 bucket where you want to store the results of this request.

type InstanceAssociationStatusInfo 

type InstanceAssociationStatusInfo struct {

	// The association ID.
	AssociationId *string

	// The name of the association applied to the managed node.
	AssociationName *string

	// The version of the association applied to the managed node.
	AssociationVersion *string

	// Detailed status information about the association.
	DetailedStatus *string

	// The association document versions.
	DocumentVersion *string

	// An error code returned by the request to create the association.
	ErrorCode *string

	// The date the association ran.
	ExecutionDate *time.Time

	// Summary information about association execution.
	ExecutionSummary *string

	// The managed node ID where the association was created.
	InstanceId *string

	// The name of the association.
	Name *string

	// A URL for an S3 bucket where you want to store the results of this request.
	OutputUrl *InstanceAssociationOutputUrl

	// Status information about the association.
	Status *string
	// contains filtered or unexported fields
}

Status information about the association.

type InstanceInformation 

type InstanceInformation struct {

	// The activation ID created by Amazon Web Services Systems Manager when the
	// server or virtual machine (VM) was registered.
	ActivationId *string

	// The version of SSM Agent running on your Linux managed node.
	AgentVersion *string

	// Information about the association.
	AssociationOverview *InstanceAggregatedAssociationOverview

	// The status of the association.
	AssociationStatus *string

	// The fully qualified host name of the managed node.
	ComputerName *string

	// The IP address of the managed node.
	IPAddress *string

	// The role assigned to an Amazon EC2 instance configured with a Systems Manager
	// Quick Setup host management configuration or the role assigned to an on-premises
	// managed node.
	//
	// This call doesn't return the IAM role for unmanaged Amazon EC2 instances
	// (instances not configured for Systems Manager). To retrieve the role for an
	// unmanaged instance, use the Amazon EC2 DescribeInstances operation. For
	// information, see [DescribeInstances]in the Amazon EC2 API Reference or [describe-instances] in the Amazon Web Services
	// CLI Command Reference.
	//
	// [DescribeInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
	// [describe-instances]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html
	IamRole *string

	// The managed node ID.
	InstanceId *string

	// Indicates whether the latest version of SSM Agent is running on your Linux
	// managed node. This field doesn't indicate whether or not the latest version is
	// installed on Windows managed nodes, because some older versions of Windows
	// Server use the EC2Config service to process Systems Manager requests.
	IsLatestVersion *bool

	// The date the association was last run.
	LastAssociationExecutionDate *time.Time

	// The date and time when the agent last pinged the Systems Manager service.
	LastPingDateTime *time.Time

	// The last date the association was successfully run.
	LastSuccessfulAssociationExecutionDate *time.Time

	// The name assigned to an on-premises server, edge device, or virtual machine
	// (VM) when it is activated as a Systems Manager managed node. The name is
	// specified as the DefaultInstanceName property using the CreateActivation command. It is applied
	// to the managed node by specifying the Activation Code and Activation ID when you
	// install SSM Agent on the node, as explained in [How to install SSM Agent on hybrid Linux nodes]and [How to install SSM Agent on hybrid Windows Server nodes]. To retrieve the Name tag
	// of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For
	// information, see [DescribeInstances]in the Amazon EC2 API Reference or [describe-instances] in the Amazon Web Services
	// CLI Command Reference.
	//
	// [How to install SSM Agent on hybrid Linux nodes]: https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-ssm-agent-install-linux.html
	// [How to install SSM Agent on hybrid Windows Server nodes]: https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-ssm-agent-install-windows.html
	// [DescribeInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
	// [describe-instances]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html
	Name *string

	// Connection status of SSM Agent.
	//
	// The status Inactive has been deprecated and is no longer in use.
	PingStatus PingStatus

	// The name of the operating system platform running on your managed node.
	PlatformName *string

	// The operating system platform type.
	PlatformType PlatformType

	// The version of the OS platform running on your managed node.
	PlatformVersion *string

	// The date the server or VM was registered with Amazon Web Services as a managed
	// node.
	RegistrationDate *time.Time

	// The type of instance. Instances are either EC2 instances or managed instances.
	ResourceType ResourceType

	// The ID of the source resource. For IoT Greengrass devices, SourceId is the
	// Thing name.
	SourceId *string

	// The type of the source resource. For IoT Greengrass devices, SourceType is
	// AWS::IoT::Thing .
	SourceType SourceType
	// contains filtered or unexported fields
}

Describes a filter for a specific list of managed nodes.

type InstanceInformationFilter 

type InstanceInformationFilter struct {

	// The name of the filter.
	//
	// This member is required.
	Key InstanceInformationFilterKey

	// The filter values.
	//
	// This member is required.
	ValueSet []string
	// contains filtered or unexported fields
}

Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.

Use this operation instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and doesn't support tags.

type InstanceInformationFilterKey 

type InstanceInformationFilterKey string
const (
	InstanceInformationFilterKeyInstanceIds       InstanceInformationFilterKey = "InstanceIds"
	InstanceInformationFilterKeyAgentVersion      InstanceInformationFilterKey = "AgentVersion"
	InstanceInformationFilterKeyPingStatus        InstanceInformationFilterKey = "PingStatus"
	InstanceInformationFilterKeyPlatformTypes     InstanceInformationFilterKey = "PlatformTypes"
	InstanceInformationFilterKeyActivationIds     InstanceInformationFilterKey = "ActivationIds"
	InstanceInformationFilterKeyIamRole           InstanceInformationFilterKey = "IamRole"
	InstanceInformationFilterKeyResourceType      InstanceInformationFilterKey = "ResourceType"
	InstanceInformationFilterKeyAssociationStatus InstanceInformationFilterKey = "AssociationStatus"
)

Enum values for InstanceInformationFilterKey

func (InstanceInformationFilterKey) Values added in v0.29.0 

func (InstanceInformationFilterKey) Values() []InstanceInformationFilterKey

Values returns all known values for InstanceInformationFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InstanceInformationStringFilter 

type InstanceInformationStringFilter struct {

	// The filter key name to describe your managed nodes.
	//
	// Valid filter key values: ActivationIds | AgentVersion | AssociationStatus |
	// IamRole | InstanceIds | PingStatus | PlatformTypes | ResourceType | SourceIds |
	// SourceTypes | "tag-key" | "tag: {keyname}
	//
	//   - Valid values for the AssociationStatus filter key: Success | Pending | Failed
	//
	//   - Valid values for the PingStatus filter key: Online | ConnectionLost |
	//   Inactive (deprecated)
	//
	//   - Valid values for the PlatformType filter key: Windows | Linux | MacOS
	//
	//   - Valid values for the ResourceType filter key: EC2Instance | ManagedInstance
	//
	//   - Valid values for the SourceType filter key: AWS::EC2::Instance |
	//   AWS::SSM::ManagedInstance | AWS::IoT::Thing
	//
	//   - Valid tag examples: Key=tag-key,Values=Purpose | Key=tag:Purpose,Values=Test
	//   .
	//
	// This member is required.
	Key *string

	// The filter values.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

The filters to describe or get information about your managed nodes.

type InstancePatchState 

type InstancePatchState struct {

	// The ID of the patch baseline used to patch the managed node.
	//
	// This member is required.
	BaselineId *string

	// The ID of the managed node the high-level patch compliance information was
	// collected for.
	//
	// This member is required.
	InstanceId *string

	// The type of patching operation that was performed: or
	//
	//   - SCAN assesses the patch compliance state.
	//
	//   - INSTALL installs missing patches.
	//
	// This member is required.
	Operation PatchOperationType

	// The time the most recent patching operation completed on the managed node.
	//
	// This member is required.
	OperationEndTime *time.Time

	// The time the most recent patching operation was started on the managed node.
	//
	// This member is required.
	OperationStartTime *time.Time

	// The name of the patch group the managed node belongs to.
	//
	// This member is required.
	PatchGroup *string

	// The number of patches per node that are specified as Critical for compliance
	// reporting in the patch baseline aren't installed. These patches might be
	// missing, have failed installation, were rejected, or were installed but awaiting
	// a required managed node reboot. The status of these managed nodes is
	// NON_COMPLIANT .
	CriticalNonCompliantCount *int32

	// The number of patches from the patch baseline that were attempted to be
	// installed during the last patching operation, but failed to install.
	FailedCount int32

	// An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to
	// a list of patches to be installed. This patch installation list, which you
	// maintain in an S3 bucket in YAML format and specify in the SSM document
	// AWS-RunPatchBaseline , overrides the patches specified by the default patch
	// baseline.
	//
	// For more information about the InstallOverrideList parameter, see [SSM Command document for patching: AWS-RunPatchBaseline]
	// AWS-RunPatchBaseline in the Amazon Web Services Systems Manager User Guide.
	//
	// [SSM Command document for patching: AWS-RunPatchBaseline]: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html
	InstallOverrideList *string

	// The number of patches from the patch baseline that are installed on the managed
	// node.
	InstalledCount int32

	// The number of patches not specified in the patch baseline that are installed on
	// the managed node.
	InstalledOtherCount int32

	// The number of patches installed by Patch Manager since the last time the
	// managed node was rebooted.
	InstalledPendingRebootCount *int32

	// The number of patches installed on a managed node that are specified in a
	// RejectedPatches list. Patches with a status of InstalledRejected were typically
	// installed before they were added to a RejectedPatches list.
	//
	// If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction , the
	// value of InstalledRejectedCount will always be 0 (zero).
	InstalledRejectedCount *int32

	// The time of the last attempt to patch the managed node with NoReboot specified
	// as the reboot option.
	LastNoRebootInstallOperationTime *time.Time

	// The number of patches from the patch baseline that are applicable for the
	// managed node but aren't currently installed.
	MissingCount int32

	// The number of patches from the patch baseline that aren't applicable for the
	// managed node and therefore aren't installed on the node. This number may be
	// truncated if the list of patch names is very large. The number of patches beyond
	// this limit are reported in UnreportedNotApplicableCount .
	NotApplicableCount int32

	// The number of patches per node that are specified as other than Critical or
	// Security but aren't compliant with the patch baseline. The status of these
	// managed nodes is NON_COMPLIANT .
	OtherNonCompliantCount *int32

	// Placeholder information. This field will always be empty in the current release
	// of the service.
	OwnerInformation *string

	// Indicates the reboot option specified in the patch baseline.
	//
	// Reboot options apply to Install operations only. Reboots aren't attempted for
	// Patch Manager Scan operations.
	//
	//   - RebootIfNeeded : Patch Manager tries to reboot the managed node if it
	//   installed any patches, or if any patches are detected with a status of
	//   InstalledPendingReboot .
	//
	//   - NoReboot : Patch Manager attempts to install missing packages without trying
	//   to reboot the system. Patches installed with this option are assigned a status
	//   of InstalledPendingReboot . These patches might not be in effect until a
	//   reboot is performed.
	RebootOption RebootOption

	// The number of patches per node that are specified as Security in a patch
	// advisory aren't installed. These patches might be missing, have failed
	// installation, were rejected, or were installed but awaiting a required managed
	// node reboot. The status of these managed nodes is NON_COMPLIANT .
	SecurityNonCompliantCount *int32

	// The ID of the patch baseline snapshot used during the patching operation when
	// this compliance data was collected.
	SnapshotId *string

	// The number of patches beyond the supported limit of NotApplicableCount that
	// aren't reported by name to Inventory. Inventory is a capability of Amazon Web
	// Services Systems Manager.
	UnreportedNotApplicableCount *int32
	// contains filtered or unexported fields
}

Defines the high-level patch compliance state for a managed node, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the managed node.

type InstancePatchStateFilter 

type InstancePatchStateFilter struct {

	// The key for the filter. Supported values include the following:
	//
	//   - InstalledCount
	//
	//   - InstalledOtherCount
	//
	//   - InstalledPendingRebootCount
	//
	//   - InstalledRejectedCount
	//
	//   - MissingCount
	//
	//   - FailedCount
	//
	//   - UnreportedNotApplicableCount
	//
	//   - NotApplicableCount
	//
	// This member is required.
	Key *string

	// The type of comparison that should be performed for the value.
	//
	// This member is required.
	Type InstancePatchStateOperatorType

	// The value for the filter. Must be an integer greater than or equal to 0.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down the information returned by the API.

Example: To filter for all managed nodes in a patch group having more than three patches with a FailedCount status, use the following for the filter:

  • Value for Key : FailedCount

  • Value for Type : GreaterThan

  • Value for Values : 3

type InstancePatchStateOperatorType 

type InstancePatchStateOperatorType string
const (
	InstancePatchStateOperatorTypeEqual       InstancePatchStateOperatorType = "Equal"
	InstancePatchStateOperatorTypeNotEqual    InstancePatchStateOperatorType = "NotEqual"
	InstancePatchStateOperatorTypeLessThan    InstancePatchStateOperatorType = "LessThan"
	InstancePatchStateOperatorTypeGreaterThan InstancePatchStateOperatorType = "GreaterThan"
)

Enum values for InstancePatchStateOperatorType

func (InstancePatchStateOperatorType) Values added in v0.29.0 

func (InstancePatchStateOperatorType) Values() []InstancePatchStateOperatorType

Values returns all known values for InstancePatchStateOperatorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InstanceProperty added in v1.50.0 

type InstanceProperty struct {

	// The activation ID created by Systems Manager when the server or virtual machine
	// (VM) was registered
	ActivationId *string

	// The version of SSM Agent running on your managed node.
	AgentVersion *string

	// The CPU architecture of the node. For example, x86_64 .
	Architecture *string

	// Status information about the aggregated associations.
	AssociationOverview *InstanceAggregatedAssociationOverview

	// The status of the State Manager association applied to the managed node.
	AssociationStatus *string

	// The fully qualified host name of the managed node.
	ComputerName *string

	// The public IPv4 address assigned to the node. If a public IPv4 address isn't
	// assigned to the node, this value is blank.
	IPAddress *string

	// The IAM role used in the hybrid activation to register the node with Systems
	// Manager.
	IamRole *string

	// The ID of the managed node.
	InstanceId *string

	// The instance profile attached to the node. If an instance profile isn't
	// attached to the node, this value is blank.
	InstanceRole *string

	// The current state of the node.
	InstanceState *string

	// The instance type of the managed node. For example, t3.large.
	InstanceType *string

	// The name of the key pair associated with the node. If a key pair isnt't
	// associated with the node, this value is blank.
	KeyName *string

	// The date the association was last run.
	LastAssociationExecutionDate *time.Time

	// The date and time when the SSM Agent last pinged the Systems Manager service.
	LastPingDateTime *time.Time

	// The last date the association was successfully run.
	LastSuccessfulAssociationExecutionDate *time.Time

	// The timestamp for when the node was launched.
	LaunchTime *time.Time

	// The value of the EC2 Name tag associated with the node. If a Name tag hasn't
	// been applied to the node, this value is blank.
	Name *string

	// Connection status of the SSM Agent on the managed node.
	PingStatus PingStatus

	// The name of the operating system platform running on your managed node.
	PlatformName *string

	// The operating system platform type of the managed node. For example, Windows.
	PlatformType PlatformType

	// The version of the OS platform running on your managed node.
	PlatformVersion *string

	// The date the node was registered with Systems Manager.
	RegistrationDate *time.Time

	// The type of managed node.
	ResourceType *string

	// The ID of the source resource.
	SourceId *string

	// The type of the source resource.
	SourceType SourceType
	// contains filtered or unexported fields
}

An object containing various properties of a managed node.

type InstancePropertyFilter added in v1.50.0 

type InstancePropertyFilter struct {

	// The name of the filter.
	//
	// This member is required.
	Key InstancePropertyFilterKey

	// The filter values.
	//
	// This member is required.
	ValueSet []string
	// contains filtered or unexported fields
}

Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.

type InstancePropertyFilterKey added in v1.50.0 

type InstancePropertyFilterKey string
const (
	InstancePropertyFilterKeyInstanceIds       InstancePropertyFilterKey = "InstanceIds"
	InstancePropertyFilterKeyAgentVersion      InstancePropertyFilterKey = "AgentVersion"
	InstancePropertyFilterKeyPingStatus        InstancePropertyFilterKey = "PingStatus"
	InstancePropertyFilterKeyPlatformTypes     InstancePropertyFilterKey = "PlatformTypes"
	InstancePropertyFilterKeyDocumentName      InstancePropertyFilterKey = "DocumentName"
	InstancePropertyFilterKeyActivationIds     InstancePropertyFilterKey = "ActivationIds"
	InstancePropertyFilterKeyIamRole           InstancePropertyFilterKey = "IamRole"
	InstancePropertyFilterKeyResourceType      InstancePropertyFilterKey = "ResourceType"
	InstancePropertyFilterKeyAssociationStatus InstancePropertyFilterKey = "AssociationStatus"
)

Enum values for InstancePropertyFilterKey

func (InstancePropertyFilterKey) Values added in v1.50.0 

func (InstancePropertyFilterKey) Values() []InstancePropertyFilterKey

Values returns all known values for InstancePropertyFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InstancePropertyFilterOperator added in v1.50.0 

type InstancePropertyFilterOperator string
const (
	InstancePropertyFilterOperatorEqual       InstancePropertyFilterOperator = "Equal"
	InstancePropertyFilterOperatorNotEqual    InstancePropertyFilterOperator = "NotEqual"
	InstancePropertyFilterOperatorBeginWith   InstancePropertyFilterOperator = "BeginWith"
	InstancePropertyFilterOperatorLessThan    InstancePropertyFilterOperator = "LessThan"
	InstancePropertyFilterOperatorGreaterThan InstancePropertyFilterOperator = "GreaterThan"
)

Enum values for InstancePropertyFilterOperator

func (InstancePropertyFilterOperator) Values added in v1.50.0 

func (InstancePropertyFilterOperator) Values() []InstancePropertyFilterOperator

Values returns all known values for InstancePropertyFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InstancePropertyStringFilter added in v1.50.0 

type InstancePropertyStringFilter struct {

	// The filter key name to describe your managed nodes.
	//
	// This member is required.
	Key *string

	// The filter key name to describe your managed nodes.
	//
	// This member is required.
	Values []string

	// The operator used by the filter call.
	Operator InstancePropertyFilterOperator
	// contains filtered or unexported fields
}

The filters to describe or get information about your managed nodes.

type InternalServerError 

type InternalServerError struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occurred on the server side.

func (*InternalServerError) Error 

func (e *InternalServerError) Error() string

func (*InternalServerError) ErrorCode 

func (e *InternalServerError) ErrorCode() string

func (*InternalServerError) ErrorFault 

func (e *InternalServerError) ErrorFault() smithy.ErrorFault

func (*InternalServerError) ErrorMessage 

func (e *InternalServerError) ErrorMessage() string

type InvalidActivation 

type InvalidActivation struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.

func (*InvalidActivation) Error 

func (e *InvalidActivation) Error() string

func (*InvalidActivation) ErrorCode 

func (e *InvalidActivation) ErrorCode() string

func (*InvalidActivation) ErrorFault 

func (e *InvalidActivation) ErrorFault() smithy.ErrorFault

func (*InvalidActivation) ErrorMessage 

func (e *InvalidActivation) ErrorMessage() string

type InvalidActivationId 

type InvalidActivationId struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.

func (*InvalidActivationId) Error 

func (e *InvalidActivationId) Error() string

func (*InvalidActivationId) ErrorCode 

func (e *InvalidActivationId) ErrorCode() string

func (*InvalidActivationId) ErrorFault 

func (e *InvalidActivationId) ErrorFault() smithy.ErrorFault

func (*InvalidActivationId) ErrorMessage 

func (e *InvalidActivationId) ErrorMessage() string

type InvalidAggregatorException 

type InvalidAggregatorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation .

func (*InvalidAggregatorException) Error 

func (e *InvalidAggregatorException) Error() string

func (*InvalidAggregatorException) ErrorCode 

func (e *InvalidAggregatorException) ErrorCode() string

func (*InvalidAggregatorException) ErrorFault 

func (e *InvalidAggregatorException) ErrorFault() smithy.ErrorFault

func (*InvalidAggregatorException) ErrorMessage 

func (e *InvalidAggregatorException) ErrorMessage() string

type InvalidAllowedPatternException 

type InvalidAllowedPatternException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request doesn't meet the regular expression requirement.

func (*InvalidAllowedPatternException) Error 

func (e *InvalidAllowedPatternException) Error() string

func (*InvalidAllowedPatternException) ErrorCode 

func (e *InvalidAllowedPatternException) ErrorCode() string

func (*InvalidAllowedPatternException) ErrorFault 

func (e *InvalidAllowedPatternException) ErrorFault() smithy.ErrorFault

func (*InvalidAllowedPatternException) ErrorMessage 

func (e *InvalidAllowedPatternException) ErrorMessage() string

type InvalidAssociation 

type InvalidAssociation struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The association isn't valid or doesn't exist.

func (*InvalidAssociation) Error 

func (e *InvalidAssociation) Error() string

func (*InvalidAssociation) ErrorCode 

func (e *InvalidAssociation) ErrorCode() string

func (*InvalidAssociation) ErrorFault 

func (e *InvalidAssociation) ErrorFault() smithy.ErrorFault

func (*InvalidAssociation) ErrorMessage 

func (e *InvalidAssociation) ErrorMessage() string

type InvalidAssociationVersion 

type InvalidAssociationVersion struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.

func (*InvalidAssociationVersion) Error 

func (e *InvalidAssociationVersion) Error() string

func (*InvalidAssociationVersion) ErrorCode 

func (e *InvalidAssociationVersion) ErrorCode() string

func (*InvalidAssociationVersion) ErrorFault 

func (e *InvalidAssociationVersion) ErrorFault() smithy.ErrorFault

func (*InvalidAssociationVersion) ErrorMessage 

func (e *InvalidAssociationVersion) ErrorMessage() string

type InvalidAutomationExecutionParametersException 

type InvalidAutomationExecutionParametersException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.

func (*InvalidAutomationExecutionParametersException) Error 

func (e *InvalidAutomationExecutionParametersException) Error() string

func (*InvalidAutomationExecutionParametersException) ErrorCode 

func (e *InvalidAutomationExecutionParametersException) ErrorCode() string

func (*InvalidAutomationExecutionParametersException) ErrorFault 

func (e *InvalidAutomationExecutionParametersException) ErrorFault() smithy.ErrorFault

func (*InvalidAutomationExecutionParametersException) ErrorMessage 

func (e *InvalidAutomationExecutionParametersException) ErrorMessage() string

type InvalidAutomationSignalException 

type InvalidAutomationSignalException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The signal isn't valid for the current Automation execution.

func (*InvalidAutomationSignalException) Error 

func (e *InvalidAutomationSignalException) Error() string

func (*InvalidAutomationSignalException) ErrorCode 

func (e *InvalidAutomationSignalException) ErrorCode() string

func (*InvalidAutomationSignalException) ErrorFault 

func (e *InvalidAutomationSignalException) ErrorFault() smithy.ErrorFault

func (*InvalidAutomationSignalException) ErrorMessage 

func (e *InvalidAutomationSignalException) ErrorMessage() string

type InvalidAutomationStatusUpdateException 

type InvalidAutomationStatusUpdateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified update status operation isn't valid.

func (*InvalidAutomationStatusUpdateException) Error 

func (e *InvalidAutomationStatusUpdateException) Error() string

func (*InvalidAutomationStatusUpdateException) ErrorCode 

func (e *InvalidAutomationStatusUpdateException) ErrorCode() string

func (*InvalidAutomationStatusUpdateException) ErrorFault 

func (e *InvalidAutomationStatusUpdateException) ErrorFault() smithy.ErrorFault

func (*InvalidAutomationStatusUpdateException) ErrorMessage 

func (e *InvalidAutomationStatusUpdateException) ErrorMessage() string

type InvalidCommandId 

type InvalidCommandId struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified command ID isn't valid. Verify the ID and try again.

func (*InvalidCommandId) Error 

func (e *InvalidCommandId) Error() string

func (*InvalidCommandId) ErrorCode 

func (e *InvalidCommandId) ErrorCode() string

func (*InvalidCommandId) ErrorFault 

func (e *InvalidCommandId) ErrorFault() smithy.ErrorFault

func (*InvalidCommandId) ErrorMessage 

func (e *InvalidCommandId) ErrorMessage() string

type InvalidDeleteInventoryParametersException 

type InvalidDeleteInventoryParametersException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.

func (*InvalidDeleteInventoryParametersException) Error 

func (e *InvalidDeleteInventoryParametersException) Error() string

func (*InvalidDeleteInventoryParametersException) ErrorCode 

func (e *InvalidDeleteInventoryParametersException) ErrorCode() string

func (*InvalidDeleteInventoryParametersException) ErrorFault 

func (e *InvalidDeleteInventoryParametersException) ErrorFault() smithy.ErrorFault

func (*InvalidDeleteInventoryParametersException) ErrorMessage 

func (e *InvalidDeleteInventoryParametersException) ErrorMessage() string

type InvalidDeletionIdException 

type InvalidDeletionIdException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.

func (*InvalidDeletionIdException) Error 

func (e *InvalidDeletionIdException) Error() string

func (*InvalidDeletionIdException) ErrorCode 

func (e *InvalidDeletionIdException) ErrorCode() string

func (*InvalidDeletionIdException) ErrorFault 

func (e *InvalidDeletionIdException) ErrorFault() smithy.ErrorFault

func (*InvalidDeletionIdException) ErrorMessage 

func (e *InvalidDeletionIdException) ErrorMessage() string

type InvalidDocument 

type InvalidDocument struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified SSM document doesn't exist.

func (*InvalidDocument) Error 

func (e *InvalidDocument) Error() string

func (*InvalidDocument) ErrorCode 

func (e *InvalidDocument) ErrorCode() string

func (*InvalidDocument) ErrorFault 

func (e *InvalidDocument) ErrorFault() smithy.ErrorFault

func (*InvalidDocument) ErrorMessage 

func (e *InvalidDocument) ErrorMessage() string

type InvalidDocumentContent 

type InvalidDocumentContent struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The content for the document isn't valid.

func (*InvalidDocumentContent) Error 

func (e *InvalidDocumentContent) Error() string

func (*InvalidDocumentContent) ErrorCode 

func (e *InvalidDocumentContent) ErrorCode() string

func (*InvalidDocumentContent) ErrorFault 

func (e *InvalidDocumentContent) ErrorFault() smithy.ErrorFault

func (*InvalidDocumentContent) ErrorMessage 

func (e *InvalidDocumentContent) ErrorMessage() string

type InvalidDocumentOperation 

type InvalidDocumentOperation struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InvalidDocumentOperation) Error 

func (e *InvalidDocumentOperation) Error() string

func (*InvalidDocumentOperation) ErrorCode 

func (e *InvalidDocumentOperation) ErrorCode() string

func (*InvalidDocumentOperation) ErrorFault 

func (e *InvalidDocumentOperation) ErrorFault() smithy.ErrorFault

func (*InvalidDocumentOperation) ErrorMessage 

func (e *InvalidDocumentOperation) ErrorMessage() string

type InvalidDocumentSchemaVersion 

type InvalidDocumentSchemaVersion struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The version of the document schema isn't supported.

func (*InvalidDocumentSchemaVersion) Error 

func (e *InvalidDocumentSchemaVersion) Error() string

func (*InvalidDocumentSchemaVersion) ErrorCode 

func (e *InvalidDocumentSchemaVersion) ErrorCode() string

func (*InvalidDocumentSchemaVersion) ErrorFault 

func (e *InvalidDocumentSchemaVersion) ErrorFault() smithy.ErrorFault

func (*InvalidDocumentSchemaVersion) ErrorMessage 

func (e *InvalidDocumentSchemaVersion) ErrorMessage() string

type InvalidDocumentType 

type InvalidDocumentType struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The SSM document type isn't valid. Valid document types are described in the DocumentType property.

func (*InvalidDocumentType) Error 

func (e *InvalidDocumentType) Error() string

func (*InvalidDocumentType) ErrorCode 

func (e *InvalidDocumentType) ErrorCode() string

func (*InvalidDocumentType) ErrorFault 

func (e *InvalidDocumentType) ErrorFault() smithy.ErrorFault

func (*InvalidDocumentType) ErrorMessage 

func (e *InvalidDocumentType) ErrorMessage() string

type InvalidDocumentVersion 

type InvalidDocumentVersion struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The document version isn't valid or doesn't exist.

func (*InvalidDocumentVersion) Error 

func (e *InvalidDocumentVersion) Error() string

func (*InvalidDocumentVersion) ErrorCode 

func (e *InvalidDocumentVersion) ErrorCode() string

func (*InvalidDocumentVersion) ErrorFault 

func (e *InvalidDocumentVersion) ErrorFault() smithy.ErrorFault

func (*InvalidDocumentVersion) ErrorMessage 

func (e *InvalidDocumentVersion) ErrorMessage() string

type InvalidFilter 

type InvalidFilter struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The filter name isn't valid. Verify the you entered the correct name and try again.

func (*InvalidFilter) Error 

func (e *InvalidFilter) Error() string

func (*InvalidFilter) ErrorCode 

func (e *InvalidFilter) ErrorCode() string

func (*InvalidFilter) ErrorFault 

func (e *InvalidFilter) ErrorFault() smithy.ErrorFault

func (*InvalidFilter) ErrorMessage 

func (e *InvalidFilter) ErrorMessage() string

type InvalidFilterKey 

type InvalidFilterKey struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified key isn't valid.

func (*InvalidFilterKey) Error 

func (e *InvalidFilterKey) Error() string

func (*InvalidFilterKey) ErrorCode 

func (e *InvalidFilterKey) ErrorCode() string

func (*InvalidFilterKey) ErrorFault 

func (e *InvalidFilterKey) ErrorFault() smithy.ErrorFault

func (*InvalidFilterKey) ErrorMessage 

func (e *InvalidFilterKey) ErrorMessage() string

type InvalidFilterOption 

type InvalidFilterOption struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

func (*InvalidFilterOption) Error 

func (e *InvalidFilterOption) Error() string

func (*InvalidFilterOption) ErrorCode 

func (e *InvalidFilterOption) ErrorCode() string

func (*InvalidFilterOption) ErrorFault 

func (e *InvalidFilterOption) ErrorFault() smithy.ErrorFault

func (*InvalidFilterOption) ErrorMessage 

func (e *InvalidFilterOption) ErrorMessage() string

type InvalidFilterValue 

type InvalidFilterValue struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The filter value isn't valid. Verify the value and try again.

func (*InvalidFilterValue) Error 

func (e *InvalidFilterValue) Error() string

func (*InvalidFilterValue) ErrorCode 

func (e *InvalidFilterValue) ErrorCode() string

func (*InvalidFilterValue) ErrorFault 

func (e *InvalidFilterValue) ErrorFault() smithy.ErrorFault

func (*InvalidFilterValue) ErrorMessage 

func (e *InvalidFilterValue) ErrorMessage() string

type InvalidInstanceId 

type InvalidInstanceId struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The following problems can cause this exception:

  • You don't have permission to access the managed node.

  • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

  • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

  • The managed node isn't in a valid state. Valid states are: Running , Pending , Stopped , and Stopping . Invalid states are: Shutting-down and Terminated .

func (*InvalidInstanceId) Error 

func (e *InvalidInstanceId) Error() string

func (*InvalidInstanceId) ErrorCode 

func (e *InvalidInstanceId) ErrorCode() string

func (*InvalidInstanceId) ErrorFault 

func (e *InvalidInstanceId) ErrorFault() smithy.ErrorFault

func (*InvalidInstanceId) ErrorMessage 

func (e *InvalidInstanceId) ErrorMessage() string

type InvalidInstanceInformationFilterValue 

type InvalidInstanceInformationFilterValue struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified filter value isn't valid.

func (*InvalidInstanceInformationFilterValue) Error 

func (e *InvalidInstanceInformationFilterValue) Error() string

func (*InvalidInstanceInformationFilterValue) ErrorCode 

func (e *InvalidInstanceInformationFilterValue) ErrorCode() string

func (*InvalidInstanceInformationFilterValue) ErrorFault 

func (e *InvalidInstanceInformationFilterValue) ErrorFault() smithy.ErrorFault

func (*InvalidInstanceInformationFilterValue) ErrorMessage 

func (e *InvalidInstanceInformationFilterValue) ErrorMessage() string

type InvalidInstancePropertyFilterValue added in v1.50.0 

type InvalidInstancePropertyFilterValue struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified filter value isn't valid.

func (*InvalidInstancePropertyFilterValue) Error added in v1.50.0 

func (e *InvalidInstancePropertyFilterValue) Error() string

func (*InvalidInstancePropertyFilterValue) ErrorCode added in v1.50.0 

func (e *InvalidInstancePropertyFilterValue) ErrorCode() string

func (*InvalidInstancePropertyFilterValue) ErrorFault added in v1.50.0 

func (e *InvalidInstancePropertyFilterValue) ErrorFault() smithy.ErrorFault

func (*InvalidInstancePropertyFilterValue) ErrorMessage added in v1.50.0 

func (e *InvalidInstancePropertyFilterValue) ErrorMessage() string

type InvalidInventoryGroupException 

type InvalidInventoryGroupException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified inventory group isn't valid.

func (*InvalidInventoryGroupException) Error 

func (e *InvalidInventoryGroupException) Error() string

func (*InvalidInventoryGroupException) ErrorCode 

func (e *InvalidInventoryGroupException) ErrorCode() string

func (*InvalidInventoryGroupException) ErrorFault 

func (e *InvalidInventoryGroupException) ErrorFault() smithy.ErrorFault

func (*InvalidInventoryGroupException) ErrorMessage 

func (e *InvalidInventoryGroupException) ErrorMessage() string

type InvalidInventoryItemContextException 

type InvalidInventoryItemContextException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You specified invalid keys or values in the Context attribute for InventoryItem . Verify the keys and values, and try again.

func (*InvalidInventoryItemContextException) Error 

func (e *InvalidInventoryItemContextException) Error() string

func (*InvalidInventoryItemContextException) ErrorCode 

func (e *InvalidInventoryItemContextException) ErrorCode() string

func (*InvalidInventoryItemContextException) ErrorFault 

func (e *InvalidInventoryItemContextException) ErrorFault() smithy.ErrorFault

func (*InvalidInventoryItemContextException) ErrorMessage 

func (e *InvalidInventoryItemContextException) ErrorMessage() string

type InvalidInventoryRequestException 

type InvalidInventoryRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request isn't valid.

func (*InvalidInventoryRequestException) Error 

func (e *InvalidInventoryRequestException) Error() string

func (*InvalidInventoryRequestException) ErrorCode 

func (e *InvalidInventoryRequestException) ErrorCode() string

func (*InvalidInventoryRequestException) ErrorFault 

func (e *InvalidInventoryRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidInventoryRequestException) ErrorMessage 

func (e *InvalidInventoryRequestException) ErrorMessage() string

type InvalidItemContentException 

type InvalidItemContentException struct {
	Message *string

	ErrorCodeOverride *string

	TypeName *string
	// contains filtered or unexported fields
}

One or more content items isn't valid.

func (*InvalidItemContentException) Error 

func (e *InvalidItemContentException) Error() string

func (*InvalidItemContentException) ErrorCode 

func (e *InvalidItemContentException) ErrorCode() string

func (*InvalidItemContentException) ErrorFault 

func (e *InvalidItemContentException) ErrorFault() smithy.ErrorFault

func (*InvalidItemContentException) ErrorMessage 

func (e *InvalidItemContentException) ErrorMessage() string

type InvalidKeyId 

type InvalidKeyId struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The query key ID isn't valid.

func (*InvalidKeyId) Error 

func (e *InvalidKeyId) Error() string

func (*InvalidKeyId) ErrorCode 

func (e *InvalidKeyId) ErrorCode() string

func (*InvalidKeyId) ErrorFault 

func (e *InvalidKeyId) ErrorFault() smithy.ErrorFault

func (*InvalidKeyId) ErrorMessage 

func (e *InvalidKeyId) ErrorMessage() string

type InvalidNextToken 

type InvalidNextToken struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified token isn't valid.

func (*InvalidNextToken) Error 

func (e *InvalidNextToken) Error() string

func (*InvalidNextToken) ErrorCode 

func (e *InvalidNextToken) ErrorCode() string

func (*InvalidNextToken) ErrorFault 

func (e *InvalidNextToken) ErrorFault() smithy.ErrorFault

func (*InvalidNextToken) ErrorMessage 

func (e *InvalidNextToken) ErrorMessage() string

type InvalidNotificationConfig 

type InvalidNotificationConfig struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.

func (*InvalidNotificationConfig) Error 

func (e *InvalidNotificationConfig) Error() string

func (*InvalidNotificationConfig) ErrorCode 

func (e *InvalidNotificationConfig) ErrorCode() string

func (*InvalidNotificationConfig) ErrorFault 

func (e *InvalidNotificationConfig) ErrorFault() smithy.ErrorFault

func (*InvalidNotificationConfig) ErrorMessage 

func (e *InvalidNotificationConfig) ErrorMessage() string

type InvalidOptionException 

type InvalidOptionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The delete inventory option specified isn't valid. Verify the option and try again.

func (*InvalidOptionException) Error 

func (e *InvalidOptionException) Error() string

func (*InvalidOptionException) ErrorCode 

func (e *InvalidOptionException) ErrorCode() string

func (*InvalidOptionException) ErrorFault 

func (e *InvalidOptionException) ErrorFault() smithy.ErrorFault

func (*InvalidOptionException) ErrorMessage 

func (e *InvalidOptionException) ErrorMessage() string

type InvalidOutputFolder 

type InvalidOutputFolder struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The S3 bucket doesn't exist.

func (*InvalidOutputFolder) Error 

func (e *InvalidOutputFolder) Error() string

func (*InvalidOutputFolder) ErrorCode 

func (e *InvalidOutputFolder) ErrorCode() string

func (*InvalidOutputFolder) ErrorFault 

func (e *InvalidOutputFolder) ErrorFault() smithy.ErrorFault

func (*InvalidOutputFolder) ErrorMessage 

func (e *InvalidOutputFolder) ErrorMessage() string

type InvalidOutputLocation 

type InvalidOutputLocation struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The output location isn't valid or doesn't exist.

func (*InvalidOutputLocation) Error 

func (e *InvalidOutputLocation) Error() string

func (*InvalidOutputLocation) ErrorCode 

func (e *InvalidOutputLocation) ErrorCode() string

func (*InvalidOutputLocation) ErrorFault 

func (e *InvalidOutputLocation) ErrorFault() smithy.ErrorFault

func (*InvalidOutputLocation) ErrorMessage 

func (e *InvalidOutputLocation) ErrorMessage() string

type InvalidParameters 

type InvalidParameters struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.

func (*InvalidParameters) Error 

func (e *InvalidParameters) Error() string

func (*InvalidParameters) ErrorCode 

func (e *InvalidParameters) ErrorCode() string

func (*InvalidParameters) ErrorFault 

func (e *InvalidParameters) ErrorFault() smithy.ErrorFault

func (*InvalidParameters) ErrorMessage 

func (e *InvalidParameters) ErrorMessage() string

type InvalidPermissionType 

type InvalidPermissionType struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The permission type isn't supported. Share is the only supported permission type.

func (*InvalidPermissionType) Error 

func (e *InvalidPermissionType) Error() string

func (*InvalidPermissionType) ErrorCode 

func (e *InvalidPermissionType) ErrorCode() string

func (*InvalidPermissionType) ErrorFault 

func (e *InvalidPermissionType) ErrorFault() smithy.ErrorFault

func (*InvalidPermissionType) ErrorMessage 

func (e *InvalidPermissionType) ErrorMessage() string

type InvalidPluginName 

type InvalidPluginName struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The plugin name isn't valid.

func (*InvalidPluginName) Error 

func (e *InvalidPluginName) Error() string

func (*InvalidPluginName) ErrorCode 

func (e *InvalidPluginName) ErrorCode() string

func (*InvalidPluginName) ErrorFault 

func (e *InvalidPluginName) ErrorFault() smithy.ErrorFault

func (*InvalidPluginName) ErrorMessage 

func (e *InvalidPluginName) ErrorMessage() string

type InvalidPolicyAttributeException 

type InvalidPolicyAttributeException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A policy attribute or its value is invalid.

func (*InvalidPolicyAttributeException) Error 

func (e *InvalidPolicyAttributeException) Error() string

func (*InvalidPolicyAttributeException) ErrorCode 

func (e *InvalidPolicyAttributeException) ErrorCode() string

func (*InvalidPolicyAttributeException) ErrorFault 

func (e *InvalidPolicyAttributeException) ErrorFault() smithy.ErrorFault

func (*InvalidPolicyAttributeException) ErrorMessage 

func (e *InvalidPolicyAttributeException) ErrorMessage() string

type InvalidPolicyTypeException 

type InvalidPolicyTypeException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

func (*InvalidPolicyTypeException) Error 

func (e *InvalidPolicyTypeException) Error() string

func (*InvalidPolicyTypeException) ErrorCode 

func (e *InvalidPolicyTypeException) ErrorCode() string

func (*InvalidPolicyTypeException) ErrorFault 

func (e *InvalidPolicyTypeException) ErrorFault() smithy.ErrorFault

func (*InvalidPolicyTypeException) ErrorMessage 

func (e *InvalidPolicyTypeException) ErrorMessage() string

type InvalidResourceId 

type InvalidResourceId struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource ID isn't valid. Verify that you entered the correct ID and try again.

func (*InvalidResourceId) Error 

func (e *InvalidResourceId) Error() string

func (*InvalidResourceId) ErrorCode 

func (e *InvalidResourceId) ErrorCode() string

func (*InvalidResourceId) ErrorFault 

func (e *InvalidResourceId) ErrorFault() smithy.ErrorFault

func (*InvalidResourceId) ErrorMessage 

func (e *InvalidResourceId) ErrorMessage() string

type InvalidResourceType 

type InvalidResourceType struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.

func (*InvalidResourceType) Error 

func (e *InvalidResourceType) Error() string

func (*InvalidResourceType) ErrorCode 

func (e *InvalidResourceType) ErrorCode() string

func (*InvalidResourceType) ErrorFault 

func (e *InvalidResourceType) ErrorFault() smithy.ErrorFault

func (*InvalidResourceType) ErrorMessage 

func (e *InvalidResourceType) ErrorMessage() string

type InvalidResultAttributeException 

type InvalidResultAttributeException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified inventory item result attribute isn't valid.

func (*InvalidResultAttributeException) Error 

func (e *InvalidResultAttributeException) Error() string

func (*InvalidResultAttributeException) ErrorCode 

func (e *InvalidResultAttributeException) ErrorCode() string

func (*InvalidResultAttributeException) ErrorFault 

func (e *InvalidResultAttributeException) ErrorFault() smithy.ErrorFault

func (*InvalidResultAttributeException) ErrorMessage 

func (e *InvalidResultAttributeException) ErrorMessage() string

type InvalidRole 

type InvalidRole struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

func (*InvalidRole) Error 

func (e *InvalidRole) Error() string

func (*InvalidRole) ErrorCode 

func (e *InvalidRole) ErrorCode() string

func (*InvalidRole) ErrorFault 

func (e *InvalidRole) ErrorFault() smithy.ErrorFault

func (*InvalidRole) ErrorMessage 

func (e *InvalidRole) ErrorMessage() string

type InvalidSchedule 

type InvalidSchedule struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The schedule is invalid. Verify your cron or rate expression and try again.

func (*InvalidSchedule) Error 

func (e *InvalidSchedule) Error() string

func (*InvalidSchedule) ErrorCode 

func (e *InvalidSchedule) ErrorCode() string

func (*InvalidSchedule) ErrorFault 

func (e *InvalidSchedule) ErrorFault() smithy.ErrorFault

func (*InvalidSchedule) ErrorMessage 

func (e *InvalidSchedule) ErrorMessage() string

type InvalidTag added in v1.28.0 

type InvalidTag struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified tag key or value isn't valid.

func (*InvalidTag) Error added in v1.28.0 

func (e *InvalidTag) Error() string

func (*InvalidTag) ErrorCode added in v1.28.0 

func (e *InvalidTag) ErrorCode() string

func (*InvalidTag) ErrorFault added in v1.28.0 

func (e *InvalidTag) ErrorFault() smithy.ErrorFault

func (*InvalidTag) ErrorMessage added in v1.28.0 

func (e *InvalidTag) ErrorMessage() string

type InvalidTarget 

type InvalidTarget struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.

func (*InvalidTarget) Error 

func (e *InvalidTarget) Error() string

func (*InvalidTarget) ErrorCode 

func (e *InvalidTarget) ErrorCode() string

func (*InvalidTarget) ErrorFault 

func (e *InvalidTarget) ErrorFault() smithy.ErrorFault

func (*InvalidTarget) ErrorMessage 

func (e *InvalidTarget) ErrorMessage() string

type InvalidTargetMaps added in v1.27.0 

type InvalidTargetMaps struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

TargetMap parameter isn't valid.

func (*InvalidTargetMaps) Error added in v1.27.0 

func (e *InvalidTargetMaps) Error() string

func (*InvalidTargetMaps) ErrorCode added in v1.27.0 

func (e *InvalidTargetMaps) ErrorCode() string

func (*InvalidTargetMaps) ErrorFault added in v1.27.0 

func (e *InvalidTargetMaps) ErrorFault() smithy.ErrorFault

func (*InvalidTargetMaps) ErrorMessage added in v1.27.0 

func (e *InvalidTargetMaps) ErrorMessage() string

type InvalidTypeNameException 

type InvalidTypeNameException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The parameter type name isn't valid.

func (*InvalidTypeNameException) Error 

func (e *InvalidTypeNameException) Error() string

func (*InvalidTypeNameException) ErrorCode 

func (e *InvalidTypeNameException) ErrorCode() string

func (*InvalidTypeNameException) ErrorFault 

func (e *InvalidTypeNameException) ErrorFault() smithy.ErrorFault

func (*InvalidTypeNameException) ErrorMessage 

func (e *InvalidTypeNameException) ErrorMessage() string

type InvalidUpdate 

type InvalidUpdate struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The update isn't valid.

func (*InvalidUpdate) Error 

func (e *InvalidUpdate) Error() string

func (*InvalidUpdate) ErrorCode 

func (e *InvalidUpdate) ErrorCode() string

func (*InvalidUpdate) ErrorFault 

func (e *InvalidUpdate) ErrorFault() smithy.ErrorFault

func (*InvalidUpdate) ErrorMessage 

func (e *InvalidUpdate) ErrorMessage() string

type InventoryAggregator 

type InventoryAggregator struct {

	// Nested aggregators to further refine aggregation for an inventory type.
	Aggregators []InventoryAggregator

	// The inventory type and attribute name for aggregation.
	Expression *string

	// A user-defined set of one or more filters on which to aggregate inventory data.
	// Groups return a count of resources that match and don't match the specified
	// criteria.
	Groups []InventoryGroup
	// contains filtered or unexported fields
}

Specifies the inventory type and attribute for the aggregation execution.

type InventoryAttributeDataType 

type InventoryAttributeDataType string
const (
	InventoryAttributeDataTypeString InventoryAttributeDataType = "string"
	InventoryAttributeDataTypeNumber InventoryAttributeDataType = "number"
)

Enum values for InventoryAttributeDataType

func (InventoryAttributeDataType) Values added in v0.29.0 

func (InventoryAttributeDataType) Values() []InventoryAttributeDataType

Values returns all known values for InventoryAttributeDataType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InventoryDeletionStatus 

type InventoryDeletionStatus string
const (
	InventoryDeletionStatusInProgress InventoryDeletionStatus = "InProgress"
	InventoryDeletionStatusComplete   InventoryDeletionStatus = "Complete"
)

Enum values for InventoryDeletionStatus

func (InventoryDeletionStatus) Values added in v0.29.0 

func (InventoryDeletionStatus) Values() []InventoryDeletionStatus

Values returns all known values for InventoryDeletionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InventoryDeletionStatusItem 

type InventoryDeletionStatusItem struct {

	// The deletion ID returned by the DeleteInventory operation.
	DeletionId *string

	// The UTC timestamp when the delete operation started.
	DeletionStartTime *time.Time

	// Information about the delete operation. For more information about this
	// summary, see [Understanding the delete inventory summary]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Understanding the delete inventory summary]: https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-custom.html#delete-custom-inventory
	DeletionSummary *InventoryDeletionSummary

	// The status of the operation. Possible values are InProgress and Complete.
	LastStatus InventoryDeletionStatus

	// Information about the status.
	LastStatusMessage *string

	// The UTC timestamp of when the last status report.
	LastStatusUpdateTime *time.Time

	// The name of the inventory data type.
	TypeName *string
	// contains filtered or unexported fields
}

Status information returned by the DeleteInventory operation.

type InventoryDeletionSummary 

type InventoryDeletionSummary struct {

	// Remaining number of items to delete.
	RemainingCount int32

	// A list of counts and versions for deleted items.
	SummaryItems []InventoryDeletionSummaryItem

	// The total number of items to delete. This count doesn't change during the
	// delete operation.
	TotalCount int32
	// contains filtered or unexported fields
}

Information about the delete operation.

type InventoryDeletionSummaryItem 

type InventoryDeletionSummaryItem struct {

	// A count of the number of deleted items.
	Count int32

	// The remaining number of items to delete.
	RemainingCount int32

	// The inventory type version.
	Version *string
	// contains filtered or unexported fields
}

Either a count, remaining count, or a version number in a delete inventory summary.

type InventoryFilter 

type InventoryFilter struct {

	// The name of the filter key.
	//
	// This member is required.
	Key *string

	// Inventory filter values. Example: inventory filter where managed node IDs are
	// specified as values Key=AWS:InstanceInformation.InstanceId,Values=
	// i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal .
	//
	// This member is required.
	Values []string

	// The type of filter.
	//
	// The Exists filter must be used with aggregators. For more information, see [Aggregating inventory data] in
	// the Amazon Web Services Systems Manager User Guide.
	//
	// [Aggregating inventory data]: https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-aggregate.html
	Type InventoryQueryOperatorType
	// contains filtered or unexported fields
}

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

type InventoryGroup 

type InventoryGroup struct {

	// Filters define the criteria for the group. The matchingCount field displays the
	// number of resources that match the criteria. The notMatchingCount field
	// displays the number of resources that don't match the criteria.
	//
	// This member is required.
	Filters []InventoryFilter

	// The name of the group.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

type InventoryItem 

type InventoryItem struct {

	// The time the inventory information was collected.
	//
	// This member is required.
	CaptureTime *string

	// The schema version for the inventory item.
	//
	// This member is required.
	SchemaVersion *string

	// The name of the inventory type. Default inventory item type names start with AWS
	// . Custom inventory type names will start with Custom. Default inventory item
	// types include the following: AWS:AWSComponent , AWS:Application ,
	// AWS:InstanceInformation , AWS:Network , and AWS:WindowsUpdate .
	//
	// This member is required.
	TypeName *string

	// The inventory data of the inventory type.
	Content []map[string]string

	// MD5 hash of the inventory item type contents. The content hash is used to
	// determine whether to update inventory information. The PutInventory API doesn't
	// update the inventory item type contents if the MD5 hash hasn't changed since
	// last update.
	ContentHash *string

	// A map of associated properties for a specified inventory type. For example,
	// with this attribute, you can specify the ExecutionId , ExecutionType ,
	// ComplianceType properties of the AWS:ComplianceItem type.
	Context map[string]string
	// contains filtered or unexported fields
}

Information collected from managed nodes based on your inventory policy document

type InventoryItemAttribute 

type InventoryItemAttribute struct {

	// The data type of the inventory item attribute.
	//
	// This member is required.
	DataType InventoryAttributeDataType

	// Name of the inventory item attribute.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Attributes are the entries within the inventory item content. It contains name and value.

type InventoryItemSchema 

type InventoryItemSchema struct {

	// The schema attributes for inventory. This contains data type and attribute name.
	//
	// This member is required.
	Attributes []InventoryItemAttribute

	// The name of the inventory type. Default inventory item type names start with
	// Amazon Web Services. Custom inventory type names will start with Custom. Default
	// inventory item types include the following: AWS:AWSComponent , AWS:Application ,
	// AWS:InstanceInformation , AWS:Network , and AWS:WindowsUpdate .
	//
	// This member is required.
	TypeName *string

	// The alias name of the inventory type. The alias name is used for display
	// purposes.
	DisplayName *string

	// The schema version for the inventory item.
	Version *string
	// contains filtered or unexported fields
}

The inventory item schema definition. Users can use this to compose inventory query filters.

type InventoryQueryOperatorType 

type InventoryQueryOperatorType string
const (
	InventoryQueryOperatorTypeEqual       InventoryQueryOperatorType = "Equal"
	InventoryQueryOperatorTypeNotEqual    InventoryQueryOperatorType = "NotEqual"
	InventoryQueryOperatorTypeBeginWith   InventoryQueryOperatorType = "BeginWith"
	InventoryQueryOperatorTypeLessThan    InventoryQueryOperatorType = "LessThan"
	InventoryQueryOperatorTypeGreaterThan InventoryQueryOperatorType = "GreaterThan"
	InventoryQueryOperatorTypeExists      InventoryQueryOperatorType = "Exists"
)

Enum values for InventoryQueryOperatorType

func (InventoryQueryOperatorType) Values added in v0.29.0 

func (InventoryQueryOperatorType) Values() []InventoryQueryOperatorType

Values returns all known values for InventoryQueryOperatorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InventoryResultEntity 

type InventoryResultEntity struct {

	// The data section in the inventory result entity JSON.
	Data map[string]InventoryResultItem

	// ID of the inventory result entity. For example, for managed node inventory the
	// result will be the managed node ID. For EC2 instance inventory, the result will
	// be the instance ID.
	Id *string
	// contains filtered or unexported fields
}

Inventory query results.

type InventoryResultItem 

type InventoryResultItem struct {

	// Contains all the inventory data of the item type. Results include attribute
	// names and values.
	//
	// This member is required.
	Content []map[string]string

	// The schema version for the inventory result item/
	//
	// This member is required.
	SchemaVersion *string

	// The name of the inventory result item type.
	//
	// This member is required.
	TypeName *string

	// The time inventory item data was captured.
	CaptureTime *string

	// MD5 hash of the inventory item type contents. The content hash is used to
	// determine whether to update inventory information. The PutInventory API doesn't
	// update the inventory item type contents if the MD5 hash hasn't changed since
	// last update.
	ContentHash *string
	// contains filtered or unexported fields
}

The inventory result item.

type InventorySchemaDeleteOption 

type InventorySchemaDeleteOption string
const (
	InventorySchemaDeleteOptionDisableSchema InventorySchemaDeleteOption = "DisableSchema"
	InventorySchemaDeleteOptionDeleteSchema  InventorySchemaDeleteOption = "DeleteSchema"
)

Enum values for InventorySchemaDeleteOption

func (InventorySchemaDeleteOption) Values added in v0.29.0 

func (InventorySchemaDeleteOption) Values() []InventorySchemaDeleteOption

Values returns all known values for InventorySchemaDeleteOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InvocationDoesNotExist 

type InvocationDoesNotExist struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again.

func (*InvocationDoesNotExist) Error 

func (e *InvocationDoesNotExist) Error() string

func (*InvocationDoesNotExist) ErrorCode 

func (e *InvocationDoesNotExist) ErrorCode() string

func (*InvocationDoesNotExist) ErrorFault 

func (e *InvocationDoesNotExist) ErrorFault() smithy.ErrorFault

func (*InvocationDoesNotExist) ErrorMessage 

func (e *InvocationDoesNotExist) ErrorMessage() string

type ItemContentMismatchException 

type ItemContentMismatchException struct {
	Message *string

	ErrorCodeOverride *string

	TypeName *string
	// contains filtered or unexported fields
}

The inventory item has invalid content.

func (*ItemContentMismatchException) Error 

func (e *ItemContentMismatchException) Error() string

func (*ItemContentMismatchException) ErrorCode 

func (e *ItemContentMismatchException) ErrorCode() string

func (*ItemContentMismatchException) ErrorFault 

func (e *ItemContentMismatchException) ErrorFault() smithy.ErrorFault

func (*ItemContentMismatchException) ErrorMessage 

func (e *ItemContentMismatchException) ErrorMessage() string

type ItemSizeLimitExceededException 

type ItemSizeLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	TypeName *string
	// contains filtered or unexported fields
}

The inventory item size has exceeded the size limit.

func (*ItemSizeLimitExceededException) Error 

func (e *ItemSizeLimitExceededException) Error() string

func (*ItemSizeLimitExceededException) ErrorCode 

func (e *ItemSizeLimitExceededException) ErrorCode() string

func (*ItemSizeLimitExceededException) ErrorFault 

func (e *ItemSizeLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ItemSizeLimitExceededException) ErrorMessage 

func (e *ItemSizeLimitExceededException) ErrorMessage() string

type LastResourceDataSyncStatus 

type LastResourceDataSyncStatus string
const (
	LastResourceDataSyncStatusSuccessful LastResourceDataSyncStatus = "Successful"
	LastResourceDataSyncStatusFailed     LastResourceDataSyncStatus = "Failed"
	LastResourceDataSyncStatusInprogress LastResourceDataSyncStatus = "InProgress"
)

Enum values for LastResourceDataSyncStatus

func (LastResourceDataSyncStatus) Values added in v0.29.0 

func (LastResourceDataSyncStatus) Values() []LastResourceDataSyncStatus

Values returns all known values for LastResourceDataSyncStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LoggingInfo 

type LoggingInfo struct {

	// The name of an S3 bucket where execution logs are stored.
	//
	// This member is required.
	S3BucketName *string

	// The Amazon Web Services Region where the S3 bucket is located.
	//
	// This member is required.
	S3Region *string

	// (Optional) The S3 bucket subfolder.
	S3KeyPrefix *string
	// contains filtered or unexported fields
}

Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

type MaintenanceWindowAutomationParameters 

type MaintenanceWindowAutomationParameters struct {

	// The version of an Automation runbook to use during task execution.
	DocumentVersion *string

	// The parameters for the AUTOMATION task.
	//
	// For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.
	//
	// LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service
	// (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and
	// OutputS3KeyPrefix options in the TaskInvocationParameters structure. For
	// information about how Amazon Web Services Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	//
	// TaskParameters has been deprecated. To specify parameters to pass to a task
	// when it runs, instead use the Parameters option in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options for
	// the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	//
	// For AUTOMATION task types, Amazon Web Services Systems Manager ignores any
	// values specified for these parameters.
	Parameters map[string][]string
	// contains filtered or unexported fields
}

The parameters for an AUTOMATION task type.

type MaintenanceWindowExecution 

type MaintenanceWindowExecution struct {

	// The time the execution finished.
	EndTime *time.Time

	// The time the execution started.
	StartTime *time.Time

	// The status of the execution.
	Status MaintenanceWindowExecutionStatus

	// The details explaining the status. Not available for all status values.
	StatusDetails *string

	// The ID of the maintenance window execution.
	WindowExecutionId *string

	// The ID of the maintenance window.
	WindowId *string
	// contains filtered or unexported fields
}

Describes the information about an execution of a maintenance window.

type MaintenanceWindowExecutionStatus 

type MaintenanceWindowExecutionStatus string
const (
	MaintenanceWindowExecutionStatusPending            MaintenanceWindowExecutionStatus = "PENDING"
	MaintenanceWindowExecutionStatusInProgress         MaintenanceWindowExecutionStatus = "IN_PROGRESS"
	MaintenanceWindowExecutionStatusSuccess            MaintenanceWindowExecutionStatus = "SUCCESS"
	MaintenanceWindowExecutionStatusFailed             MaintenanceWindowExecutionStatus = "FAILED"
	MaintenanceWindowExecutionStatusTimedOut           MaintenanceWindowExecutionStatus = "TIMED_OUT"
	MaintenanceWindowExecutionStatusCancelling         MaintenanceWindowExecutionStatus = "CANCELLING"
	MaintenanceWindowExecutionStatusCancelled          MaintenanceWindowExecutionStatus = "CANCELLED"
	MaintenanceWindowExecutionStatusSkippedOverlapping MaintenanceWindowExecutionStatus = "SKIPPED_OVERLAPPING"
)

Enum values for MaintenanceWindowExecutionStatus

func (MaintenanceWindowExecutionStatus) Values added in v0.29.0 

func (MaintenanceWindowExecutionStatus) Values() []MaintenanceWindowExecutionStatus

Values returns all known values for MaintenanceWindowExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MaintenanceWindowExecutionTaskIdentity 

type MaintenanceWindowExecutionTaskIdentity struct {

	// The details for the CloudWatch alarm applied to your maintenance window task.
	AlarmConfiguration *AlarmConfiguration

	// The time the task execution finished.
	EndTime *time.Time

	// The time the task execution started.
	StartTime *time.Time

	// The status of the task execution.
	Status MaintenanceWindowExecutionStatus

	// The details explaining the status of the task execution. Not available for all
	// status values.
	StatusDetails *string

	// The Amazon Resource Name (ARN) of the task that ran.
	TaskArn *string

	// The ID of the specific task execution in the maintenance window execution.
	TaskExecutionId *string

	// The type of task that ran.
	TaskType MaintenanceWindowTaskType

	// The CloudWatch alarm that was invoked by the maintenance window task.
	TriggeredAlarms []AlarmStateInformation

	// The ID of the maintenance window execution that ran the task.
	WindowExecutionId *string
	// contains filtered or unexported fields
}

Information about a task execution performed as part of a maintenance window execution.

type MaintenanceWindowExecutionTaskInvocationIdentity 

type MaintenanceWindowExecutionTaskInvocationIdentity struct {

	// The time the invocation finished.
	EndTime *time.Time

	// The ID of the action performed in the service that actually handled the task
	// invocation. If the task type is RUN_COMMAND , this value is the command ID.
	ExecutionId *string

	// The ID of the task invocation.
	InvocationId *string

	// User-provided value that was specified when the target was registered with the
	// maintenance window. This was also included in any Amazon CloudWatch Events
	// events raised during the task invocation.
	OwnerInformation *string

	// The parameters that were provided for the invocation when it was run.
	Parameters *string

	// The time the invocation started.
	StartTime *time.Time

	// The status of the task invocation.
	Status MaintenanceWindowExecutionStatus

	// The details explaining the status of the task invocation. Not available for all
	// status values.
	StatusDetails *string

	// The ID of the specific task execution in the maintenance window execution.
	TaskExecutionId *string

	// The task type.
	TaskType MaintenanceWindowTaskType

	// The ID of the maintenance window execution that ran the task.
	WindowExecutionId *string

	// The ID of the target definition in this maintenance window the invocation was
	// performed for.
	WindowTargetId *string
	// contains filtered or unexported fields
}

Describes the information about a task invocation for a particular target as part of a task execution performed as part of a maintenance window execution.

type MaintenanceWindowFilter 

type MaintenanceWindowFilter struct {

	// The name of the filter.
	Key *string

	// The filter values.
	Values []string
	// contains filtered or unexported fields
}

Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use MaintenanceWindowFilter> include the following:

DescribeMaintenanceWindowExecutions

DescribeMaintenanceWindowExecutionTaskInvocations

DescribeMaintenanceWindowExecutionTasks

DescribeMaintenanceWindows

DescribeMaintenanceWindowTargets

DescribeMaintenanceWindowTasks

type MaintenanceWindowIdentity 

type MaintenanceWindowIdentity struct {

	// The number of hours before the end of the maintenance window that Amazon Web
	// Services Systems Manager stops scheduling new tasks for execution.
	Cutoff int32

	// A description of the maintenance window.
	Description *string

	// The duration of the maintenance window in hours.
	Duration *int32

	// Indicates whether the maintenance window is enabled.
	Enabled bool

	// The date and time, in ISO-8601 Extended format, for when the maintenance window
	// is scheduled to become inactive.
	EndDate *string

	// The name of the maintenance window.
	Name *string

	// The next time the maintenance window will actually run, taking into account any
	// specified times for the maintenance window to become active or inactive.
	NextExecutionTime *string

	// The schedule of the maintenance window in the form of a cron or rate expression.
	Schedule *string

	// The number of days to wait to run a maintenance window after the scheduled cron
	// expression date and time.
	ScheduleOffset *int32

	// The time zone that the scheduled maintenance window executions are based on, in
	// Internet Assigned Numbers Authority (IANA) format.
	ScheduleTimezone *string

	// The date and time, in ISO-8601 Extended format, for when the maintenance window
	// is scheduled to become active.
	StartDate *string

	// The ID of the maintenance window.
	WindowId *string
	// contains filtered or unexported fields
}

Information about the maintenance window.

type MaintenanceWindowIdentityForTarget 

type MaintenanceWindowIdentityForTarget struct {

	// The name of the maintenance window.
	Name *string

	// The ID of the maintenance window.
	WindowId *string
	// contains filtered or unexported fields
}

The maintenance window to which the specified target belongs.

type MaintenanceWindowLambdaParameters 

type MaintenanceWindowLambdaParameters struct {

	// Pass client-specific information to the Lambda function that you are invoking.
	// You can then process the client information in your Lambda function as you
	// choose through the context variable.
	ClientContext *string

	// JSON to provide to your Lambda function as input.
	Payload []byte

	// (Optional) Specify an Lambda function version or alias name. If you specify a
	// function version, the operation uses the qualified function Amazon Resource Name
	// (ARN) to invoke a specific Lambda function. If you specify an alias name, the
	// operation uses the alias ARN to invoke the Lambda function version to which the
	// alias points.
	Qualifier *string
	// contains filtered or unexported fields
}

The parameters for a LAMBDA task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

type MaintenanceWindowResourceType 

type MaintenanceWindowResourceType string
const (
	MaintenanceWindowResourceTypeInstance      MaintenanceWindowResourceType = "INSTANCE"
	MaintenanceWindowResourceTypeResourceGroup MaintenanceWindowResourceType = "RESOURCE_GROUP"
)

Enum values for MaintenanceWindowResourceType

func (MaintenanceWindowResourceType) Values added in v0.29.0 

func (MaintenanceWindowResourceType) Values() []MaintenanceWindowResourceType

Values returns all known values for MaintenanceWindowResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MaintenanceWindowRunCommandParameters 

type MaintenanceWindowRunCommandParameters struct {

	// Configuration options for sending command output to Amazon CloudWatch Logs.
	CloudWatchOutputConfig *CloudWatchOutputConfig

	// Information about the commands to run.
	Comment *string

	// The SHA-256 or SHA-1 hash created by the system when the document was created.
	// SHA-1 hashes have been deprecated.
	DocumentHash *string

	// SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
	DocumentHashType DocumentHashType

	// The Amazon Web Services Systems Manager document (SSM document) version to use
	// in the request. You can specify $DEFAULT , $LATEST , or a specific version
	// number. If you run commands by using the Amazon Web Services CLI, then you must
	// escape the first two options by using a backslash. If you specify a version
	// number, then you don't need to use the backslash. For example:
	//
	//     --document-version "\$DEFAULT"
	//
	//     --document-version "\$LATEST"
	//
	//     --document-version "3"
	DocumentVersion *string

	// Configurations for sending notifications about command status changes on a
	// per-managed node basis.
	NotificationConfig *NotificationConfig

	// The name of the Amazon Simple Storage Service (Amazon S3) bucket.
	OutputS3BucketName *string

	// The S3 bucket subfolder.
	OutputS3KeyPrefix *string

	// The parameters for the RUN_COMMAND task execution.
	Parameters map[string][]string

	// The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services
	// Systems Manager to assume when running a maintenance window task. If you do not
	// specify a service role ARN, Systems Manager uses a service-linked role in your
	// account. If no appropriate service-linked role for Systems Manager exists in
	// your account, it is created when you run RegisterTaskWithMaintenanceWindow .
	//
	// However, for an improved security posture, we strongly recommend creating a
	// custom policy and custom service role for running your maintenance window tasks.
	// The policy can be crafted to provide only the permissions needed for your
	// particular maintenance window tasks. For more information, see [Setting up Maintenance Windows]in the in the
	// Amazon Web Services Systems Manager User Guide.
	//
	// [Setting up Maintenance Windows]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html
	ServiceRoleArn *string

	// If this time is reached and the command hasn't already started running, it
	// doesn't run.
	TimeoutSeconds *int32
	// contains filtered or unexported fields
}

The parameters for a RUN_COMMAND task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For RUN_COMMAND tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters .

type MaintenanceWindowStepFunctionsParameters 

type MaintenanceWindowStepFunctionsParameters struct {

	// The inputs for the STEP_FUNCTIONS task.
	Input *string

	// The name of the STEP_FUNCTIONS task.
	Name *string
	// contains filtered or unexported fields
}

The parameters for a STEP_FUNCTIONS task.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For Step Functions tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo .

type MaintenanceWindowTarget 

type MaintenanceWindowTarget struct {

	// A description for the target.
	Description *string

	// The name for the maintenance window target.
	Name *string

	// A user-provided value that will be included in any Amazon CloudWatch Events
	// events that are raised while running tasks for these targets in this maintenance
	// window.
	OwnerInformation *string

	// The type of target that is being registered with the maintenance window.
	ResourceType MaintenanceWindowResourceType

	// The targets, either managed nodes or tags.
	//
	// Specify managed nodes using the following format:
	//
	//     Key=instanceids,Values=,
	//
	// Tags are specified using the following format:
	//
	// Key=,Values= .
	Targets []Target

	// The ID of the maintenance window to register the target with.
	WindowId *string

	// The ID of the target.
	WindowTargetId *string
	// contains filtered or unexported fields
}

The target registered with the maintenance window.

type MaintenanceWindowTask 

type MaintenanceWindowTask struct {

	// The details for the CloudWatch alarm applied to your maintenance window task.
	AlarmConfiguration *AlarmConfiguration

	// The specification for whether tasks should continue to run after the cutoff
	// time specified in the maintenance windows is reached.
	CutoffBehavior MaintenanceWindowTaskCutoffBehavior

	// A description of the task.
	Description *string

	// Information about an S3 bucket to write task-level logs to.
	//
	// LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service
	// (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and
	// OutputS3KeyPrefix options in the TaskInvocationParameters structure. For
	// information about how Amazon Web Services Systems Manager handles these options
	// for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	LoggingInfo *LoggingInfo

	// The maximum number of targets this task can be run for, in parallel.
	//
	// Although this element is listed as "Required: No", a value can be omitted only
	// when you are registering or updating a [targetless task]You must provide a value in all other
	// cases.
	//
	// For maintenance window tasks without a target specified, you can't supply a
	// value for this option. Instead, the system inserts a placeholder value of 1 .
	// This value doesn't affect the running of your task.
	//
	// [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
	MaxConcurrency *string

	// The maximum number of errors allowed before this task stops being scheduled.
	//
	// Although this element is listed as "Required: No", a value can be omitted only
	// when you are registering or updating a [targetless task]You must provide a value in all other
	// cases.
	//
	// For maintenance window tasks without a target specified, you can't supply a
	// value for this option. Instead, the system inserts a placeholder value of 1 .
	// This value doesn't affect the running of your task.
	//
	// [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
	MaxErrors *string

	// The task name.
	Name *string

	// The priority of the task in the maintenance window. The lower the number, the
	// higher the priority. Tasks that have the same priority are scheduled in
	// parallel.
	Priority int32

	// The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services
	// Systems Manager to assume when running a maintenance window task. If you do not
	// specify a service role ARN, Systems Manager uses a service-linked role in your
	// account. If no appropriate service-linked role for Systems Manager exists in
	// your account, it is created when you run RegisterTaskWithMaintenanceWindow .
	//
	// However, for an improved security posture, we strongly recommend creating a
	// custom policy and custom service role for running your maintenance window tasks.
	// The policy can be crafted to provide only the permissions needed for your
	// particular maintenance window tasks. For more information, see [Setting up Maintenance Windows]in the in the
	// Amazon Web Services Systems Manager User Guide.
	//
	// [Setting up Maintenance Windows]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html
	ServiceRoleArn *string

	// The targets (either managed nodes or tags). Managed nodes are specified using
	// Key=instanceids,Values=, . Tags are specified using Key=,Values= .
	Targets []Target

	// The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION
	// task types, TaskArn is the Amazon Web Services Systems Manager (SSM document)
	// name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS
	// tasks, it's the state machine ARN.
	TaskArn *string

	// The parameters that should be passed to the task when it is run.
	//
	// TaskParameters has been deprecated. To specify parameters to pass to a task
	// when it runs, instead use the Parameters option in the TaskInvocationParameters
	// structure. For information about how Systems Manager handles these options for
	// the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
	TaskParameters map[string]MaintenanceWindowTaskParameterValueExpression

	// The type of task.
	Type MaintenanceWindowTaskType

	// The ID of the maintenance window where the task is registered.
	WindowId *string

	// The task ID.
	WindowTaskId *string
	// contains filtered or unexported fields
}

Information about a task defined for a maintenance window.

type MaintenanceWindowTaskCutoffBehavior added in v1.11.0 

type MaintenanceWindowTaskCutoffBehavior string
const (
	MaintenanceWindowTaskCutoffBehaviorContinueTask MaintenanceWindowTaskCutoffBehavior = "CONTINUE_TASK"
	MaintenanceWindowTaskCutoffBehaviorCancelTask   MaintenanceWindowTaskCutoffBehavior = "CANCEL_TASK"
)

Enum values for MaintenanceWindowTaskCutoffBehavior

func (MaintenanceWindowTaskCutoffBehavior) Values added in v1.11.0 

func (MaintenanceWindowTaskCutoffBehavior) Values() []MaintenanceWindowTaskCutoffBehavior

Values returns all known values for MaintenanceWindowTaskCutoffBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MaintenanceWindowTaskInvocationParameters 

type MaintenanceWindowTaskInvocationParameters struct {

	// The parameters for an AUTOMATION task type.
	Automation *MaintenanceWindowAutomationParameters

	// The parameters for a LAMBDA task type.
	Lambda *MaintenanceWindowLambdaParameters

	// The parameters for a RUN_COMMAND task type.
	RunCommand *MaintenanceWindowRunCommandParameters

	// The parameters for a STEP_FUNCTIONS task type.
	StepFunctions *MaintenanceWindowStepFunctionsParameters
	// contains filtered or unexported fields
}

The parameters for task execution.

type MaintenanceWindowTaskParameterValueExpression 

type MaintenanceWindowTaskParameterValueExpression struct {

	// This field contains an array of 0 or more strings, each 1 to 255 characters in
	// length.
	Values []string
	// contains filtered or unexported fields
}

Defines the values for a task parameter.

type MaintenanceWindowTaskType 

type MaintenanceWindowTaskType string
const (
	MaintenanceWindowTaskTypeRunCommand    MaintenanceWindowTaskType = "RUN_COMMAND"
	MaintenanceWindowTaskTypeAutomation    MaintenanceWindowTaskType = "AUTOMATION"
	MaintenanceWindowTaskTypeStepFunctions MaintenanceWindowTaskType = "STEP_FUNCTIONS"
	MaintenanceWindowTaskTypeLambda        MaintenanceWindowTaskType = "LAMBDA"
)

Enum values for MaintenanceWindowTaskType

func (MaintenanceWindowTaskType) Values added in v0.29.0 

func (MaintenanceWindowTaskType) Values() []MaintenanceWindowTaskType

Values returns all known values for MaintenanceWindowTaskType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MalformedResourcePolicyDocumentException added in v1.48.0 

type MalformedResourcePolicyDocumentException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.

func (*MalformedResourcePolicyDocumentException) Error added in v1.48.0 

func (e *MalformedResourcePolicyDocumentException) Error() string

func (*MalformedResourcePolicyDocumentException) ErrorCode added in v1.48.0 

func (e *MalformedResourcePolicyDocumentException) ErrorCode() string

func (*MalformedResourcePolicyDocumentException) ErrorFault added in v1.48.0 

func (e *MalformedResourcePolicyDocumentException) ErrorFault() smithy.ErrorFault

func (*MalformedResourcePolicyDocumentException) ErrorMessage added in v1.48.0 

func (e *MalformedResourcePolicyDocumentException) ErrorMessage() string

type MaxDocumentSizeExceeded 

type MaxDocumentSizeExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The size limit of a document is 64 KB.

func (*MaxDocumentSizeExceeded) Error 

func (e *MaxDocumentSizeExceeded) Error() string

func (*MaxDocumentSizeExceeded) ErrorCode 

func (e *MaxDocumentSizeExceeded) ErrorCode() string

func (*MaxDocumentSizeExceeded) ErrorFault 

func (e *MaxDocumentSizeExceeded) ErrorFault() smithy.ErrorFault

func (*MaxDocumentSizeExceeded) ErrorMessage 

func (e *MaxDocumentSizeExceeded) ErrorMessage() string

type MetadataValue added in v0.31.0 

type MetadataValue struct {

	// Metadata value to assign to an Application Manager application.
	Value *string
	// contains filtered or unexported fields
}

Metadata to assign to an Application Manager application.

type NonCompliantSummary 

type NonCompliantSummary struct {

	// The total number of compliance items that aren't compliant.
	NonCompliantCount int32

	// A summary of the non-compliance severity by compliance type
	SeveritySummary *SeveritySummary
	// contains filtered or unexported fields
}

A summary of resources that aren't compliant. The summary is organized according to resource type.

type NotificationConfig 

type NotificationConfig struct {

	// An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon
	// SNS) topic. Run Command pushes notifications about command status changes to
	// this topic.
	NotificationArn *string

	// The different events for which you can receive notifications. To learn more
	// about these events, see [Monitoring Systems Manager status changes using Amazon SNS notifications]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Monitoring Systems Manager status changes using Amazon SNS notifications]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html
	NotificationEvents []NotificationEvent

	// The type of notification.
	//
	//   - Command : Receive notification when the status of a command changes.
	//
	//   - Invocation : For commands sent to multiple managed nodes, receive
	//   notification on a per-node basis when the status of a command changes.
	NotificationType NotificationType
	// contains filtered or unexported fields
}

Configurations for sending notifications.

type NotificationEvent 

type NotificationEvent string
const (
	NotificationEventAll        NotificationEvent = "All"
	NotificationEventInProgress NotificationEvent = "InProgress"
	NotificationEventSuccess    NotificationEvent = "Success"
	NotificationEventTimedOut   NotificationEvent = "TimedOut"
	NotificationEventCancelled  NotificationEvent = "Cancelled"
	NotificationEventFailed     NotificationEvent = "Failed"
)

Enum values for NotificationEvent

func (NotificationEvent) Values added in v0.29.0 

func (NotificationEvent) Values() []NotificationEvent

Values returns all known values for NotificationEvent. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NotificationType 

type NotificationType string
const (
	NotificationTypeCommand    NotificationType = "Command"
	NotificationTypeInvocation NotificationType = "Invocation"
)

Enum values for NotificationType

func (NotificationType) Values added in v0.29.0 

func (NotificationType) Values() []NotificationType

Values returns all known values for NotificationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OperatingSystem 

type OperatingSystem string
const (
	OperatingSystemWindows               OperatingSystem = "WINDOWS"
	OperatingSystemAmazonLinux           OperatingSystem = "AMAZON_LINUX"
	OperatingSystemAmazonLinux2          OperatingSystem = "AMAZON_LINUX_2"
	OperatingSystemAmazonLinux2022       OperatingSystem = "AMAZON_LINUX_2022"
	OperatingSystemUbuntu                OperatingSystem = "UBUNTU"
	OperatingSystemRedhatEnterpriseLinux OperatingSystem = "REDHAT_ENTERPRISE_LINUX"
	OperatingSystemSuse                  OperatingSystem = "SUSE"
	OperatingSystemCentOS                OperatingSystem = "CENTOS"
	OperatingSystemOracleLinux           OperatingSystem = "ORACLE_LINUX"
	OperatingSystemDebian                OperatingSystem = "DEBIAN"
	OperatingSystemMacOS                 OperatingSystem = "MACOS"
	OperatingSystemRaspbian              OperatingSystem = "RASPBIAN"
	OperatingSystemRockyLinux            OperatingSystem = "ROCKY_LINUX"
	OperatingSystemAlmaLinux             OperatingSystem = "ALMA_LINUX"
	OperatingSystemAmazonLinux2023       OperatingSystem = "AMAZON_LINUX_2023"
)

Enum values for OperatingSystem

func (OperatingSystem) Values added in v0.29.0 

func (OperatingSystem) Values() []OperatingSystem

Values returns all known values for OperatingSystem. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsAggregator 

type OpsAggregator struct {

	// Either a Range or Count aggregator for limiting an OpsData summary.
	AggregatorType *string

	// A nested aggregator for viewing counts of OpsData.
	Aggregators []OpsAggregator

	// The name of an OpsData attribute on which to limit the count of OpsData.
	AttributeName *string

	// The aggregator filters.
	Filters []OpsFilter

	// The data type name to use for viewing counts of OpsData.
	TypeName *string

	// The aggregator value.
	Values map[string]string
	// contains filtered or unexported fields
}

One or more aggregators for viewing counts of OpsData using different dimensions such as Source , CreatedTime , or Source and CreatedTime , to name a few.

type OpsEntity 

type OpsEntity struct {

	// The data returned by the query.
	Data map[string]OpsEntityItem

	// The query ID.
	Id *string
	// contains filtered or unexported fields
}

The result of the query.

type OpsEntityItem 

type OpsEntityItem struct {

	// The time the OpsData was captured.
	CaptureTime *string

	// The details of an OpsData summary.
	Content []map[string]string
	// contains filtered or unexported fields
}

The OpsData summary.

type OpsFilter 

type OpsFilter struct {

	// The name of the filter.
	//
	// This member is required.
	Key *string

	// The filter value.
	//
	// This member is required.
	Values []string

	// The type of filter.
	Type OpsFilterOperatorType
	// contains filtered or unexported fields
}

A filter for viewing OpsData summaries.

type OpsFilterOperatorType 

type OpsFilterOperatorType string
const (
	OpsFilterOperatorTypeEqual       OpsFilterOperatorType = "Equal"
	OpsFilterOperatorTypeNotEqual    OpsFilterOperatorType = "NotEqual"
	OpsFilterOperatorTypeBeginWith   OpsFilterOperatorType = "BeginWith"
	OpsFilterOperatorTypeLessThan    OpsFilterOperatorType = "LessThan"
	OpsFilterOperatorTypeGreaterThan OpsFilterOperatorType = "GreaterThan"
	OpsFilterOperatorTypeExists      OpsFilterOperatorType = "Exists"
)

Enum values for OpsFilterOperatorType

func (OpsFilterOperatorType) Values added in v0.29.0 

func (OpsFilterOperatorType) Values() []OpsFilterOperatorType

Values returns all known values for OpsFilterOperatorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItem 

type OpsItem struct {

	// The time a runbook workflow ended. Currently reported only for the OpsItem type
	// /aws/changerequest .
	ActualEndTime *time.Time

	// The time a runbook workflow started. Currently reported only for the OpsItem
	// type /aws/changerequest .
	ActualStartTime *time.Time

	// An OpsItem category. Category options include: Availability, Cost, Performance,
	// Recovery, Security.
	Category *string

	// The ARN of the Amazon Web Services account that created the OpsItem.
	CreatedBy *string

	// The date and time the OpsItem was created.
	CreatedTime *time.Time

	// The OpsItem description.
	Description *string

	// The ARN of the Amazon Web Services account that last updated the OpsItem.
	LastModifiedBy *string

	// The date and time the OpsItem was last updated.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon
	// SNS) topic where notifications are sent when this OpsItem is edited or changed.
	Notifications []OpsItemNotification

	// Operational data is custom data that provides useful reference details about
	// the OpsItem. For example, you can specify log files, error strings, license
	// keys, troubleshooting tips, or other relevant data. You enter operational data
	// as key-value pairs. The key has a maximum length of 128 characters. The value
	// has a maximum size of 20 KB.
	//
	// Operational data keys can't begin with the following: amazon , aws , amzn , ssm
	// , /amazon , /aws , /amzn , /ssm .
	//
	// You can choose to make the data searchable by other users in the account or you
	// can restrict search access. Searchable data means that all users with access to
	// the OpsItem Overview page (as provided by the DescribeOpsItemsAPI operation) can view and
	// search on the specified data. Operational data that isn't searchable is only
	// viewable by users who have access to the OpsItem (as provided by the GetOpsItemAPI
	// operation).
	//
	// Use the /aws/resources key in OperationalData to specify a related resource in
	// the request. Use the /aws/automations key in OperationalData to associate an
	// Automation runbook with the OpsItem. To view Amazon Web Services CLI example
	// commands that use these keys, see [Creating OpsItems manually]in the Amazon Web Services Systems Manager
	// User Guide.
	//
	// [Creating OpsItems manually]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html
	OperationalData map[string]OpsItemDataValue

	// The OpsItem Amazon Resource Name (ARN).
	OpsItemArn *string

	// The ID of the OpsItem.
	OpsItemId *string

	// The type of OpsItem. Systems Manager supports the following types of OpsItems:
	//
	//   - /aws/issue
	//
	// This type of OpsItem is used for default OpsItems created by OpsCenter.
	//
	//   - /aws/changerequest
	//
	// This type of OpsItem is used by Change Manager for reviewing and approving or
	//   rejecting change requests.
	//
	//   - /aws/insight
	//
	// This type of OpsItem is used by OpsCenter for aggregating and reporting on
	//   duplicate OpsItems.
	OpsItemType *string

	// The time specified in a change request for a runbook workflow to end. Currently
	// supported only for the OpsItem type /aws/changerequest .
	PlannedEndTime *time.Time

	// The time specified in a change request for a runbook workflow to start.
	// Currently supported only for the OpsItem type /aws/changerequest .
	PlannedStartTime *time.Time

	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int32

	// One or more OpsItems that share something in common with the current OpsItem.
	// For example, related OpsItems can include OpsItems with similar error messages,
	// impacted resources, or statuses for the impacted resource.
	RelatedOpsItems []RelatedOpsItem

	// The severity of the OpsItem. Severity options range from 1 to 4.
	Severity *string

	// The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted
	// resource is a subset of source.
	Source *string

	// The OpsItem status. For more information, see [Editing OpsItem details] in the Amazon Web Services
	// Systems Manager User Guide.
	//
	// [Editing OpsItem details]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html
	Status OpsItemStatus

	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	Title *string

	// The version of this OpsItem. Each time the OpsItem is edited the version number
	// increments by one.
	Version *string
	// contains filtered or unexported fields
}

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their Amazon Web Services resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can configure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any Amazon Web Services service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with Amazon Web Services resources from a single console.

To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the Amazon Web Services resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the Amazon Web Services resource, OpsCenter aggregates information from Config, CloudTrail logs, and EventBridge, so you don't have to navigate across multiple console pages during your investigation. For more information, see Amazon Web Services Systems Manager OpsCenterin the Amazon Web Services Systems Manager User Guide.

type OpsItemAccessDeniedException added in v1.33.0 

type OpsItemAccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.

func (*OpsItemAccessDeniedException) Error added in v1.33.0 

func (e *OpsItemAccessDeniedException) Error() string

func (*OpsItemAccessDeniedException) ErrorCode added in v1.33.0 

func (e *OpsItemAccessDeniedException) ErrorCode() string

func (*OpsItemAccessDeniedException) ErrorFault added in v1.33.0 

func (e *OpsItemAccessDeniedException) ErrorFault() smithy.ErrorFault

func (*OpsItemAccessDeniedException) ErrorMessage added in v1.33.0 

func (e *OpsItemAccessDeniedException) ErrorMessage() string

type OpsItemAlreadyExistsException 

type OpsItemAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	OpsItemId *string
	// contains filtered or unexported fields
}

The OpsItem already exists.

func (*OpsItemAlreadyExistsException) Error 

func (e *OpsItemAlreadyExistsException) Error() string

func (*OpsItemAlreadyExistsException) ErrorCode 

func (e *OpsItemAlreadyExistsException) ErrorCode() string

func (*OpsItemAlreadyExistsException) ErrorFault 

func (e *OpsItemAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*OpsItemAlreadyExistsException) ErrorMessage 

func (e *OpsItemAlreadyExistsException) ErrorMessage() string

type OpsItemConflictException added in v1.39.0 

type OpsItemConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified OpsItem is in the process of being deleted.

func (*OpsItemConflictException) Error added in v1.39.0 

func (e *OpsItemConflictException) Error() string

func (*OpsItemConflictException) ErrorCode added in v1.39.0 

func (e *OpsItemConflictException) ErrorCode() string

func (*OpsItemConflictException) ErrorFault added in v1.39.0 

func (e *OpsItemConflictException) ErrorFault() smithy.ErrorFault

func (*OpsItemConflictException) ErrorMessage added in v1.39.0 

func (e *OpsItemConflictException) ErrorMessage() string

type OpsItemDataType 

type OpsItemDataType string
const (
	OpsItemDataTypeSearchableString OpsItemDataType = "SearchableString"
	OpsItemDataTypeString           OpsItemDataType = "String"
)

Enum values for OpsItemDataType

func (OpsItemDataType) Values added in v0.29.0 

func (OpsItemDataType) Values() []OpsItemDataType

Values returns all known values for OpsItemDataType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemDataValue 

type OpsItemDataValue struct {

	// The type of key-value pair. Valid types include SearchableString and String .
	Type OpsItemDataType

	// The value of the OperationalData key.
	Value *string
	// contains filtered or unexported fields
}

An object that defines the value of the key and its type in the OperationalData map.

type OpsItemEventFilter added in v0.31.0 

type OpsItemEventFilter struct {

	// The name of the filter key. Currently, the only supported value is OpsItemId .
	//
	// This member is required.
	Key OpsItemEventFilterKey

	// The operator used by the filter call. Currently, the only supported value is
	// Equal .
	//
	// This member is required.
	Operator OpsItemEventFilterOperator

	// The values for the filter, consisting of one or more OpsItem IDs.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Describes a filter for a specific list of OpsItem events. You can filter event information by using tags. You specify tags by using a key-value pair mapping.

type OpsItemEventFilterKey added in v0.31.0 

type OpsItemEventFilterKey string
const (
	OpsItemEventFilterKeyOpsitemId OpsItemEventFilterKey = "OpsItemId"
)

Enum values for OpsItemEventFilterKey

func (OpsItemEventFilterKey) Values added in v0.31.0 

func (OpsItemEventFilterKey) Values() []OpsItemEventFilterKey

Values returns all known values for OpsItemEventFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemEventFilterOperator added in v0.31.0 

type OpsItemEventFilterOperator string
const (
	OpsItemEventFilterOperatorEqual OpsItemEventFilterOperator = "Equal"
)

Enum values for OpsItemEventFilterOperator

func (OpsItemEventFilterOperator) Values added in v0.31.0 

func (OpsItemEventFilterOperator) Values() []OpsItemEventFilterOperator

Values returns all known values for OpsItemEventFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemEventSummary added in v0.31.0 

type OpsItemEventSummary struct {

	// Information about the user or resource that created the OpsItem event.
	CreatedBy *OpsItemIdentity

	// The date and time the OpsItem event was created.
	CreatedTime *time.Time

	// Specific information about the OpsItem event.
	Detail *string

	// The type of information provided as a detail.
	DetailType *string

	// The ID of the OpsItem event.
	EventId *string

	// The ID of the OpsItem.
	OpsItemId *string

	// The source of the OpsItem event.
	Source *string
	// contains filtered or unexported fields
}

Summary information about an OpsItem event or that associated an OpsItem with a related item.

type OpsItemFilter 

type OpsItemFilter struct {

	// The name of the filter.
	//
	// This member is required.
	Key OpsItemFilterKey

	// The operator used by the filter call.
	//
	// This member is required.
	Operator OpsItemFilterOperator

	// The filter value.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Describes an OpsItem filter.

type OpsItemFilterKey 

type OpsItemFilterKey string
const (
	OpsItemFilterKeyStatus                            OpsItemFilterKey = "Status"
	OpsItemFilterKeyCreatedBy                         OpsItemFilterKey = "CreatedBy"
	OpsItemFilterKeySource                            OpsItemFilterKey = "Source"
	OpsItemFilterKeyPriority                          OpsItemFilterKey = "Priority"
	OpsItemFilterKeyTitle                             OpsItemFilterKey = "Title"
	OpsItemFilterKeyOpsitemId                         OpsItemFilterKey = "OpsItemId"
	OpsItemFilterKeyCreatedTime                       OpsItemFilterKey = "CreatedTime"
	OpsItemFilterKeyLastModifiedTime                  OpsItemFilterKey = "LastModifiedTime"
	OpsItemFilterKeyActualStartTime                   OpsItemFilterKey = "ActualStartTime"
	OpsItemFilterKeyActualEndTime                     OpsItemFilterKey = "ActualEndTime"
	OpsItemFilterKeyPlannedStartTime                  OpsItemFilterKey = "PlannedStartTime"
	OpsItemFilterKeyPlannedEndTime                    OpsItemFilterKey = "PlannedEndTime"
	OpsItemFilterKeyOperationalData                   OpsItemFilterKey = "OperationalData"
	OpsItemFilterKeyOperationalDataKey                OpsItemFilterKey = "OperationalDataKey"
	OpsItemFilterKeyOperationalDataValue              OpsItemFilterKey = "OperationalDataValue"
	OpsItemFilterKeyResourceId                        OpsItemFilterKey = "ResourceId"
	OpsItemFilterKeyAutomationId                      OpsItemFilterKey = "AutomationId"
	OpsItemFilterKeyCategory                          OpsItemFilterKey = "Category"
	OpsItemFilterKeySeverity                          OpsItemFilterKey = "Severity"
	OpsItemFilterKeyOpsitemType                       OpsItemFilterKey = "OpsItemType"
	OpsItemFilterKeyChangeRequestRequesterArn         OpsItemFilterKey = "ChangeRequestByRequesterArn"
	OpsItemFilterKeyChangeRequestRequesterName        OpsItemFilterKey = "ChangeRequestByRequesterName"
	OpsItemFilterKeyChangeRequestApproverArn          OpsItemFilterKey = "ChangeRequestByApproverArn"
	OpsItemFilterKeyChangeRequestApproverName         OpsItemFilterKey = "ChangeRequestByApproverName"
	OpsItemFilterKeyChangeRequestTemplate             OpsItemFilterKey = "ChangeRequestByTemplate"
	OpsItemFilterKeyChangeRequestTargetsResourceGroup OpsItemFilterKey = "ChangeRequestByTargetsResourceGroup"
	OpsItemFilterKeyInsightType                       OpsItemFilterKey = "InsightByType"
	OpsItemFilterKeyAccountId                         OpsItemFilterKey = "AccountId"
)

Enum values for OpsItemFilterKey

func (OpsItemFilterKey) Values added in v0.29.0 

func (OpsItemFilterKey) Values() []OpsItemFilterKey

Values returns all known values for OpsItemFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemFilterOperator 

type OpsItemFilterOperator string
const (
	OpsItemFilterOperatorEqual       OpsItemFilterOperator = "Equal"
	OpsItemFilterOperatorContains    OpsItemFilterOperator = "Contains"
	OpsItemFilterOperatorGreaterThan OpsItemFilterOperator = "GreaterThan"
	OpsItemFilterOperatorLessThan    OpsItemFilterOperator = "LessThan"
)

Enum values for OpsItemFilterOperator

func (OpsItemFilterOperator) Values added in v0.29.0 

func (OpsItemFilterOperator) Values() []OpsItemFilterOperator

Values returns all known values for OpsItemFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemIdentity added in v0.31.0 

type OpsItemIdentity struct {

	// The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.
	Arn *string
	// contains filtered or unexported fields
}

Information about the user or resource that created an OpsItem event.

type OpsItemInvalidParameterException 

type OpsItemInvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string

	ParameterNames []string
	// contains filtered or unexported fields
}

A specified parameter argument isn't valid. Verify the available arguments and try again.

func (*OpsItemInvalidParameterException) Error 

func (e *OpsItemInvalidParameterException) Error() string

func (*OpsItemInvalidParameterException) ErrorCode 

func (e *OpsItemInvalidParameterException) ErrorCode() string

func (*OpsItemInvalidParameterException) ErrorFault 

func (e *OpsItemInvalidParameterException) ErrorFault() smithy.ErrorFault

func (*OpsItemInvalidParameterException) ErrorMessage 

func (e *OpsItemInvalidParameterException) ErrorMessage() string

type OpsItemLimitExceededException 

type OpsItemLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceTypes []string
	Limit         int32
	LimitType     *string
	// contains filtered or unexported fields
}

The request caused OpsItems to exceed one or more quotas.

func (*OpsItemLimitExceededException) Error 

func (e *OpsItemLimitExceededException) Error() string

func (*OpsItemLimitExceededException) ErrorCode 

func (e *OpsItemLimitExceededException) ErrorCode() string

func (*OpsItemLimitExceededException) ErrorFault 

func (e *OpsItemLimitExceededException) ErrorFault() smithy.ErrorFault

func (*OpsItemLimitExceededException) ErrorMessage 

func (e *OpsItemLimitExceededException) ErrorMessage() string

type OpsItemNotFoundException 

type OpsItemNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified OpsItem ID doesn't exist. Verify the ID and try again.

func (*OpsItemNotFoundException) Error 

func (e *OpsItemNotFoundException) Error() string

func (*OpsItemNotFoundException) ErrorCode 

func (e *OpsItemNotFoundException) ErrorCode() string

func (*OpsItemNotFoundException) ErrorFault 

func (e *OpsItemNotFoundException) ErrorFault() smithy.ErrorFault

func (*OpsItemNotFoundException) ErrorMessage 

func (e *OpsItemNotFoundException) ErrorMessage() string

type OpsItemNotification 

type OpsItemNotification struct {

	// The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon
	// SNS) topic where notifications are sent when this OpsItem is edited or changed.
	Arn *string
	// contains filtered or unexported fields
}

A notification about the OpsItem.

type OpsItemRelatedItemAlreadyExistsException added in v1.6.0 

type OpsItemRelatedItemAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceUri *string
	OpsItemId   *string
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) is already associated with the OpsItem.

func (*OpsItemRelatedItemAlreadyExistsException) Error added in v1.6.0 

func (e *OpsItemRelatedItemAlreadyExistsException) Error() string

func (*OpsItemRelatedItemAlreadyExistsException) ErrorCode added in v1.6.0 

func (e *OpsItemRelatedItemAlreadyExistsException) ErrorCode() string

func (*OpsItemRelatedItemAlreadyExistsException) ErrorFault added in v1.6.0 

func (e *OpsItemRelatedItemAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*OpsItemRelatedItemAlreadyExistsException) ErrorMessage added in v1.6.0 

func (e *OpsItemRelatedItemAlreadyExistsException) ErrorMessage() string

type OpsItemRelatedItemAssociationNotFoundException added in v1.6.0 

type OpsItemRelatedItemAssociationNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The association wasn't found using the parameters you specified in the call. Verify the information and try again.

func (*OpsItemRelatedItemAssociationNotFoundException) Error added in v1.6.0 

func (e *OpsItemRelatedItemAssociationNotFoundException) Error() string

func (*OpsItemRelatedItemAssociationNotFoundException) ErrorCode added in v1.6.0 

func (e *OpsItemRelatedItemAssociationNotFoundException) ErrorCode() string

func (*OpsItemRelatedItemAssociationNotFoundException) ErrorFault added in v1.6.0 

func (e *OpsItemRelatedItemAssociationNotFoundException) ErrorFault() smithy.ErrorFault

func (*OpsItemRelatedItemAssociationNotFoundException) ErrorMessage added in v1.6.0 

func (e *OpsItemRelatedItemAssociationNotFoundException) ErrorMessage() string

type OpsItemRelatedItemSummary added in v1.6.0 

type OpsItemRelatedItemSummary struct {

	// The association ID.
	AssociationId *string

	// The association type.
	AssociationType *string

	// Information about the user or resource that created an OpsItem event.
	CreatedBy *OpsItemIdentity

	// The time the related-item association was created.
	CreatedTime *time.Time

	// Information about the user or resource that created an OpsItem event.
	LastModifiedBy *OpsItemIdentity

	// The time the related-item association was last updated.
	LastModifiedTime *time.Time

	// The OpsItem ID.
	OpsItemId *string

	// The resource type.
	ResourceType *string

	// The Amazon Resource Name (ARN) of the related-item resource.
	ResourceUri *string
	// contains filtered or unexported fields
}

Summary information about related-item resources for an OpsItem.

type OpsItemRelatedItemsFilter added in v1.6.0 

type OpsItemRelatedItemsFilter struct {

	// The name of the filter key. Supported values include ResourceUri , ResourceType
	// , or AssociationId .
	//
	// This member is required.
	Key OpsItemRelatedItemsFilterKey

	// The operator used by the filter call. The only supported operator is EQUAL .
	//
	// This member is required.
	Operator OpsItemRelatedItemsFilterOperator

	// The values for the filter.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Describes a filter for a specific list of related-item resources.

type OpsItemRelatedItemsFilterKey added in v1.6.0 

type OpsItemRelatedItemsFilterKey string
const (
	OpsItemRelatedItemsFilterKeyResourceType  OpsItemRelatedItemsFilterKey = "ResourceType"
	OpsItemRelatedItemsFilterKeyAssociationId OpsItemRelatedItemsFilterKey = "AssociationId"
	OpsItemRelatedItemsFilterKeyResourceUri   OpsItemRelatedItemsFilterKey = "ResourceUri"
)

Enum values for OpsItemRelatedItemsFilterKey

func (OpsItemRelatedItemsFilterKey) Values added in v1.6.0 

func (OpsItemRelatedItemsFilterKey) Values() []OpsItemRelatedItemsFilterKey

Values returns all known values for OpsItemRelatedItemsFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemRelatedItemsFilterOperator added in v1.6.0 

type OpsItemRelatedItemsFilterOperator string
const (
	OpsItemRelatedItemsFilterOperatorEqual OpsItemRelatedItemsFilterOperator = "Equal"
)

Enum values for OpsItemRelatedItemsFilterOperator

func (OpsItemRelatedItemsFilterOperator) Values added in v1.6.0 

func (OpsItemRelatedItemsFilterOperator) Values() []OpsItemRelatedItemsFilterOperator

Values returns all known values for OpsItemRelatedItemsFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemStatus 

type OpsItemStatus string
const (
	OpsItemStatusOpen                           OpsItemStatus = "Open"
	OpsItemStatusInProgress                     OpsItemStatus = "InProgress"
	OpsItemStatusResolved                       OpsItemStatus = "Resolved"
	OpsItemStatusPending                        OpsItemStatus = "Pending"
	OpsItemStatusTimedOut                       OpsItemStatus = "TimedOut"
	OpsItemStatusCancelling                     OpsItemStatus = "Cancelling"
	OpsItemStatusCancelled                      OpsItemStatus = "Cancelled"
	OpsItemStatusFailed                         OpsItemStatus = "Failed"
	OpsItemStatusCompletedWithSuccess           OpsItemStatus = "CompletedWithSuccess"
	OpsItemStatusCompletedWithFailure           OpsItemStatus = "CompletedWithFailure"
	OpsItemStatusScheduled                      OpsItemStatus = "Scheduled"
	OpsItemStatusRunbookInProgress              OpsItemStatus = "RunbookInProgress"
	OpsItemStatusPendingChangeCalendarOverride  OpsItemStatus = "PendingChangeCalendarOverride"
	OpsItemStatusChangeCalendarOverrideApproved OpsItemStatus = "ChangeCalendarOverrideApproved"
	OpsItemStatusChangeCalendarOverrideRejected OpsItemStatus = "ChangeCalendarOverrideRejected"
	OpsItemStatusPendingApproval                OpsItemStatus = "PendingApproval"
	OpsItemStatusApproved                       OpsItemStatus = "Approved"
	OpsItemStatusRejected                       OpsItemStatus = "Rejected"
	OpsItemStatusClosed                         OpsItemStatus = "Closed"
)

Enum values for OpsItemStatus

func (OpsItemStatus) Values added in v0.29.0 

func (OpsItemStatus) Values() []OpsItemStatus

Values returns all known values for OpsItemStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OpsItemSummary 

type OpsItemSummary struct {

	// The time a runbook workflow ended. Currently reported only for the OpsItem type
	// /aws/changerequest .
	ActualEndTime *time.Time

	// The time a runbook workflow started. Currently reported only for the OpsItem
	// type /aws/changerequest .
	ActualStartTime *time.Time

	// A list of OpsItems by category.
	Category *string

	// The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
	CreatedBy *string

	// The date and time the OpsItem was created.
	CreatedTime *time.Time

	// The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.
	LastModifiedBy *string

	// The date and time the OpsItem was last updated.
	LastModifiedTime *time.Time

	// Operational data is custom data that provides useful reference details about
	// the OpsItem.
	OperationalData map[string]OpsItemDataValue

	// The ID of the OpsItem.
	OpsItemId *string

	// The type of OpsItem. Systems Manager supports the following types of OpsItems:
	//
	//   - /aws/issue
	//
	// This type of OpsItem is used for default OpsItems created by OpsCenter.
	//
	//   - /aws/changerequest
	//
	// This type of OpsItem is used by Change Manager for reviewing and approving or
	//   rejecting change requests.
	//
	//   - /aws/insight
	//
	// This type of OpsItem is used by OpsCenter for aggregating and reporting on
	//   duplicate OpsItems.
	OpsItemType *string

	// The time specified in a change request for a runbook workflow to end. Currently
	// supported only for the OpsItem type /aws/changerequest .
	PlannedEndTime *time.Time

	// The time specified in a change request for a runbook workflow to start.
	// Currently supported only for the OpsItem type /aws/changerequest .
	PlannedStartTime *time.Time

	// The importance of this OpsItem in relation to other OpsItems in the system.
	Priority *int32

	// A list of OpsItems by severity.
	Severity *string

	// The impacted Amazon Web Services resource.
	Source *string

	// The OpsItem status.
	Status OpsItemStatus

	// A short heading that describes the nature of the OpsItem and the impacted
	// resource.
	Title *string
	// contains filtered or unexported fields
}

A count of OpsItems.

type OpsMetadata added in v0.31.0 

type OpsMetadata struct {

	// The date the OpsMetadata objects was created.
	CreationDate *time.Time

	// The date the OpsMetadata object was last updated.
	LastModifiedDate *time.Time

	// The user name who last updated the OpsMetadata object.
	LastModifiedUser *string

	// The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
	OpsMetadataArn *string

	// The ID of the Application Manager application.
	ResourceId *string
	// contains filtered or unexported fields
}

Operational metadata for an application in Application Manager.

type OpsMetadataAlreadyExistsException added in v0.31.0 

type OpsMetadataAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An OpsMetadata object already exists for the selected resource.

func (*OpsMetadataAlreadyExistsException) Error added in v0.31.0 

func (e *OpsMetadataAlreadyExistsException) Error() string

func (*OpsMetadataAlreadyExistsException) ErrorCode added in v0.31.0 

func (e *OpsMetadataAlreadyExistsException) ErrorCode() string

func (*OpsMetadataAlreadyExistsException) ErrorFault added in v0.31.0 

func (e *OpsMetadataAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*OpsMetadataAlreadyExistsException) ErrorMessage added in v0.31.0 

func (e *OpsMetadataAlreadyExistsException) ErrorMessage() string

type OpsMetadataFilter added in v0.31.0 

type OpsMetadataFilter struct {

	// A filter key.
	//
	// This member is required.
	Key *string

	// A filter value.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

A filter to limit the number of OpsMetadata objects displayed.

type OpsMetadataInvalidArgumentException added in v0.31.0 

type OpsMetadataInvalidArgumentException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One of the arguments passed is invalid.

func (*OpsMetadataInvalidArgumentException) Error added in v0.31.0 

func (e *OpsMetadataInvalidArgumentException) Error() string

func (*OpsMetadataInvalidArgumentException) ErrorCode added in v0.31.0 

func (e *OpsMetadataInvalidArgumentException) ErrorCode() string

func (*OpsMetadataInvalidArgumentException) ErrorFault added in v0.31.0 

func (e *OpsMetadataInvalidArgumentException) ErrorFault() smithy.ErrorFault

func (*OpsMetadataInvalidArgumentException) ErrorMessage added in v0.31.0 

func (e *OpsMetadataInvalidArgumentException) ErrorMessage() string

type OpsMetadataKeyLimitExceededException added in v0.31.0 

type OpsMetadataKeyLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.

func (*OpsMetadataKeyLimitExceededException) Error added in v0.31.0 

func (e *OpsMetadataKeyLimitExceededException) Error() string

func (*OpsMetadataKeyLimitExceededException) ErrorCode added in v0.31.0 

func (e *OpsMetadataKeyLimitExceededException) ErrorCode() string

func (*OpsMetadataKeyLimitExceededException) ErrorFault added in v0.31.0 

func (e *OpsMetadataKeyLimitExceededException) ErrorFault() smithy.ErrorFault

func (*OpsMetadataKeyLimitExceededException) ErrorMessage added in v0.31.0 

func (e *OpsMetadataKeyLimitExceededException) ErrorMessage() string

type OpsMetadataLimitExceededException added in v0.31.0 

type OpsMetadataLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.

func (*OpsMetadataLimitExceededException) Error added in v0.31.0 

func (e *OpsMetadataLimitExceededException) Error() string

func (*OpsMetadataLimitExceededException) ErrorCode added in v0.31.0 

func (e *OpsMetadataLimitExceededException) ErrorCode() string

func (*OpsMetadataLimitExceededException) ErrorFault added in v0.31.0 

func (e *OpsMetadataLimitExceededException) ErrorFault() smithy.ErrorFault

func (*OpsMetadataLimitExceededException) ErrorMessage added in v0.31.0 

func (e *OpsMetadataLimitExceededException) ErrorMessage() string

type OpsMetadataNotFoundException added in v0.31.0 

type OpsMetadataNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The OpsMetadata object doesn't exist.

func (*OpsMetadataNotFoundException) Error added in v0.31.0 

func (e *OpsMetadataNotFoundException) Error() string

func (*OpsMetadataNotFoundException) ErrorCode added in v0.31.0 

func (e *OpsMetadataNotFoundException) ErrorCode() string

func (*OpsMetadataNotFoundException) ErrorFault added in v0.31.0 

func (e *OpsMetadataNotFoundException) ErrorFault() smithy.ErrorFault

func (*OpsMetadataNotFoundException) ErrorMessage added in v0.31.0 

func (e *OpsMetadataNotFoundException) ErrorMessage() string

type OpsMetadataTooManyUpdatesException added in v0.31.0 

type OpsMetadataTooManyUpdatesException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The system is processing too many concurrent updates. Wait a few moments and try again.

func (*OpsMetadataTooManyUpdatesException) Error added in v0.31.0 

func (e *OpsMetadataTooManyUpdatesException) Error() string

func (*OpsMetadataTooManyUpdatesException) ErrorCode added in v0.31.0 

func (e *OpsMetadataTooManyUpdatesException) ErrorCode() string

func (*OpsMetadataTooManyUpdatesException) ErrorFault added in v0.31.0 

func (e *OpsMetadataTooManyUpdatesException) ErrorFault() smithy.ErrorFault

func (*OpsMetadataTooManyUpdatesException) ErrorMessage added in v0.31.0 

func (e *OpsMetadataTooManyUpdatesException) ErrorMessage() string

type OpsResultAttribute 

type OpsResultAttribute struct {

	// Name of the data type. Valid value: AWS:OpsItem , AWS:EC2InstanceInformation ,
	// AWS:OpsItemTrendline , or AWS:ComplianceSummary .
	//
	// This member is required.
	TypeName *string
	// contains filtered or unexported fields
}

The OpsItem data type to return.

type OutputSource 

type OutputSource struct {

	// The ID of the output source, for example the URL of an S3 bucket.
	OutputSourceId *string

	// The type of source where the association execution details are stored, for
	// example, Amazon S3.
	OutputSourceType *string
	// contains filtered or unexported fields
}

Information about the source where the association execution details are stored.

type Parameter 

type Parameter struct {

	// The Amazon Resource Name (ARN) of the parameter.
	ARN *string

	// The data type of the parameter, such as text or aws:ec2:image . The default is
	// text .
	DataType *string

	// Date the parameter was last changed or updated and the parameter version was
	// created.
	LastModifiedDate *time.Time

	// The name of the parameter.
	Name *string

	// Either the version number or the label used to retrieve the parameter value.
	// Specify selectors by using one of the following formats:
	//
	// parameter_name:version
	//
	// parameter_name:label
	Selector *string

	// Applies to parameters that reference information in other Amazon Web Services
	// services. SourceResult is the raw result or response from the source.
	SourceResult *string

	// The type of parameter. Valid values include the following: String , StringList ,
	// and SecureString .
	//
	// If type is StringList , the system returns a comma-separated string with no
	// spaces between commas in the Value field.
	Type ParameterType

	// The parameter value.
	//
	// If type is StringList , the system returns a comma-separated string with no
	// spaces between commas in the Value field.
	Value *string

	// The parameter version.
	Version int64
	// contains filtered or unexported fields
}

An Amazon Web Services Systems Manager parameter in Parameter Store.

type ParameterAlreadyExists 

type ParameterAlreadyExists struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The parameter already exists. You can't create duplicate parameters.

func (*ParameterAlreadyExists) Error 

func (e *ParameterAlreadyExists) Error() string

func (*ParameterAlreadyExists) ErrorCode 

func (e *ParameterAlreadyExists) ErrorCode() string

func (*ParameterAlreadyExists) ErrorFault 

func (e *ParameterAlreadyExists) ErrorFault() smithy.ErrorFault

func (*ParameterAlreadyExists) ErrorMessage 

func (e *ParameterAlreadyExists) ErrorMessage() string

type ParameterHistory 

type ParameterHistory struct {

	// Parameter names can include the following letters and symbols.
	//
	// a-zA-Z0-9_.-
	AllowedPattern *string

	// The data type of the parameter, such as text or aws:ec2:image . The default is
	// text .
	DataType *string

	// Information about the parameter.
	Description *string

	// The alias of the Key Management Service (KMS) key used to encrypt the
	// parameter. Applies to SecureString parameters only
	KeyId *string

	// Labels assigned to the parameter version.
	Labels []string

	// Date the parameter was last changed or updated.
	LastModifiedDate *time.Time

	// Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the
	// parameter.
	LastModifiedUser *string

	// The name of the parameter.
	Name *string

	// Information about the policies assigned to a parameter.
	//
	// [Assigning parameter policies]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Assigning parameter policies]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html
	Policies []ParameterInlinePolicy

	// The parameter tier.
	Tier ParameterTier

	// The type of parameter used.
	Type ParameterType

	// The parameter value.
	Value *string

	// The parameter version.
	Version int64
	// contains filtered or unexported fields
}

Information about parameter usage.

type ParameterInlinePolicy 

type ParameterInlinePolicy struct {

	// The status of the policy. Policies report the following statuses: Pending (the
	// policy hasn't been enforced or applied yet), Finished (the policy was applied),
	// Failed (the policy wasn't applied), or InProgress (the policy is being applied
	// now).
	PolicyStatus *string

	// The JSON text of the policy.
	PolicyText *string

	// The type of policy. Parameter Store, a capability of Amazon Web Services
	// Systems Manager, supports the following policy types: Expiration,
	// ExpirationNotification, and NoChangeNotification.
	PolicyType *string
	// contains filtered or unexported fields
}

One or more policies assigned to a parameter.

type ParameterLimitExceeded 

type ParameterLimitExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more parameters and try again.

func (*ParameterLimitExceeded) Error 

func (e *ParameterLimitExceeded) Error() string

func (*ParameterLimitExceeded) ErrorCode 

func (e *ParameterLimitExceeded) ErrorCode() string

func (*ParameterLimitExceeded) ErrorFault 

func (e *ParameterLimitExceeded) ErrorFault() smithy.ErrorFault

func (*ParameterLimitExceeded) ErrorMessage 

func (e *ParameterLimitExceeded) ErrorMessage() string

type ParameterMaxVersionLimitExceeded 

type ParameterMaxVersionLimitExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store won't delete the version and instead presents this error message: 

An error occurred (ParameterMaxVersionLimitExceeded) when calling the
PutParameter operation: You attempted to create a new version of parameter-name
by calling the PutParameter API with the overwrite flag. Version version-number,
the oldest version, can't be deleted because it has a label associated with it.
Move the label to another version of the parameter, and try again.

This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console)or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.

func (*ParameterMaxVersionLimitExceeded) Error 

func (e *ParameterMaxVersionLimitExceeded) Error() string

func (*ParameterMaxVersionLimitExceeded) ErrorCode 

func (e *ParameterMaxVersionLimitExceeded) ErrorCode() string

func (*ParameterMaxVersionLimitExceeded) ErrorFault 

func (e *ParameterMaxVersionLimitExceeded) ErrorFault() smithy.ErrorFault

func (*ParameterMaxVersionLimitExceeded) ErrorMessage 

func (e *ParameterMaxVersionLimitExceeded) ErrorMessage() string

type ParameterMetadata 

type ParameterMetadata struct {

	// The (ARN) of the last user to update the parameter.
	ARN *string

	// A parameter name can include only the following letters and symbols.
	//
	// a-zA-Z0-9_.-
	AllowedPattern *string

	// The data type of the parameter, such as text or aws:ec2:image . The default is
	// text .
	DataType *string

	// Description of the parameter actions.
	Description *string

	// The alias of the Key Management Service (KMS) key used to encrypt the
	// parameter. Applies to SecureString parameters only.
	KeyId *string

	// Date the parameter was last changed or updated.
	LastModifiedDate *time.Time

	// Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the
	// parameter.
	LastModifiedUser *string

	// The parameter name.
	Name *string

	// A list of policies associated with a parameter.
	Policies []ParameterInlinePolicy

	// The parameter tier.
	Tier ParameterTier

	// The type of parameter. Valid parameter types include the following: String ,
	// StringList , and SecureString .
	Type ParameterType

	// The parameter version.
	Version int64
	// contains filtered or unexported fields
}

Metadata includes information like the Amazon Resource Name (ARN) of the last user to update the parameter and the date and time the parameter was last used.

type ParameterNotFound 

type ParameterNotFound struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The parameter couldn't be found. Verify the name and try again.

func (*ParameterNotFound) Error 

func (e *ParameterNotFound) Error() string

func (*ParameterNotFound) ErrorCode 

func (e *ParameterNotFound) ErrorCode() string

func (*ParameterNotFound) ErrorFault 

func (e *ParameterNotFound) ErrorFault() smithy.ErrorFault

func (*ParameterNotFound) ErrorMessage 

func (e *ParameterNotFound) ErrorMessage() string

type ParameterPatternMismatchException 

type ParameterPatternMismatchException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The parameter name isn't valid.

func (*ParameterPatternMismatchException) Error 

func (e *ParameterPatternMismatchException) Error() string

func (*ParameterPatternMismatchException) ErrorCode 

func (e *ParameterPatternMismatchException) ErrorCode() string

func (*ParameterPatternMismatchException) ErrorFault 

func (e *ParameterPatternMismatchException) ErrorFault() smithy.ErrorFault

func (*ParameterPatternMismatchException) ErrorMessage 

func (e *ParameterPatternMismatchException) ErrorMessage() string

type ParameterStringFilter 

type ParameterStringFilter struct {

	// The name of the filter.
	//
	// The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However,
	// not all of the pattern values listed for Key can be used with both operations.
	//
	// For DescribeParameters , all of the listed patterns are valid except Label .
	//
	// For GetParametersByPath , the following patterns listed for Key aren't valid:
	// tag , DataType , Name , Path , and Tier .
	//
	// For examples of Amazon Web Services CLI commands demonstrating valid parameter
	// filter constructions, see [Searching for Systems Manager parameters]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Searching for Systems Manager parameters]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html
	//
	// This member is required.
	Key *string

	// For all filters used with DescribeParameters, valid options include Equals and BeginsWith . The
	// Name filter additionally supports the Contains option. (Exception: For filters
	// using the key Path , valid options include Recursive and OneLevel .)
	//
	// For filters used with GetParametersByPath, valid options include Equals and BeginsWith .
	// (Exception: For filters using Label as the Key name, the only valid option is
	// Equals .)
	Option *string

	// The value you want to search for.
	Values []string
	// contains filtered or unexported fields
}

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

type ParameterTier 

type ParameterTier string
const (
	ParameterTierStandard           ParameterTier = "Standard"
	ParameterTierAdvanced           ParameterTier = "Advanced"
	ParameterTierIntelligentTiering ParameterTier = "Intelligent-Tiering"
)

Enum values for ParameterTier

func (ParameterTier) Values added in v0.29.0 

func (ParameterTier) Values() []ParameterTier

Values returns all known values for ParameterTier. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ParameterType 

type ParameterType string
const (
	ParameterTypeString       ParameterType = "String"
	ParameterTypeStringList   ParameterType = "StringList"
	ParameterTypeSecureString ParameterType = "SecureString"
)

Enum values for ParameterType

func (ParameterType) Values added in v0.29.0 

func (ParameterType) Values() []ParameterType

Values returns all known values for ParameterType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ParameterVersionLabelLimitExceeded 

type ParameterVersionLabelLimitExceeded struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A parameter version can have a maximum of ten labels.

func (*ParameterVersionLabelLimitExceeded) Error 

func (e *ParameterVersionLabelLimitExceeded) Error() string

func (*ParameterVersionLabelLimitExceeded) ErrorCode 

func (e *ParameterVersionLabelLimitExceeded) ErrorCode() string

func (*ParameterVersionLabelLimitExceeded) ErrorFault 

func (e *ParameterVersionLabelLimitExceeded) ErrorFault() smithy.ErrorFault

func (*ParameterVersionLabelLimitExceeded) ErrorMessage 

func (e *ParameterVersionLabelLimitExceeded) ErrorMessage() string

type ParameterVersionNotFound 

type ParameterVersionNotFound struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified parameter version wasn't found. Verify the parameter name and version, and try again.

func (*ParameterVersionNotFound) Error 

func (e *ParameterVersionNotFound) Error() string

func (*ParameterVersionNotFound) ErrorCode 

func (e *ParameterVersionNotFound) ErrorCode() string

func (*ParameterVersionNotFound) ErrorFault 

func (e *ParameterVersionNotFound) ErrorFault() smithy.ErrorFault

func (*ParameterVersionNotFound) ErrorMessage 

func (e *ParameterVersionNotFound) ErrorMessage() string

type ParametersFilter 

type ParametersFilter struct {

	// The name of the filter.
	//
	// This member is required.
	Key ParametersFilterKey

	// The filter values.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

This data type is deprecated. Instead, use ParameterStringFilter.

type ParametersFilterKey 

type ParametersFilterKey string
const (
	ParametersFilterKeyName  ParametersFilterKey = "Name"
	ParametersFilterKeyType  ParametersFilterKey = "Type"
	ParametersFilterKeyKeyId ParametersFilterKey = "KeyId"
)

Enum values for ParametersFilterKey

func (ParametersFilterKey) Values added in v0.29.0 

func (ParametersFilterKey) Values() []ParametersFilterKey

Values returns all known values for ParametersFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ParentStepDetails added in v1.43.0 

type ParentStepDetails struct {

	// The name of the automation action.
	Action *string

	// The current repetition of the loop represented by an integer.
	Iteration *int32

	// The current value of the specified iterator in the loop.
	IteratorValue *string

	// The unique ID of a step execution.
	StepExecutionId *string

	// The name of the step.
	StepName *string
	// contains filtered or unexported fields
}

A detailed status of the parent step.

type Patch 

type Patch struct {

	// The Advisory ID of the patch. For example, RHSA-2020:3779 . Applies to
	// Linux-based managed nodes only.
	AdvisoryIds []string

	// The architecture of the patch. For example, in
	// example-pkg-0.710.10-2.7.abcd.x86_64 , the architecture is indicated by x86_64 .
	// Applies to Linux-based managed nodes only.
	Arch *string

	// The Bugzilla ID of the patch. For example, 1600646 . Applies to Linux-based
	// managed nodes only.
	BugzillaIds []string

	// The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example,
	// CVE-2011-3192 . Applies to Linux-based managed nodes only.
	CVEIds []string

	// The classification of the patch. For example, SecurityUpdates , Updates , or
	// CriticalUpdates .
	Classification *string

	// The URL where more information can be obtained about the patch.
	ContentUrl *string

	// The description of the patch.
	Description *string

	// The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch
	// , the epoch value is 20180914-2 . Applies to Linux-based managed nodes only.
	Epoch int32

	// The ID of the patch. Applies to Windows patches only.
	//
	// This ID isn't the same as the Microsoft Knowledge Base ID.
	Id *string

	// The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.
	KbNumber *string

	// The language of the patch if it's language-specific.
	Language *string

	// The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is
	// related to. For example, MS14-045 . Applies to Windows patches only.
	MsrcNumber *string

	// The severity of the patch, such as Critical , Important , or Moderate . Applies
	// to Windows patches only.
	MsrcSeverity *string

	// The name of the patch. Applies to Linux-based managed nodes only.
	Name *string

	// The specific product the patch is applicable for. For example, WindowsServer2016
	// or AmazonLinux2018.03 .
	Product *string

	// The product family the patch is applicable for. For example, Windows or Amazon
	// Linux 2 .
	ProductFamily *string

	// The particular release of a patch. For example, in
	// pkg-example-EE-20180914-2.2.amzn1.noarch , the release is 2.amaz1 . Applies to
	// Linux-based managed nodes only.
	Release *string

	// The date the patch was released.
	ReleaseDate *time.Time

	// The source patch repository for the operating system and version, such as
	// trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu
	// Server 20.04 LTE. Applies to Linux-based managed nodes only.
	Repository *string

	// The severity level of the patch. For example, CRITICAL or MODERATE .
	Severity *string

	// The title of the patch.
	Title *string

	// The name of the vendor providing the patch.
	Vendor *string

	// The version number of the patch. For example, in
	// example-pkg-1.710.10-2.7.abcd.x86_64 , the version number is indicated by -1 .
	// Applies to Linux-based managed nodes only.
	Version *string
	// contains filtered or unexported fields
}

Represents metadata about a patch.

type PatchAction 

type PatchAction string
const (
	PatchActionAllowAsDependency PatchAction = "ALLOW_AS_DEPENDENCY"
	PatchActionBlock             PatchAction = "BLOCK"
)

Enum values for PatchAction

func (PatchAction) Values added in v0.29.0 

func (PatchAction) Values() []PatchAction

Values returns all known values for PatchAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchBaselineIdentity 

type PatchBaselineIdentity struct {

	// The description of the patch baseline.
	BaselineDescription *string

	// The ID of the patch baseline.
	BaselineId *string

	// The name of the patch baseline.
	BaselineName *string

	// Indicates whether this is the default baseline. Amazon Web Services Systems
	// Manager supports creating multiple default patch baselines. For example, you can
	// create a default patch baseline for each operating system.
	DefaultBaseline bool

	// Defines the operating system the patch baseline applies to. The default value
	// is WINDOWS .
	OperatingSystem OperatingSystem
	// contains filtered or unexported fields
}

Defines the basic information about a patch baseline.

type PatchComplianceData 

type PatchComplianceData struct {

	// The classification of the patch, such as SecurityUpdates , Updates , and
	// CriticalUpdates .
	//
	// This member is required.
	Classification *string

	// The date/time the patch was installed on the managed node. Not all operating
	// systems provide this level of information.
	//
	// This member is required.
	InstalledTime *time.Time

	// The operating system-specific ID of the patch.
	//
	// This member is required.
	KBId *string

	// The severity of the patch such as Critical , Important , and Moderate .
	//
	// This member is required.
	Severity *string

	// The state of the patch on the managed node, such as INSTALLED or FAILED.
	//
	// For descriptions of each patch state, see [About patch compliance] in the Amazon Web Services Systems
	// Manager User Guide.
	//
	// [About patch compliance]: https://docs.aws.amazon.com/systems-manager/latest/userguide/compliance-about.html#compliance-monitor-patch
	//
	// This member is required.
	State PatchComplianceDataState

	// The title of the patch.
	//
	// This member is required.
	Title *string

	// The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that
	// are resolved by the patch.
	//
	// Currently, CVE ID values are reported only for patches with a status of Missing
	// or Failed .
	CVEIds *string
	// contains filtered or unexported fields
}

Information about the state of a patch on a particular managed node as it relates to the patch baseline used to patch the node.

type PatchComplianceDataState 

type PatchComplianceDataState string
const (
	PatchComplianceDataStateInstalled              PatchComplianceDataState = "INSTALLED"
	PatchComplianceDataStateInstalledOther         PatchComplianceDataState = "INSTALLED_OTHER"
	PatchComplianceDataStateInstalledPendingReboot PatchComplianceDataState = "INSTALLED_PENDING_REBOOT"
	PatchComplianceDataStateInstalledRejected      PatchComplianceDataState = "INSTALLED_REJECTED"
	PatchComplianceDataStateMissing                PatchComplianceDataState = "MISSING"
	PatchComplianceDataStateNotApplicable          PatchComplianceDataState = "NOT_APPLICABLE"
	PatchComplianceDataStateFailed                 PatchComplianceDataState = "FAILED"
)

Enum values for PatchComplianceDataState

func (PatchComplianceDataState) Values added in v0.29.0 

func (PatchComplianceDataState) Values() []PatchComplianceDataState

Values returns all known values for PatchComplianceDataState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchComplianceLevel 

type PatchComplianceLevel string
const (
	PatchComplianceLevelCritical      PatchComplianceLevel = "CRITICAL"
	PatchComplianceLevelHigh          PatchComplianceLevel = "HIGH"
	PatchComplianceLevelMedium        PatchComplianceLevel = "MEDIUM"
	PatchComplianceLevelLow           PatchComplianceLevel = "LOW"
	PatchComplianceLevelInformational PatchComplianceLevel = "INFORMATIONAL"
	PatchComplianceLevelUnspecified   PatchComplianceLevel = "UNSPECIFIED"
)

Enum values for PatchComplianceLevel

func (PatchComplianceLevel) Values added in v0.29.0 

func (PatchComplianceLevel) Values() []PatchComplianceLevel

Values returns all known values for PatchComplianceLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchDeploymentStatus 

type PatchDeploymentStatus string
const (
	PatchDeploymentStatusApproved         PatchDeploymentStatus = "APPROVED"
	PatchDeploymentStatusPendingApproval  PatchDeploymentStatus = "PENDING_APPROVAL"
	PatchDeploymentStatusExplicitApproved PatchDeploymentStatus = "EXPLICIT_APPROVED"
	PatchDeploymentStatusExplicitRejected PatchDeploymentStatus = "EXPLICIT_REJECTED"
)

Enum values for PatchDeploymentStatus

func (PatchDeploymentStatus) Values added in v0.29.0 

func (PatchDeploymentStatus) Values() []PatchDeploymentStatus

Values returns all known values for PatchDeploymentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchFilter 

type PatchFilter struct {

	// The key for the filter.
	//
	// Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
	//
	// This member is required.
	Key PatchFilterKey

	// The value for the filter key.
	//
	// Run the DescribePatchProperties command to view lists of valid values for each key based on operating
	// system type.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}
Defines which patches should be included in a patch baseline.

A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET , PRODUCT , PRODUCT_FAMILY , CLASSIFICATION , and MSRC_SEVERITY .

The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are ["Office 2013", "Office 2016"] , then the filter accepts all patches where product name is either "Office 2013" or "Office 2016". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.

You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.

type PatchFilterGroup 

type PatchFilterGroup struct {

	// The set of patch filters that make up the group.
	//
	// This member is required.
	PatchFilters []PatchFilter
	// contains filtered or unexported fields
}

A set of patch filters, typically used for approval rules.

type PatchFilterKey 

type PatchFilterKey string
const (
	PatchFilterKeyArch           PatchFilterKey = "ARCH"
	PatchFilterKeyAdvisoryId     PatchFilterKey = "ADVISORY_ID"
	PatchFilterKeyBugzillaId     PatchFilterKey = "BUGZILLA_ID"
	PatchFilterKeyPatchSet       PatchFilterKey = "PATCH_SET"
	PatchFilterKeyProduct        PatchFilterKey = "PRODUCT"
	PatchFilterKeyProductFamily  PatchFilterKey = "PRODUCT_FAMILY"
	PatchFilterKeyClassification PatchFilterKey = "CLASSIFICATION"
	PatchFilterKeyCVEId          PatchFilterKey = "CVE_ID"
	PatchFilterKeyEpoch          PatchFilterKey = "EPOCH"
	PatchFilterKeyMsrcSeverity   PatchFilterKey = "MSRC_SEVERITY"
	PatchFilterKeyName           PatchFilterKey = "NAME"
	PatchFilterKeyPatchId        PatchFilterKey = "PATCH_ID"
	PatchFilterKeySection        PatchFilterKey = "SECTION"
	PatchFilterKeyPriority       PatchFilterKey = "PRIORITY"
	PatchFilterKeyRepository     PatchFilterKey = "REPOSITORY"
	PatchFilterKeyRelease        PatchFilterKey = "RELEASE"
	PatchFilterKeySeverity       PatchFilterKey = "SEVERITY"
	PatchFilterKeySecurity       PatchFilterKey = "SECURITY"
	PatchFilterKeyVersion        PatchFilterKey = "VERSION"
)

Enum values for PatchFilterKey

func (PatchFilterKey) Values added in v0.29.0 

func (PatchFilterKey) Values() []PatchFilterKey

Values returns all known values for PatchFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchGroupPatchBaselineMapping 

type PatchGroupPatchBaselineMapping struct {

	// The patch baseline the patch group is registered with.
	BaselineIdentity *PatchBaselineIdentity

	// The name of the patch group registered with the patch baseline.
	PatchGroup *string
	// contains filtered or unexported fields
}

The mapping between a patch group and the patch baseline the patch group is registered with.

type PatchOperationType 

type PatchOperationType string
const (
	PatchOperationTypeScan    PatchOperationType = "Scan"
	PatchOperationTypeInstall PatchOperationType = "Install"
)

Enum values for PatchOperationType

func (PatchOperationType) Values added in v0.29.0 

func (PatchOperationType) Values() []PatchOperationType

Values returns all known values for PatchOperationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchOrchestratorFilter 

type PatchOrchestratorFilter struct {

	// The key for the filter.
	Key *string

	// The value for the filter.
	Values []string
	// contains filtered or unexported fields
}

Defines a filter used in Patch Manager APIs. Supported filter keys depend on the API operation that includes the filter. Patch Manager API operations that use PatchOrchestratorFilter include the following:

DescribeAvailablePatches

DescribeInstancePatches

DescribePatchBaselines

DescribePatchGroups

type PatchProperty 

type PatchProperty string
const (
	PatchPropertyProduct             PatchProperty = "PRODUCT"
	PatchPropertyPatchProductFamily  PatchProperty = "PRODUCT_FAMILY"
	PatchPropertyPatchClassification PatchProperty = "CLASSIFICATION"
	PatchPropertyPatchMsrcSeverity   PatchProperty = "MSRC_SEVERITY"
	PatchPropertyPatchPriority       PatchProperty = "PRIORITY"
	PatchPropertyPatchSeverity       PatchProperty = "SEVERITY"
)

Enum values for PatchProperty

func (PatchProperty) Values added in v0.29.0 

func (PatchProperty) Values() []PatchProperty

Values returns all known values for PatchProperty. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchRule 

type PatchRule struct {

	// The patch filter group that defines the criteria for the rule.
	//
	// This member is required.
	PatchFilterGroup *PatchFilterGroup

	// The number of days after the release date of each patch matched by the rule
	// that the patch is marked as approved in the patch baseline. For example, a value
	// of 7 means that patches are approved seven days after they are released.
	//
	// This parameter is marked as Required: No , but your request must include a value
	// for either ApproveAfterDays or ApproveUntilDate .
	//
	// Not supported for Debian Server or Ubuntu Server.
	//
	// Use caution when setting this value for Windows Server patch baselines. Because
	// patch updates that are replaced by later updates are removed, setting too broad
	// a value for this parameter can result in crucial patches not being installed.
	// For more information, see the Windows Server tab in the topic [How security patches are selected]in the Amazon Web
	// Services Systems Manager User Guide.
	//
	// [How security patches are selected]: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-selecting-patches.html
	ApproveAfterDays *int32

	// The cutoff date for auto approval of released patches. Any patches released on
	// or before this date are installed automatically.
	//
	// Enter dates in the format YYYY-MM-DD . For example, 2024-12-31 .
	//
	// This parameter is marked as Required: No , but your request must include a value
	// for either ApproveUntilDate or ApproveAfterDays .
	//
	// Not supported for Debian Server or Ubuntu Server.
	//
	// Use caution when setting this value for Windows Server patch baselines. Because
	// patch updates that are replaced by later updates are removed, setting too broad
	// a value for this parameter can result in crucial patches not being installed.
	// For more information, see the Windows Server tab in the topic [How security patches are selected]in the Amazon Web
	// Services Systems Manager User Guide.
	//
	// [How security patches are selected]: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-selecting-patches.html
	ApproveUntilDate *string

	// A compliance severity level for all approved patches in a patch baseline.
	ComplianceLevel PatchComplianceLevel

	// For managed nodes identified by the approval rule filters, enables a patch
	// baseline to apply non-security updates available in the specified repository.
	// The default value is false . Applies to Linux managed nodes only.
	EnableNonSecurity *bool
	// contains filtered or unexported fields
}

Defines an approval rule for a patch baseline.

type PatchRuleGroup 

type PatchRuleGroup struct {

	// The rules that make up the rule group.
	//
	// This member is required.
	PatchRules []PatchRule
	// contains filtered or unexported fields
}

A set of rules defining the approval rules for a patch baseline.

type PatchSet 

type PatchSet string
const (
	PatchSetOs          PatchSet = "OS"
	PatchSetApplication PatchSet = "APPLICATION"
)

Enum values for PatchSet

func (PatchSet) Values added in v0.29.0 

func (PatchSet) Values() []PatchSet

Values returns all known values for PatchSet. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PatchSource 

type PatchSource struct {

	// The value of the yum repo configuration. For example:
	//
	//     [main]
	//
	//     name=MyCustomRepository
	//
	//     baseurl=https://my-custom-repository
	//
	//     enabled=1
	//
	// For information about other options available for your yum repository
	// configuration, see [dnf.conf(5)].
	//
	// [dnf.conf(5)]: https://man7.org/linux/man-pages/man5/dnf.conf.5.html
	//
	// This member is required.
	Configuration *string

	// The name specified to identify the patch source.
	//
	// This member is required.
	Name *string

	// The specific operating system versions a patch repository applies to, such as
	// "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7".
	// For lists of supported product values, see PatchFilter.
	//
	// This member is required.
	Products []string
	// contains filtered or unexported fields
}

Information about the patches to use to update the managed nodes, including target operating systems and source repository. Applies to Linux managed nodes only.

type PatchStatus 

type PatchStatus struct {

	// The date the patch was approved (or will be approved if the status is
	// PENDING_APPROVAL ).
	ApprovalDate *time.Time

	// The compliance severity level for a patch.
	ComplianceLevel PatchComplianceLevel

	// The approval status of a patch.
	DeploymentStatus PatchDeploymentStatus
	// contains filtered or unexported fields
}

Information about the approval status of a patch.

type PingStatus 

type PingStatus string
const (
	PingStatusOnline         PingStatus = "Online"
	PingStatusConnectionLost PingStatus = "ConnectionLost"
	PingStatusInactive       PingStatus = "Inactive"
)

Enum values for PingStatus

func (PingStatus) Values added in v0.29.0 

func (PingStatus) Values() []PingStatus

Values returns all known values for PingStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PlatformType 

type PlatformType string
const (
	PlatformTypeWindows PlatformType = "Windows"
	PlatformTypeLinux   PlatformType = "Linux"
	PlatformTypeMacos   PlatformType = "MacOS"
)

Enum values for PlatformType

func (PlatformType) Values added in v0.29.0 

func (PlatformType) Values() []PlatformType

Values returns all known values for PlatformType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PoliciesLimitExceededException 

type PoliciesLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.

func (*PoliciesLimitExceededException) Error 

func (e *PoliciesLimitExceededException) Error() string

func (*PoliciesLimitExceededException) ErrorCode 

func (e *PoliciesLimitExceededException) ErrorCode() string

func (*PoliciesLimitExceededException) ErrorFault 

func (e *PoliciesLimitExceededException) ErrorFault() smithy.ErrorFault

func (*PoliciesLimitExceededException) ErrorMessage 

func (e *PoliciesLimitExceededException) ErrorMessage() string

type ProgressCounters 

type ProgressCounters struct {

	// The total number of steps that the system cancelled in all specified Amazon Web
	// Services Regions and Amazon Web Services accounts for the current Automation
	// execution.
	CancelledSteps int32

	// The total number of steps that failed to run in all specified Amazon Web
	// Services Regions and Amazon Web Services accounts for the current Automation
	// execution.
	FailedSteps int32

	// The total number of steps that successfully completed in all specified Amazon
	// Web Services Regions and Amazon Web Services accounts for the current Automation
	// execution.
	SuccessSteps int32

	// The total number of steps that timed out in all specified Amazon Web Services
	// Regions and Amazon Web Services accounts for the current Automation execution.
	TimedOutSteps int32

	// The total number of steps run in all specified Amazon Web Services Regions and
	// Amazon Web Services accounts for the current Automation execution.
	TotalSteps int32
	// contains filtered or unexported fields
}

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

type RebootOption 

type RebootOption string
const (
	RebootOptionRebootIfNeeded RebootOption = "RebootIfNeeded"
	RebootOptionNoReboot       RebootOption = "NoReboot"
)

Enum values for RebootOption

func (RebootOption) Values added in v0.29.0 

func (RebootOption) Values() []RebootOption

Values returns all known values for RebootOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RegistrationMetadataItem added in v1.17.0 

type RegistrationMetadataItem struct {

	// Reserved for internal use.
	//
	// This member is required.
	Key *string

	// Reserved for internal use.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Reserved for internal use.

type RelatedOpsItem 

type RelatedOpsItem struct {

	// The ID of an OpsItem related to the current OpsItem.
	//
	// This member is required.
	OpsItemId *string
	// contains filtered or unexported fields
}

An OpsItems that shares something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

type ResolvedTargets 

type ResolvedTargets struct {

	// A list of parameter values sent to targets that resolved during the Automation
	// execution.
	ParameterValues []string

	// A boolean value indicating whether the resolved target list is truncated.
	Truncated bool
	// contains filtered or unexported fields
}

Information about targets that resolved during the Automation execution.

type ResourceComplianceSummaryItem 

type ResourceComplianceSummaryItem struct {

	// The compliance type.
	ComplianceType *string

	// A list of items that are compliant for the resource.
	CompliantSummary *CompliantSummary

	// Information about the execution.
	ExecutionSummary *ComplianceExecutionSummary

	// A list of items that aren't compliant for the resource.
	NonCompliantSummary *NonCompliantSummary

	// The highest severity item found for the resource. The resource is compliant for
	// this item.
	OverallSeverity ComplianceSeverity

	// The resource ID.
	ResourceId *string

	// The resource type.
	ResourceType *string

	// The compliance status for the resource.
	Status ComplianceStatus
	// contains filtered or unexported fields
}

Compliance summary information for a specific resource.

type ResourceDataSyncAlreadyExistsException 

type ResourceDataSyncAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	SyncName *string
	// contains filtered or unexported fields
}

A sync configuration with the same name already exists.

func (*ResourceDataSyncAlreadyExistsException) Error 

func (e *ResourceDataSyncAlreadyExistsException) Error() string

func (*ResourceDataSyncAlreadyExistsException) ErrorCode 

func (e *ResourceDataSyncAlreadyExistsException) ErrorCode() string

func (*ResourceDataSyncAlreadyExistsException) ErrorFault 

func (e *ResourceDataSyncAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceDataSyncAlreadyExistsException) ErrorMessage 

func (e *ResourceDataSyncAlreadyExistsException) ErrorMessage() string

type ResourceDataSyncAwsOrganizationsSource 

type ResourceDataSyncAwsOrganizationsSource struct {

	// If an Amazon Web Services organization is present, this is either
	// OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data
	// is aggregated from a set of organization units. For EntireOrganization , the
	// data is aggregated from the entire Amazon Web Services organization.
	//
	// This member is required.
	OrganizationSourceType *string

	// The Organizations organization units included in the sync.
	OrganizationalUnits []ResourceDataSyncOrganizationalUnit
	// contains filtered or unexported fields
}

Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations or, if an Amazon Web Services organization isn't present, from multiple Amazon Web Services Regions.

type ResourceDataSyncConflictException 

type ResourceDataSyncConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Another UpdateResourceDataSync request is being processed. Wait a few minutes and try again.

func (*ResourceDataSyncConflictException) Error 

func (e *ResourceDataSyncConflictException) Error() string

func (*ResourceDataSyncConflictException) ErrorCode 

func (e *ResourceDataSyncConflictException) ErrorCode() string

func (*ResourceDataSyncConflictException) ErrorFault 

func (e *ResourceDataSyncConflictException) ErrorFault() smithy.ErrorFault

func (*ResourceDataSyncConflictException) ErrorMessage 

func (e *ResourceDataSyncConflictException) ErrorMessage() string

type ResourceDataSyncCountExceededException 

type ResourceDataSyncCountExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You have exceeded the allowed maximum sync configurations.

func (*ResourceDataSyncCountExceededException) Error 

func (e *ResourceDataSyncCountExceededException) Error() string

func (*ResourceDataSyncCountExceededException) ErrorCode 

func (e *ResourceDataSyncCountExceededException) ErrorCode() string

func (*ResourceDataSyncCountExceededException) ErrorFault 

func (e *ResourceDataSyncCountExceededException) ErrorFault() smithy.ErrorFault

func (*ResourceDataSyncCountExceededException) ErrorMessage 

func (e *ResourceDataSyncCountExceededException) ErrorMessage() string

type ResourceDataSyncDestinationDataSharing 

type ResourceDataSyncDestinationDataSharing struct {

	// The sharing data type. Only Organization is supported.
	DestinationDataSharingType *string
	// contains filtered or unexported fields
}

Synchronize Amazon Web Services Systems Manager Inventory data from multiple Amazon Web Services accounts defined in Organizations to a centralized Amazon S3 bucket. Data is synchronized to individual key prefixes in the central bucket. Each key prefix represents a different Amazon Web Services account ID.

type ResourceDataSyncInvalidConfigurationException 

type ResourceDataSyncInvalidConfigurationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified sync configuration is invalid.

func (*ResourceDataSyncInvalidConfigurationException) Error 

func (e *ResourceDataSyncInvalidConfigurationException) Error() string

func (*ResourceDataSyncInvalidConfigurationException) ErrorCode 

func (e *ResourceDataSyncInvalidConfigurationException) ErrorCode() string

func (*ResourceDataSyncInvalidConfigurationException) ErrorFault 

func (e *ResourceDataSyncInvalidConfigurationException) ErrorFault() smithy.ErrorFault

func (*ResourceDataSyncInvalidConfigurationException) ErrorMessage 

func (e *ResourceDataSyncInvalidConfigurationException) ErrorMessage() string

type ResourceDataSyncItem 

type ResourceDataSyncItem struct {

	// The status reported by the last sync.
	LastStatus LastResourceDataSyncStatus

	// The last time the sync operations returned a status of SUCCESSFUL (UTC).
	LastSuccessfulSyncTime *time.Time

	// The status message details reported by the last sync.
	LastSyncStatusMessage *string

	// The last time the configuration attempted to sync (UTC).
	LastSyncTime *time.Time

	// Configuration information for the target S3 bucket.
	S3Destination *ResourceDataSyncS3Destination

	// The date and time the configuration was created (UTC).
	SyncCreatedTime *time.Time

	// The date and time the resource data sync was changed.
	SyncLastModifiedTime *time.Time

	// The name of the resource data sync.
	SyncName *string

	// Information about the source where the data was synchronized.
	SyncSource *ResourceDataSyncSourceWithState

	// The type of resource data sync. If SyncType is SyncToDestination , then the
	// resource data sync synchronizes data to an S3 bucket. If the SyncType is
	// SyncFromSource then the resource data sync synchronizes data from Organizations
	// or from multiple Amazon Web Services Regions.
	SyncType *string
	// contains filtered or unexported fields
}

Information about a resource data sync configuration, including its current status and last successful sync.

type ResourceDataSyncNotFoundException 

type ResourceDataSyncNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	SyncName *string
	SyncType *string
	// contains filtered or unexported fields
}

The specified sync name wasn't found.

func (*ResourceDataSyncNotFoundException) Error 

func (e *ResourceDataSyncNotFoundException) Error() string

func (*ResourceDataSyncNotFoundException) ErrorCode 

func (e *ResourceDataSyncNotFoundException) ErrorCode() string

func (*ResourceDataSyncNotFoundException) ErrorFault 

func (e *ResourceDataSyncNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceDataSyncNotFoundException) ErrorMessage 

func (e *ResourceDataSyncNotFoundException) ErrorMessage() string

type ResourceDataSyncOrganizationalUnit 

type ResourceDataSyncOrganizationalUnit struct {

	// The Organizations unit ID data source for the sync.
	OrganizationalUnitId *string
	// contains filtered or unexported fields
}

The Organizations organizational unit data source for the sync.

type ResourceDataSyncS3Destination 

type ResourceDataSyncS3Destination struct {

	// The name of the S3 bucket where the aggregated data is stored.
	//
	// This member is required.
	BucketName *string

	// The Amazon Web Services Region with the S3 bucket targeted by the resource data
	// sync.
	//
	// This member is required.
	Region *string

	// A supported sync format. The following format is currently supported: JsonSerDe
	//
	// This member is required.
	SyncFormat ResourceDataSyncS3Format

	// The ARN of an encryption key for a destination in Amazon S3. Must belong to the
	// same Region as the destination S3 bucket.
	AWSKMSKeyARN *string

	// Enables destination data sharing. By default, this field is null .
	DestinationDataSharing *ResourceDataSyncDestinationDataSharing

	// An Amazon S3 prefix for the bucket.
	Prefix *string
	// contains filtered or unexported fields
}

Information about the target S3 bucket for the resource data sync.

type ResourceDataSyncS3Format 

type ResourceDataSyncS3Format string
const (
	ResourceDataSyncS3FormatJsonSerde ResourceDataSyncS3Format = "JsonSerDe"
)

Enum values for ResourceDataSyncS3Format

func (ResourceDataSyncS3Format) Values added in v0.29.0 

func (ResourceDataSyncS3Format) Values() []ResourceDataSyncS3Format

Values returns all known values for ResourceDataSyncS3Format. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceDataSyncSource 

type ResourceDataSyncSource struct {

	// The SyncSource Amazon Web Services Regions included in the resource data sync.
	//
	// This member is required.
	SourceRegions []string

	// The type of data source for the resource data sync. SourceType is either
	// AwsOrganizations (if an organization is present in Organizations) or
	// SingleAccountMultiRegions .
	//
	// This member is required.
	SourceType *string

	// Information about the AwsOrganizationsSource resource data sync source. A sync
	// source of this type can synchronize data from Organizations.
	AwsOrganizationsSource *ResourceDataSyncAwsOrganizationsSource

	// When you create a resource data sync, if you choose one of the Organizations
	// options, then Systems Manager automatically enables all OpsData sources in the
	// selected Amazon Web Services Regions for all Amazon Web Services accounts in
	// your organization (or in the selected organization units). For more information,
	// see [Setting up Systems Manager Explorer to display data from multiple accounts and Regions]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Setting up Systems Manager Explorer to display data from multiple accounts and Regions]: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html
	EnableAllOpsDataSources bool

	// Whether to automatically synchronize and aggregate data from new Amazon Web
	// Services Regions when those Regions come online.
	IncludeFutureRegions bool
	// contains filtered or unexported fields
}

Information about the source of the data included in the resource data sync.

type ResourceDataSyncSourceWithState 

type ResourceDataSyncSourceWithState struct {

	// The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource
	// type.
	AwsOrganizationsSource *ResourceDataSyncAwsOrganizationsSource

	// When you create a resource data sync, if you choose one of the Organizations
	// options, then Systems Manager automatically enables all OpsData sources in the
	// selected Amazon Web Services Regions for all Amazon Web Services accounts in
	// your organization (or in the selected organization units). For more information,
	// see [Setting up Systems Manager Explorer to display data from multiple accounts and Regions]in the Amazon Web Services Systems Manager User Guide.
	//
	// [Setting up Systems Manager Explorer to display data from multiple accounts and Regions]: https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html
	EnableAllOpsDataSources bool

	// Whether to automatically synchronize and aggregate data from new Amazon Web
	// Services Regions when those Regions come online.
	IncludeFutureRegions bool

	// The SyncSource Amazon Web Services Regions included in the resource data sync.
	SourceRegions []string

	// The type of data source for the resource data sync. SourceType is either
	// AwsOrganizations (if an organization is present in Organizations) or
	// singleAccountMultiRegions .
	SourceType *string

	// The data type name for including resource data sync state. There are four sync
	// states:
	//
	// OrganizationNotExists : Your organization doesn't exist.
	//
	// NoPermissions : The system can't locate the service-linked role. This role is
	// automatically created when a user creates a resource data sync in Explorer.
	//
	// InvalidOrganizationalUnit : You specified or selected an invalid unit in the
	// resource data sync configuration.
	//
	// TrustedAccessDisabled : You disabled Systems Manager access in the organization
	// in Organizations.
	State *string
	// contains filtered or unexported fields
}

The data type name for including resource data sync state. There are four sync states:

OrganizationNotExists (Your organization doesn't exist)

NoPermissions (The system can't locate the service-linked role. This role is automatically created when a user creates a resource data sync in Amazon Web Services Systems Manager Explorer.)

InvalidOrganizationalUnit (You specified or selected an invalid unit in the resource data sync configuration.)

TrustedAccessDisabled (You disabled Systems Manager access in the organization in Organizations.)

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceLimitExceededException 

type ResourceLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

func (*ResourceLimitExceededException) Error 

func (e *ResourceLimitExceededException) Error() string

func (*ResourceLimitExceededException) ErrorCode 

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault 

func (e *ResourceLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ResourceLimitExceededException) ErrorMessage 

func (e *ResourceLimitExceededException) ErrorMessage() string

type ResourceNotFoundException added in v1.48.0 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified parameter to be shared could not be found.

func (*ResourceNotFoundException) Error added in v1.48.0 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode added in v1.48.0 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault added in v1.48.0 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage added in v1.48.0 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourcePolicyConflictException added in v1.33.0 

type ResourcePolicyConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.

func (*ResourcePolicyConflictException) Error added in v1.33.0 

func (e *ResourcePolicyConflictException) Error() string

func (*ResourcePolicyConflictException) ErrorCode added in v1.33.0 

func (e *ResourcePolicyConflictException) ErrorCode() string

func (*ResourcePolicyConflictException) ErrorFault added in v1.33.0 

func (e *ResourcePolicyConflictException) ErrorFault() smithy.ErrorFault

func (*ResourcePolicyConflictException) ErrorMessage added in v1.33.0 

func (e *ResourcePolicyConflictException) ErrorMessage() string

type ResourcePolicyInvalidParameterException added in v1.33.0 

type ResourcePolicyInvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string

	ParameterNames []string
	// contains filtered or unexported fields
}

One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.

func (*ResourcePolicyInvalidParameterException) Error added in v1.33.0 

func (e *ResourcePolicyInvalidParameterException) Error() string

func (*ResourcePolicyInvalidParameterException) ErrorCode added in v1.33.0 

func (e *ResourcePolicyInvalidParameterException) ErrorCode() string

func (*ResourcePolicyInvalidParameterException) ErrorFault added in v1.33.0 

func (e *ResourcePolicyInvalidParameterException) ErrorFault() smithy.ErrorFault

func (*ResourcePolicyInvalidParameterException) ErrorMessage added in v1.33.0 

func (e *ResourcePolicyInvalidParameterException) ErrorMessage() string

type ResourcePolicyLimitExceededException added in v1.33.0 

type ResourcePolicyLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Limit     int32
	LimitType *string
	// contains filtered or unexported fields
}

The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup . Verify these limits and try again.

func (*ResourcePolicyLimitExceededException) Error added in v1.33.0 

func (e *ResourcePolicyLimitExceededException) Error() string

func (*ResourcePolicyLimitExceededException) ErrorCode added in v1.33.0 

func (e *ResourcePolicyLimitExceededException) ErrorCode() string

func (*ResourcePolicyLimitExceededException) ErrorFault added in v1.33.0 

func (e *ResourcePolicyLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ResourcePolicyLimitExceededException) ErrorMessage added in v1.33.0 

func (e *ResourcePolicyLimitExceededException) ErrorMessage() string

type ResourcePolicyNotFoundException added in v1.48.0 

type ResourcePolicyNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

No policies with the specified policy ID and hash could be found.

func (*ResourcePolicyNotFoundException) Error added in v1.48.0 

func (e *ResourcePolicyNotFoundException) Error() string

func (*ResourcePolicyNotFoundException) ErrorCode added in v1.48.0 

func (e *ResourcePolicyNotFoundException) ErrorCode() string

func (*ResourcePolicyNotFoundException) ErrorFault added in v1.48.0 

func (e *ResourcePolicyNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourcePolicyNotFoundException) ErrorMessage added in v1.48.0 

func (e *ResourcePolicyNotFoundException) ErrorMessage() string

type ResourceType 

type ResourceType string
const (
	ResourceTypeManagedInstance ResourceType = "ManagedInstance"
	ResourceTypeEc2Instance     ResourceType = "EC2Instance"
)

Enum values for ResourceType

func (ResourceType) Values added in v0.29.0 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceTypeForTagging 

type ResourceTypeForTagging string
const (
	ResourceTypeForTaggingDocument          ResourceTypeForTagging = "Document"
	ResourceTypeForTaggingManagedInstance   ResourceTypeForTagging = "ManagedInstance"
	ResourceTypeForTaggingMaintenanceWindow ResourceTypeForTagging = "MaintenanceWindow"
	ResourceTypeForTaggingParameter         ResourceTypeForTagging = "Parameter"
	ResourceTypeForTaggingPatchBaseline     ResourceTypeForTagging = "PatchBaseline"
	ResourceTypeForTaggingOpsItem           ResourceTypeForTagging = "OpsItem"
	ResourceTypeForTaggingOpsmetadata       ResourceTypeForTagging = "OpsMetadata"
	ResourceTypeForTaggingAutomation        ResourceTypeForTagging = "Automation"
	ResourceTypeForTaggingAssociation       ResourceTypeForTagging = "Association"
)

Enum values for ResourceTypeForTagging

func (ResourceTypeForTagging) Values added in v0.29.0 

func (ResourceTypeForTagging) Values() []ResourceTypeForTagging

Values returns all known values for ResourceTypeForTagging. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResultAttribute 

type ResultAttribute struct {

	// Name of the inventory item type. Valid value: AWS:InstanceInformation . Default
	// Value: AWS:InstanceInformation .
	//
	// This member is required.
	TypeName *string
	// contains filtered or unexported fields
}

The inventory item result attribute.

type ReviewInformation added in v0.31.0 

type ReviewInformation struct {

	// The time that the reviewer took action on the document review request.
	ReviewedTime *time.Time

	// The reviewer assigned to take action on the document review request.
	Reviewer *string

	// The current status of the document review request.
	Status ReviewStatus
	// contains filtered or unexported fields
}

Information about the result of a document review request.

type ReviewStatus added in v0.31.0 

type ReviewStatus string
const (
	ReviewStatusApproved    ReviewStatus = "APPROVED"
	ReviewStatusNotReviewed ReviewStatus = "NOT_REVIEWED"
	ReviewStatusPending     ReviewStatus = "PENDING"
	ReviewStatusRejected    ReviewStatus = "REJECTED"
)

Enum values for ReviewStatus

func (ReviewStatus) Values added in v0.31.0 

func (ReviewStatus) Values() []ReviewStatus

Values returns all known values for ReviewStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Runbook added in v0.31.0 

type Runbook struct {

	// The name of the Automation runbook used in a runbook workflow.
	//
	// This member is required.
	DocumentName *string

	// The version of the Automation runbook used in a runbook workflow.
	DocumentVersion *string

	// The MaxConcurrency value specified by the user when the operation started,
	// indicating the maximum number of resources that the runbook operation can run on
	// at the same time.
	MaxConcurrency *string

	// The MaxErrors value specified by the user when the execution started,
	// indicating the maximum number of errors that can occur during the operation
	// before the updates are stopped or rolled back.
	MaxErrors *string

	// The key-value map of execution parameters, which were supplied when calling
	// StartChangeRequestExecution .
	Parameters map[string][]string

	// Information about the Amazon Web Services Regions and Amazon Web Services
	// accounts targeted by the current Runbook operation.
	TargetLocations []TargetLocation

	// A key-value mapping of runbook parameters to target resources. Both Targets and
	// TargetMaps can't be specified together.
	TargetMaps []map[string][]string

	// The name of the parameter used as the target resource for the rate-controlled
	// runbook workflow. Required if you specify Targets .
	TargetParameterName *string

	// A key-value mapping to target resources that the runbook operation performs
	// tasks on. Required if you specify TargetParameterName .
	Targets []Target
	// contains filtered or unexported fields
}

Information about an Automation runbook used in a runbook workflow in Change Manager.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

type S3OutputLocation 

type S3OutputLocation struct {

	// The name of the S3 bucket.
	OutputS3BucketName *string

	// The S3 bucket subfolder.
	OutputS3KeyPrefix *string

	// The Amazon Web Services Region of the S3 bucket.
	OutputS3Region *string
	// contains filtered or unexported fields
}

An S3 bucket where you want to store the results of this request.

type S3OutputUrl 

type S3OutputUrl struct {

	// A URL for an S3 bucket where you want to store the results of this request.
	OutputUrl *string
	// contains filtered or unexported fields
}

A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket where you want to store the results of this request.

type ScheduledWindowExecution 

type ScheduledWindowExecution struct {

	// The time, in ISO-8601 Extended format, that the maintenance window is scheduled
	// to be run.
	ExecutionTime *string

	// The name of the maintenance window to be run.
	Name *string

	// The ID of the maintenance window to be run.
	WindowId *string
	// contains filtered or unexported fields
}

Information about a scheduled execution for a maintenance window.

type ServiceSetting 

type ServiceSetting struct {

	// The ARN of the service setting.
	ARN *string

	// The last time the service setting was modified.
	LastModifiedDate *time.Time

	// The ARN of the last modified user. This field is populated only if the setting
	// value was overwritten.
	LastModifiedUser *string

	// The ID of the service setting.
	SettingId *string

	// The value of the service setting.
	SettingValue *string

	// The status of the service setting. The value can be Default, Customized or
	// PendingUpdate.
	//
	//   - Default: The current setting uses a default value provisioned by the Amazon
	//   Web Services service team.
	//
	//   - Customized: The current setting use a custom value specified by the
	//   customer.
	//
	//   - PendingUpdate: The current setting uses a default or custom value, but a
	//   setting change request is pending approval.
	Status *string
	// contains filtered or unexported fields
}

The service setting data structure.

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId . You can't create a new SettingId , but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or, use the ResetServiceSettingto change the value back to the original value defined by the Amazon Web Services service team.

type ServiceSettingNotFound 

type ServiceSettingNotFound struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.

func (*ServiceSettingNotFound) Error 

func (e *ServiceSettingNotFound) Error() string

func (*ServiceSettingNotFound) ErrorCode 

func (e *ServiceSettingNotFound) ErrorCode() string

func (*ServiceSettingNotFound) ErrorFault 

func (e *ServiceSettingNotFound) ErrorFault() smithy.ErrorFault

func (*ServiceSettingNotFound) ErrorMessage 

func (e *ServiceSettingNotFound) ErrorMessage() string

type Session 

type Session struct {

	// Reserved for future use.
	Details *string

	// The name of the Session Manager SSM document used to define the parameters and
	// plugin settings for the session. For example, SSM-SessionManagerRunShell .
	DocumentName *string

	// The date and time, in ISO-8601 Extended format, when the session was terminated.
	EndDate *time.Time

	// The maximum duration of a session before it terminates.
	MaxSessionDuration *string

	// Reserved for future use.
	OutputUrl *SessionManagerOutputUrl

	// The ID of the Amazon Web Services user that started the session.
	Owner *string

	// The reason for connecting to the instance.
	Reason *string

	// The ID of the session.
	SessionId *string

	// The date and time, in ISO-8601 Extended format, when the session began.
	StartDate *time.Time

	// The status of the session. For example, "Connected" or "Terminated".
	Status SessionStatus

	// The managed node that the Session Manager session connected to.
	Target *string
	// contains filtered or unexported fields
}

Information about a Session Manager connection to a managed node.

type SessionFilter 

type SessionFilter struct {

	// The name of the filter.
	//
	// This member is required.
	Key SessionFilterKey

	// The filter value. Valid values for each filter key are as follows:
	//
	//   - InvokedAfter: Specify a timestamp to limit your results. For example,
	//   specify 2024-08-29T00:00:00Z to see sessions that started August 29, 2024, and
	//   later.
	//
	//   - InvokedBefore: Specify a timestamp to limit your results. For example,
	//   specify 2024-08-29T00:00:00Z to see sessions that started before August 29,
	//   2024.
	//
	//   - Target: Specify a managed node to which session connections have been made.
	//
	//   - Owner: Specify an Amazon Web Services user to see a list of sessions
	//   started by that user.
	//
	//   - Status: Specify a valid session status to see a list of all sessions with
	//   that status. Status values you can specify include:
	//
	//   - Connected
	//
	//   - Connecting
	//
	//   - Disconnected
	//
	//   - Terminated
	//
	//   - Terminating
	//
	//   - Failed
	//
	//   - SessionId: Specify a session ID to return details about the session.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Describes a filter for Session Manager information.

type SessionFilterKey 

type SessionFilterKey string
const (
	SessionFilterKeyInvokedAfter  SessionFilterKey = "InvokedAfter"
	SessionFilterKeyInvokedBefore SessionFilterKey = "InvokedBefore"
	SessionFilterKeyTargetId      SessionFilterKey = "Target"
	SessionFilterKeyOwner         SessionFilterKey = "Owner"
	SessionFilterKeyStatus        SessionFilterKey = "Status"
	SessionFilterKeySessionId     SessionFilterKey = "SessionId"
)

Enum values for SessionFilterKey

func (SessionFilterKey) Values added in v0.29.0 

func (SessionFilterKey) Values() []SessionFilterKey

Values returns all known values for SessionFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionManagerOutputUrl 

type SessionManagerOutputUrl struct {

	// Reserved for future use.
	CloudWatchOutputUrl *string

	// Reserved for future use.
	S3OutputUrl *string
	// contains filtered or unexported fields
}

Reserved for future use.

type SessionState 

type SessionState string
const (
	SessionStateActive  SessionState = "Active"
	SessionStateHistory SessionState = "History"
)

Enum values for SessionState

func (SessionState) Values added in v0.29.0 

func (SessionState) Values() []SessionState

Values returns all known values for SessionState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SessionStatus 

type SessionStatus string
const (
	SessionStatusConnected    SessionStatus = "Connected"
	SessionStatusConnecting   SessionStatus = "Connecting"
	SessionStatusDisconnected SessionStatus = "Disconnected"
	SessionStatusTerminated   SessionStatus = "Terminated"
	SessionStatusTerminating  SessionStatus = "Terminating"
	SessionStatusFailed       SessionStatus = "Failed"
)

Enum values for SessionStatus

func (SessionStatus) Values added in v0.29.0 

func (SessionStatus) Values() []SessionStatus

Values returns all known values for SessionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SeveritySummary 

type SeveritySummary struct {

	// The total number of resources or compliance items that have a severity level of
	// Critical . Critical severity is determined by the organization that published
	// the compliance items.
	CriticalCount int32

	// The total number of resources or compliance items that have a severity level of
	// high. High severity is determined by the organization that published the
	// compliance items.
	HighCount int32

	// The total number of resources or compliance items that have a severity level of
	// informational. Informational severity is determined by the organization that
	// published the compliance items.
	InformationalCount int32

	// The total number of resources or compliance items that have a severity level of
	// low. Low severity is determined by the organization that published the
	// compliance items.
	LowCount int32

	// The total number of resources or compliance items that have a severity level of
	// medium. Medium severity is determined by the organization that published the
	// compliance items.
	MediumCount int32

	// The total number of resources or compliance items that have a severity level of
	// unspecified. Unspecified severity is determined by the organization that
	// published the compliance items.
	UnspecifiedCount int32
	// contains filtered or unexported fields
}

The number of managed nodes found for each patch severity level defined in the request filter.

type SignalType 

type SignalType string
const (
	SignalTypeApprove   SignalType = "Approve"
	SignalTypeReject    SignalType = "Reject"
	SignalTypeStartStep SignalType = "StartStep"
	SignalTypeStopStep  SignalType = "StopStep"
	SignalTypeResume    SignalType = "Resume"
)

Enum values for SignalType

func (SignalType) Values added in v0.29.0 

func (SignalType) Values() []SignalType

Values returns all known values for SignalType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SourceType added in v1.17.0 

type SourceType string
const (
	SourceTypeAwsEc2Instance        SourceType = "AWS::EC2::Instance"
	SourceTypeAwsIotThing           SourceType = "AWS::IoT::Thing"
	SourceTypeAwsSsmManagedinstance SourceType = "AWS::SSM::ManagedInstance"
)

Enum values for SourceType

func (SourceType) Values added in v1.17.0 

func (SourceType) Values() []SourceType

Values returns all known values for SourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StatusUnchanged 

type StatusUnchanged struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The updated status is the same as the current status.

func (*StatusUnchanged) Error 

func (e *StatusUnchanged) Error() string

func (*StatusUnchanged) ErrorCode 

func (e *StatusUnchanged) ErrorCode() string

func (*StatusUnchanged) ErrorFault 

func (e *StatusUnchanged) ErrorFault() smithy.ErrorFault

func (*StatusUnchanged) ErrorMessage 

func (e *StatusUnchanged) ErrorMessage() string

type StepExecution 

type StepExecution struct {

	// The action this step performs. The action determines the behavior of the step.
	Action *string

	// If a step has finished execution, this contains the time the execution ended.
	// If the step hasn't yet concluded, this field isn't populated.
	ExecutionEndTime *time.Time

	// If a step has begun execution, this contains the time the step started. If the
	// step is in Pending status, this field isn't populated.
	ExecutionStartTime *time.Time

	// Information about the Automation failure.
	FailureDetails *FailureDetails

	// If a step failed, this message explains why the execution failed.
	FailureMessage *string

	// Fully-resolved values passed into the step before execution.
	Inputs map[string]string

	// The flag which can be used to help decide whether the failure of current step
	// leads to the Automation failure.
	IsCritical *bool

	// The flag which can be used to end automation no matter whether the step
	// succeeds or fails.
	IsEnd *bool

	// The maximum number of tries to run the action of the step. The default value is
	// 1 .
	MaxAttempts *int32

	// The next step after the step succeeds.
	NextStep *string

	// The action to take if the step fails. The default value is Abort .
	OnFailure *string

	// Returned values from the execution of the step.
	Outputs map[string][]string

	// A user-specified list of parameters to override when running a step.
	OverriddenParameters map[string][]string

	// Information about the parent step.
	ParentStepDetails *ParentStepDetails

	// A message associated with the response code for an execution.
	Response *string

	// The response code returned by the execution of the step.
	ResponseCode *string

	// The unique ID of a step execution.
	StepExecutionId *string

	// The name of this execution step.
	StepName *string

	// The execution status for this step.
	StepStatus AutomationExecutionStatus

	// The combination of Amazon Web Services Regions and Amazon Web Services accounts
	// targeted by the current Automation execution.
	TargetLocation *TargetLocation

	// The targets for the step execution.
	Targets []Target

	// The timeout seconds of the step.
	TimeoutSeconds *int64

	// The CloudWatch alarms that were invoked by the automation.
	TriggeredAlarms []AlarmStateInformation

	// Strategies used when step fails, we support Continue and Abort. Abort will fail
	// the automation when the step fails. Continue will ignore the failure of current
	// step and allow automation to run the next step. With conditional branching, we
	// add step:stepName to support the automation to go to another specific step.
	ValidNextSteps []string
	// contains filtered or unexported fields
}

Detailed information about an the execution state of an Automation step.

type StepExecutionFilter 

type StepExecutionFilter struct {

	// One or more keys to limit the results.
	//
	// This member is required.
	Key StepExecutionFilterKey

	// The values of the filter key.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

A filter to limit the amount of step execution information returned by the call.

type StepExecutionFilterKey 

type StepExecutionFilterKey string
const (
	StepExecutionFilterKeyStartTimeBefore         StepExecutionFilterKey = "StartTimeBefore"
	StepExecutionFilterKeyStartTimeAfter          StepExecutionFilterKey = "StartTimeAfter"
	StepExecutionFilterKeyStepExecutionStatus     StepExecutionFilterKey = "StepExecutionStatus"
	StepExecutionFilterKeyStepExecutionId         StepExecutionFilterKey = "StepExecutionId"
	StepExecutionFilterKeyStepName                StepExecutionFilterKey = "StepName"
	StepExecutionFilterKeyAction                  StepExecutionFilterKey = "Action"
	StepExecutionFilterKeyParentStepExecutionId   StepExecutionFilterKey = "ParentStepExecutionId"
	StepExecutionFilterKeyParentStepIteration     StepExecutionFilterKey = "ParentStepIteration"
	StepExecutionFilterKeyParentStepIteratorValue StepExecutionFilterKey = "ParentStepIteratorValue"
)

Enum values for StepExecutionFilterKey

func (StepExecutionFilterKey) Values added in v0.29.0 

func (StepExecutionFilterKey) Values() []StepExecutionFilterKey

Values returns all known values for StepExecutionFilterKey. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StopType 

type StopType string
const (
	StopTypeComplete StopType = "Complete"
	StopTypeCancel   StopType = "Cancel"
)

Enum values for StopType

func (StopType) Values added in v0.29.0 

func (StopType) Values() []StopType

Values returns all known values for StopType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SubTypeCountLimitExceededException 

type SubTypeCountLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The sub-type count exceeded the limit for the inventory type.

func (*SubTypeCountLimitExceededException) Error 

func (e *SubTypeCountLimitExceededException) Error() string

func (*SubTypeCountLimitExceededException) ErrorCode 

func (e *SubTypeCountLimitExceededException) ErrorCode() string

func (*SubTypeCountLimitExceededException) ErrorFault 

func (e *SubTypeCountLimitExceededException) ErrorFault() smithy.ErrorFault

func (*SubTypeCountLimitExceededException) ErrorMessage 

func (e *SubTypeCountLimitExceededException) ErrorMessage() string

type Tag 

type Tag struct {

	// The name of the tag.
	//
	// This member is required.
	Key *string

	// The value of the tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

type Target 

type Target struct {

	// User-defined criteria for sending commands that target managed nodes that meet
	// the criteria.
	Key *string

	// User-defined criteria that maps to Key . For example, if you specified
	// tag:ServerRole , you could specify value:WebServer to run a command on
	// instances that include EC2 tags of ServerRole,WebServer .
	//
	// Depending on the type of target, the maximum number of values for a key might
	// be lower than the global maximum of 50.
	Values []string
	// contains filtered or unexported fields
}

An array of search criteria that targets managed nodes using a key-value pair that you specify.

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targetsin the Amazon Web Services Systems Manager User Guide.

Supported formats include the following.

For all Systems Manager capabilities:

  • Key=tag-key,Values=tag-value-1,tag-value-2

For Automation and Change Manager:

  • Key=tag:tag-key,Values=tag-value

  • Key=ResourceGroup,Values=resource-group-name

  • Key=ParameterValues,Values=value-1,value-2,value-3

  • To target all instances in the Amazon Web Services Region:

  • Key=AWS::EC2::Instance,Values=*

  • Key=InstanceIds,Values=*

For Run Command and Maintenance Windows:

  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

  • Key=tag:tag-key,Values=tag-value-1,tag-value-2

  • Key=resource-groups:Name,Values=resource-group-name

  • Additionally, Maintenance Windows support targeting resource types:

    - Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

For State Manager:

  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

  • Key=tag:tag-key,Values=tag-value-1,tag-value-2

  • To target all instances in the Amazon Web Services Region:

  • Key=InstanceIds,Values=*

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

type TargetInUseException 

type TargetInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

func (*TargetInUseException) Error 

func (e *TargetInUseException) Error() string

func (*TargetInUseException) ErrorCode 

func (e *TargetInUseException) ErrorCode() string

func (*TargetInUseException) ErrorFault 

func (e *TargetInUseException) ErrorFault() smithy.ErrorFault

func (*TargetInUseException) ErrorMessage 

func (e *TargetInUseException) ErrorMessage() string

type TargetLocation 

type TargetLocation struct {

	// The Amazon Web Services accounts targeted by the current Automation execution.
	Accounts []string

	// Amazon Web Services accounts or organizational units to exclude as expanded
	// targets.
	ExcludeAccounts []string

	// The Automation execution role used by the currently running Automation. If not
	// specified, the default value is AWS-SystemsManager-AutomationExecutionRole .
	ExecutionRoleName *string

	// Indicates whether to include child organizational units (OUs) that are children
	// of the targeted OUs. The default is false .
	IncludeChildOrganizationUnits bool

	// The Amazon Web Services Regions targeted by the current Automation execution.
	Regions []string

	// The details for the CloudWatch alarm you want to apply to an automation or
	// command.
	TargetLocationAlarmConfiguration *AlarmConfiguration

	// The maximum number of Amazon Web Services Regions and Amazon Web Services
	// accounts allowed to run the Automation concurrently.
	TargetLocationMaxConcurrency *string

	// The maximum number of errors allowed before the system stops queueing
	// additional Automation executions for the currently running Automation.
	TargetLocationMaxErrors *string

	// A list of key-value mappings to target resources. If you specify values for
	// this data type, you must also specify a value for TargetParameterName .
	//
	// This Targets parameter takes precedence over the
	// StartAutomationExecution:Targets parameter if both are supplied.
	Targets []Target

	// The maximum number of targets allowed to run this task in parallel. This
	// TargetsMaxConcurrency takes precedence over the
	// StartAutomationExecution:MaxConcurrency parameter if both are supplied.
	TargetsMaxConcurrency *string

	// The maximum number of errors that are allowed before the system stops running
	// the automation on additional targets. This TargetsMaxErrors parameter takes
	// precedence over the StartAutomationExecution:MaxErrors parameter if both are
	// supplied.
	TargetsMaxErrors *string
	// contains filtered or unexported fields
}

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

type TargetNotConnected 

type TargetNotConnected struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Setting up Session Managerin the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on a managed node that is located in a different account or Region

func (*TargetNotConnected) Error 

func (e *TargetNotConnected) Error() string

func (*TargetNotConnected) ErrorCode 

func (e *TargetNotConnected) ErrorCode() string

func (*TargetNotConnected) ErrorFault 

func (e *TargetNotConnected) ErrorFault() smithy.ErrorFault

func (*TargetNotConnected) ErrorMessage 

func (e *TargetNotConnected) ErrorMessage() string

type TooManyTagsError 

type TooManyTagsError struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Targets parameter includes too many tags. Remove one or more tags and try the command again.

func (*TooManyTagsError) Error 

func (e *TooManyTagsError) Error() string

func (*TooManyTagsError) ErrorCode 

func (e *TooManyTagsError) ErrorCode() string

func (*TooManyTagsError) ErrorFault 

func (e *TooManyTagsError) ErrorFault() smithy.ErrorFault

func (*TooManyTagsError) ErrorMessage 

func (e *TooManyTagsError) ErrorMessage() string

type TooManyUpdates 

type TooManyUpdates struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*TooManyUpdates) Error 

func (e *TooManyUpdates) Error() string

func (*TooManyUpdates) ErrorCode 

func (e *TooManyUpdates) ErrorCode() string

func (*TooManyUpdates) ErrorFault 

func (e *TooManyUpdates) ErrorFault() smithy.ErrorFault

func (*TooManyUpdates) ErrorMessage 

func (e *TooManyUpdates) ErrorMessage() string

type TotalSizeLimitExceededException 

type TotalSizeLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The size of inventory data has exceeded the total size limit for the resource.

func (*TotalSizeLimitExceededException) Error 

func (e *TotalSizeLimitExceededException) Error() string

func (*TotalSizeLimitExceededException) ErrorCode 

func (e *TotalSizeLimitExceededException) ErrorCode() string

func (*TotalSizeLimitExceededException) ErrorFault 

func (e *TotalSizeLimitExceededException) ErrorFault() smithy.ErrorFault

func (*TotalSizeLimitExceededException) ErrorMessage 

func (e *TotalSizeLimitExceededException) ErrorMessage() string

type UnsupportedCalendarException 

type UnsupportedCalendarException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The calendar entry contained in the specified SSM document isn't supported.

func (*UnsupportedCalendarException) Error 

func (e *UnsupportedCalendarException) Error() string

func (*UnsupportedCalendarException) ErrorCode 

func (e *UnsupportedCalendarException) ErrorCode() string

func (*UnsupportedCalendarException) ErrorFault 

func (e *UnsupportedCalendarException) ErrorFault() smithy.ErrorFault

func (*UnsupportedCalendarException) ErrorMessage 

func (e *UnsupportedCalendarException) ErrorMessage() string

type UnsupportedFeatureRequiredException 

type UnsupportedFeatureRequiredException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Turning on the advanced-instances tierin the Amazon Web Services Systems Manager User Guide.

func (*UnsupportedFeatureRequiredException) Error 

func (e *UnsupportedFeatureRequiredException) Error() string

func (*UnsupportedFeatureRequiredException) ErrorCode 

func (e *UnsupportedFeatureRequiredException) ErrorCode() string

func (*UnsupportedFeatureRequiredException) ErrorFault 

func (e *UnsupportedFeatureRequiredException) ErrorFault() smithy.ErrorFault

func (*UnsupportedFeatureRequiredException) ErrorMessage 

func (e *UnsupportedFeatureRequiredException) ErrorMessage() string

type UnsupportedInventoryItemContextException 

type UnsupportedInventoryItemContextException struct {
	Message *string

	ErrorCodeOverride *string

	TypeName *string
	// contains filtered or unexported fields
}

The Context attribute that you specified for the InventoryItem isn't allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem .

func (*UnsupportedInventoryItemContextException) Error 

func (e *UnsupportedInventoryItemContextException) Error() string

func (*UnsupportedInventoryItemContextException) ErrorCode 

func (e *UnsupportedInventoryItemContextException) ErrorCode() string

func (*UnsupportedInventoryItemContextException) ErrorFault 

func (e *UnsupportedInventoryItemContextException) ErrorFault() smithy.ErrorFault

func (*UnsupportedInventoryItemContextException) ErrorMessage 

func (e *UnsupportedInventoryItemContextException) ErrorMessage() string

type UnsupportedInventorySchemaVersionException 

type UnsupportedInventorySchemaVersionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.

func (*UnsupportedInventorySchemaVersionException) Error 

func (e *UnsupportedInventorySchemaVersionException) Error() string

func (*UnsupportedInventorySchemaVersionException) ErrorCode 

func (e *UnsupportedInventorySchemaVersionException) ErrorCode() string

func (*UnsupportedInventorySchemaVersionException) ErrorFault 

func (e *UnsupportedInventorySchemaVersionException) ErrorFault() smithy.ErrorFault

func (*UnsupportedInventorySchemaVersionException) ErrorMessage 

func (e *UnsupportedInventorySchemaVersionException) ErrorMessage() string

type UnsupportedOperatingSystem 

type UnsupportedOperatingSystem struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operating systems you specified isn't supported, or the operation isn't supported for the operating system.

func (*UnsupportedOperatingSystem) Error 

func (e *UnsupportedOperatingSystem) Error() string

func (*UnsupportedOperatingSystem) ErrorCode 

func (e *UnsupportedOperatingSystem) ErrorCode() string

func (*UnsupportedOperatingSystem) ErrorFault 

func (e *UnsupportedOperatingSystem) ErrorFault() smithy.ErrorFault

func (*UnsupportedOperatingSystem) ErrorMessage 

func (e *UnsupportedOperatingSystem) ErrorMessage() string

type UnsupportedParameterType 

type UnsupportedParameterType struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The parameter type isn't supported.

func (*UnsupportedParameterType) Error 

func (e *UnsupportedParameterType) Error() string

func (*UnsupportedParameterType) ErrorCode 

func (e *UnsupportedParameterType) ErrorCode() string

func (*UnsupportedParameterType) ErrorFault 

func (e *UnsupportedParameterType) ErrorFault() smithy.ErrorFault

func (*UnsupportedParameterType) ErrorMessage 

func (e *UnsupportedParameterType) ErrorMessage() string

type UnsupportedPlatformType 

type UnsupportedPlatformType struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.

func (*UnsupportedPlatformType) Error 

func (e *UnsupportedPlatformType) Error() string

func (*UnsupportedPlatformType) ErrorCode 

func (e *UnsupportedPlatformType) ErrorCode() string

func (*UnsupportedPlatformType) ErrorFault 

func (e *UnsupportedPlatformType) ErrorFault() smithy.ErrorFault

func (*UnsupportedPlatformType) ErrorMessage 

func (e *UnsupportedPlatformType) ErrorMessage() string

Source Files

View all Source files

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.