Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.DeleteAssociation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

data DeleteAssociation Source #

See: newDeleteAssociation smart constructor.

Constructors

DeleteAssociation'

Fields

associationId :: Maybe Text
The association ID that you want to delete.
instanceId :: Maybe Text
The instance ID.
InstanceId has been deprecated. To specify an instance 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.
name :: Maybe Text
The name of the SSM document.

Instances

Instances details

Eq DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods (==) :: DeleteAssociation -> DeleteAssociation -> Bool # (/=) :: DeleteAssociation -> DeleteAssociation -> Bool #
Read DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods readsPrec :: Int -> ReadS DeleteAssociation # readList :: ReadS [DeleteAssociation] # readPrec :: ReadPrec DeleteAssociation # readListPrec :: ReadPrec [DeleteAssociation] #
Show DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods showsPrec :: Int -> DeleteAssociation -> ShowS # show :: DeleteAssociation -> String # showList :: [DeleteAssociation] -> ShowS #
Generic DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Associated Types type Rep DeleteAssociation :: Type -> Type # Methods from :: DeleteAssociation -> Rep DeleteAssociation x # to :: Rep DeleteAssociation x -> DeleteAssociation #
NFData DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods rnf :: DeleteAssociation -> () #
Hashable DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods hashWithSalt :: Int -> DeleteAssociation -> Int # hash :: DeleteAssociation -> Int #
ToJSON DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods toJSON :: DeleteAssociation -> Value # toEncoding :: DeleteAssociation -> Encoding # toJSONList :: [DeleteAssociation] -> Value # toEncodingList :: [DeleteAssociation] -> Encoding #
AWSRequest DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Associated Types type AWSResponse DeleteAssociation # Methods request :: DeleteAssociation -> Request DeleteAssociation # response :: MonadResource m => Logger -> Service -> Proxy DeleteAssociation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteAssociation))) #
ToHeaders DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods toHeaders :: DeleteAssociation -> [Header] #
ToPath DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods toPath :: DeleteAssociation -> ByteString #
ToQuery DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods toQuery :: DeleteAssociation -> QueryString #
type Rep DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation type Rep DeleteAssociation = D1 ('MetaData "DeleteAssociation" "Amazonka.SSM.DeleteAssociation" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DeleteAssociation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "associationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DeleteAssociation Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation type AWSResponse DeleteAssociation = DeleteAssociationResponse

newDeleteAssociation :: DeleteAssociation Source #

Create a value of DeleteAssociation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:associationId:DeleteAssociation', deleteAssociation_associationId - The association ID that you want to delete.

$sel:instanceId:DeleteAssociation', deleteAssociation_instanceId - The instance ID.

InstanceId has been deprecated. To specify an instance 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.

$sel:name:DeleteAssociation', deleteAssociation_name - The name of the SSM document.

Request Lenses

deleteAssociation_associationId :: Lens' DeleteAssociation (Maybe Text) Source #

The association ID that you want to delete.

deleteAssociation_instanceId :: Lens' DeleteAssociation (Maybe Text) Source #

The instance ID.

InstanceId has been deprecated. To specify an instance 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.

deleteAssociation_name :: Lens' DeleteAssociation (Maybe Text) Source #

The name of the SSM document.

Destructuring the Response

data DeleteAssociationResponse Source #

See: newDeleteAssociationResponse smart constructor.

Constructors

DeleteAssociationResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteAssociationResponse Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods (==) :: DeleteAssociationResponse -> DeleteAssociationResponse -> Bool # (/=) :: DeleteAssociationResponse -> DeleteAssociationResponse -> Bool #
Read DeleteAssociationResponse Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods readsPrec :: Int -> ReadS DeleteAssociationResponse # readList :: ReadS [DeleteAssociationResponse] # readPrec :: ReadPrec DeleteAssociationResponse # readListPrec :: ReadPrec [DeleteAssociationResponse] #
Show DeleteAssociationResponse Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods showsPrec :: Int -> DeleteAssociationResponse -> ShowS # show :: DeleteAssociationResponse -> String # showList :: [DeleteAssociationResponse] -> ShowS #
Generic DeleteAssociationResponse Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Associated Types type Rep DeleteAssociationResponse :: Type -> Type # Methods from :: DeleteAssociationResponse -> Rep DeleteAssociationResponse x # to :: Rep DeleteAssociationResponse x -> DeleteAssociationResponse #
NFData DeleteAssociationResponse Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation Methods rnf :: DeleteAssociationResponse -> () #
type Rep DeleteAssociationResponse Source #
Instance details Defined in Amazonka.SSM.DeleteAssociation type Rep DeleteAssociationResponse = D1 ('MetaData "DeleteAssociationResponse" "Amazonka.SSM.DeleteAssociation" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DeleteAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteAssociationResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteAssociationResponse'`
-> DeleteAssociationResponse

Create a value of DeleteAssociationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteAssociationResponse', deleteAssociationResponse_httpStatus - The response's http status code.

Response Lenses

deleteAssociationResponse_httpStatus :: Lens' DeleteAssociationResponse Int Source #

The response's http status code.