Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance. If you created the association by using the Targets
parameter, then you must delete the association by using the association ID.
When you disassociate a document from an instance, it doesn’t change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
delete-association
[--name <value>]
[--instance-id <value>]
[--association-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--name
(string)
The name of the SSM document.
--instance-id
(string)
The instance ID.
Note
InstanceId
has been deprecated. To specify an instance ID for an association, use theTargets
parameter. Requests that include the parameterInstanceID
with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameterInstanceId
, you can’t use the parametersAssociationName
,DocumentVersion
,MaxErrors
,MaxConcurrency
,OutputLocation
, orScheduleExpression
. To use these parameters, you must use theTargets
parameter.
--association-id
(string)
The association ID that you want to delete.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Example 1: To delete an association using the association ID
The following delete-association
example deletes the association for the specified association ID. There is no output if the command succeeds.
aws ssm delete-association \
--association-id "8dfe3659-4309-493a-8755-0123456789ab"
This command produces no output.
For more information, see Editing and creating a new version of an association in the AWS Systems Manager User Guide.
Example 2: To delete an association
The following delete-association
example deletes the association between an instance and a document. There is no output if the command succeeds.
aws ssm delete-association \
--instance-id "i-1234567890abcdef0" \
--name "AWS-UpdateSSMAgent"
This command produces no output.
For more information, see Working with associations in Systems Manager in the AWS Systems Manager User Guide.
None