Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
" }, + "AssociateOpsItemRelatedItem":{ + "name":"AssociateOpsItemRelatedItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateOpsItemRelatedItemRequest"}, + "output":{"shape":"AssociateOpsItemRelatedItemResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"OpsItemNotFoundException"}, + {"shape":"OpsItemLimitExceededException"}, + {"shape":"OpsItemInvalidParameterException"}, + {"shape":"OpsItemRelatedItemAlreadyExistsException"} + ], + "documentation":"Associates a related resource to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager is a capability of AWS Systems Manager.
" + }, "CancelCommand":{ "name":"CancelCommand", "http":{ @@ -894,6 +911,22 @@ ], "documentation":"Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
" }, + "DisassociateOpsItemRelatedItem":{ + "name":"DisassociateOpsItemRelatedItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateOpsItemRelatedItemRequest"}, + "output":{"shape":"DisassociateOpsItemRelatedItemResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"OpsItemRelatedItemAssociationNotFoundException"}, + {"shape":"OpsItemNotFoundException"}, + {"shape":"OpsItemInvalidParameterException"} + ], + "documentation":"Deletes the association between an OpsItem and a related resource. For example, this API action can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of AWS Systems Manager.
" + }, "GetAutomationExecution":{ "name":"GetAutomationExecution", "http":{ @@ -1445,6 +1478,20 @@ ], "documentation":"Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
" }, + "ListOpsItemRelatedItems":{ + "name":"ListOpsItemRelatedItems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOpsItemRelatedItemsRequest"}, + "output":{"shape":"ListOpsItemRelatedItemsResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"OpsItemInvalidParameterException"} + ], + "documentation":"Lists all related-item resources associated with an OpsItem.
" + }, "ListOpsMetadata":{ "name":"ListOpsMetadata", "http":{ @@ -2235,6 +2282,42 @@ "max":360, "min":0 }, + "AssociateOpsItemRelatedItemRequest":{ + "type":"structure", + "required":[ + "OpsItemId", + "AssociationType", + "ResourceType", + "ResourceUri" + ], + "members":{ + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"The ID of the OpsItem to which you want to associate a resource as a related item.
" + }, + "AssociationType":{ + "shape":"OpsItemRelatedItemAssociationType", + "documentation":"The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.
The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:
AWS::SSMIncidents::IncidentRecord: an Incident Manager incident. Incident Manager is a capability of AWS Systems Manager.
AWS::SSM::Document: a Systems Manager (SSM) document.
The Amazon Resource Name (ARN) of the AWS resource that you want to associate with the OpsItem.
" + } + } + }, + "AssociateOpsItemRelatedItemResponse":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"OpsItemRelatedItemAssociationId", + "documentation":"The association ID.
" + } + } + }, "AssociatedInstances":{ "type":"structure", "members":{ @@ -4367,6 +4450,10 @@ "shape":"DocumentName", "documentation":"A name for the Systems Manager document.
You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:
aws-
amazon
amzn
An optional field where you can specify a friendly name for the Systems Manager document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument action.
" + }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"An optional field specifying the version of the artifact you are creating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
" @@ -5233,7 +5320,7 @@ }, "ReverseOrder":{ "shape":"Boolean", - "documentation":"A boolean that indicates whether to list step executions in reverse order by start time. The default value is 'false'.
", + "documentation":"Indicates whether to list step executions in reverse order by start time. The default value is 'false'.
", "box":true } } @@ -6194,6 +6281,28 @@ } }, "DescriptionInDocument":{"type":"string"}, + "DisassociateOpsItemRelatedItemRequest":{ + "type":"structure", + "required":[ + "OpsItemId", + "AssociationId" + ], + "members":{ + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"The ID of the OpsItem for which you want to delete an association between the OpsItem and a related resource.
" + }, + "AssociationId":{ + "shape":"OpsItemRelatedItemAssociationId", + "documentation":"The ID of the association for which you want to delete an association between the OpsItem and a related resource.
" + } + } + }, + "DisassociateOpsItemRelatedItemResponse":{ + "type":"structure", + "members":{ + } + }, "DocumentARN":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.:/]{3,128}$" @@ -6248,6 +6357,10 @@ "shape":"DocumentARN", "documentation":"The name of the Systems Manager document.
" }, + "DisplayName":{ + "shape":"DocumentDisplayName", + "documentation":"The friendly name of the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
" + }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"The version of the artifact associated with the document.
" @@ -6343,6 +6456,11 @@ }, "documentation":"Describes a Systems Manager document.
" }, + "DocumentDisplayName":{ + "type":"string", + "max":1024, + "pattern":"^[\\w\\.\\-\\:\\/ ]*$" + }, "DocumentFilter":{ "type":"structure", "required":[ @@ -6405,6 +6523,14 @@ "shape":"DocumentARN", "documentation":"The name of the Systems Manager document.
" }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"The date the Systems Manager document was created.
" + }, + "DisplayName":{ + "shape":"DocumentDisplayName", + "documentation":"An optional field where you can specify a friendly name for the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
" + }, "Owner":{ "shape":"DocumentOwner", "documentation":"The AWS user account that created the document.
" @@ -6707,7 +6833,9 @@ "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar", - "Automation.ChangeTemplate" + "Automation.ChangeTemplate", + "ProblemAnalysis", + "ProblemAnalysisTemplate" ] }, "DocumentVersion":{ @@ -6721,6 +6849,10 @@ "shape":"DocumentName", "documentation":"The document name.
" }, + "DisplayName":{ + "shape":"DocumentDisplayName", + "documentation":"The friendly name of the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
" + }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"The document version.
" @@ -7163,6 +7295,14 @@ "shape":"DocumentARN", "documentation":"The name of the Systems Manager document.
" }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"The date the Systems Manager document was created.
" + }, + "DisplayName":{ + "shape":"DocumentDisplayName", + "documentation":"The friendly name of the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
" + }, "VersionName":{ "shape":"DocumentVersionName", "documentation":"The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.
" @@ -9840,6 +9980,40 @@ } } }, + "ListOpsItemRelatedItemsRequest":{ + "type":"structure", + "members":{ + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"The ID of the OpsItem for which you want to list all related-item resources.
" + }, + "Filters":{ + "shape":"OpsItemRelatedItemsFilters", + "documentation":"One or more OpsItem filters. Use a filter to return a more specific list of results.
" + }, + "MaxResults":{ + "shape":"OpsItemRelatedItemsMaxResults", + "documentation":"The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of items to return. (You received this token from a previous call.)
" + } + } + }, + "ListOpsItemRelatedItemsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"The token for the next set of items to return. Use this token to get the next set of results.
" + }, + "Summaries":{ + "shape":"OpsItemRelatedItemSummaries", + "documentation":"A list of related-item resources for the specified OpsItem.
" + } + } + }, "ListOpsMetadataMaxResults":{ "type":"integer", "max":50, @@ -11145,7 +11319,7 @@ }, "OpsItemDescription":{ "type":"string", - "max":1024, + "max":2048, "min":1, "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, @@ -11235,7 +11409,7 @@ "documentation":"The date and time the OpsItem event was created.
" } }, - "documentation":"Summary information about an OpsItem event.
" + "documentation":"Summary information about an OpsItem event or that associated an OpsItem with a related item.
" }, "OpsItemFilter":{ "type":"structure", @@ -11388,6 +11562,117 @@ "max":5, "min":1 }, + "OpsItemRelatedItemAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceUri":{"shape":"OpsItemRelatedItemAssociationResourceUri"}, + "OpsItemId":{"shape":"OpsItemId"} + }, + "documentation":"The Amazon Resource Name (ARN) is already associated with the OpsItem.
", + "exception":true + }, + "OpsItemRelatedItemAssociationId":{"type":"string"}, + "OpsItemRelatedItemAssociationNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The association was not found using the parameters you specified in the call. Verify the information and try again.
", + "exception":true + }, + "OpsItemRelatedItemAssociationResourceType":{"type":"string"}, + "OpsItemRelatedItemAssociationResourceUri":{"type":"string"}, + "OpsItemRelatedItemAssociationType":{"type":"string"}, + "OpsItemRelatedItemSummaries":{ + "type":"list", + "member":{"shape":"OpsItemRelatedItemSummary"} + }, + "OpsItemRelatedItemSummary":{ + "type":"structure", + "members":{ + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"The OpsItem ID.
" + }, + "AssociationId":{ + "shape":"OpsItemRelatedItemAssociationId", + "documentation":"The association ID.
" + }, + "ResourceType":{ + "shape":"OpsItemRelatedItemAssociationResourceType", + "documentation":"The resource type.
" + }, + "AssociationType":{ + "shape":"OpsItemRelatedItemAssociationType", + "documentation":"The association type.
" + }, + "ResourceUri":{ + "shape":"OpsItemRelatedItemAssociationResourceUri", + "documentation":"The Amazon Resource Name (ARN) of the related-item resource.
" + }, + "CreatedBy":{"shape":"OpsItemIdentity"}, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"The time the related-item association was created.
" + }, + "LastModifiedBy":{"shape":"OpsItemIdentity"}, + "LastModifiedTime":{ + "shape":"DateTime", + "documentation":"The time the related-item association was last updated.
" + } + }, + "documentation":"Summary information about related-item resources for an OpsItem.
" + }, + "OpsItemRelatedItemsFilter":{ + "type":"structure", + "required":[ + "Key", + "Values", + "Operator" + ], + "members":{ + "Key":{ + "shape":"OpsItemRelatedItemsFilterKey", + "documentation":"The name of the filter key. Supported values include ResourceUri, ResourceType, or AssociationId.
The values for the filter.
" + }, + "Operator":{ + "shape":"OpsItemRelatedItemsFilterOperator", + "documentation":"The operator used by the filter call. The only supported operator is EQUAL.
Describes a filter for a specific list of related-item resources.
" + }, + "OpsItemRelatedItemsFilterKey":{ + "type":"string", + "enum":[ + "ResourceType", + "AssociationId", + "ResourceUri" + ] + }, + "OpsItemRelatedItemsFilterOperator":{ + "type":"string", + "enum":["Equal"] + }, + "OpsItemRelatedItemsFilterValue":{"type":"string"}, + "OpsItemRelatedItemsFilterValues":{ + "type":"list", + "member":{"shape":"OpsItemRelatedItemsFilterValue"} + }, + "OpsItemRelatedItemsFilters":{ + "type":"list", + "member":{"shape":"OpsItemRelatedItemsFilter"} + }, + "OpsItemRelatedItemsMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, "OpsItemSeverity":{ "type":"string", "max":64, @@ -14986,7 +15271,11 @@ }, "Name":{ "shape":"DocumentName", - "documentation":"The name of the document that you want to update.
" + "documentation":"The name of the Systems Manager document that you want to update.
" + }, + "DisplayName":{ + "shape":"DocumentDisplayName", + "documentation":"The friendly name of the Systems Manager document that you want to update. This value can differ for each version of the document. If you do not specify a value for this parameter in your request, the existing value is applied to the new document version.
" }, "VersionName":{ "shape":"DocumentVersionName", @@ -15628,5 +15917,5 @@ "pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" } }, - "documentation":"AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the AWS Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide.
For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API requests.
" + "documentation":"AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the AWS Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide.
Related resources
For information about how to use a Query API, see Making API requests.
For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference.
For information about AWS AppConfig, a capability of Systems Manager, see the AWS AppConfig User Guide and the AWS AppConfig API Reference.
For information about AWS Incident Manager, a capability of Systems Manager, see the AWS Incident Manager User Guide and the AWS Incident Manager API Reference.