Amazonka.SSM.DeleteAssociation

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. 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 a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.

Creating a Request

data DeleteAssociation

See: newDeleteAssociation smart constructor.

Constructors

DeleteAssociation'

Fields

• associationId :: Maybe Text

  The association ID that you want to delete.

• instanceId :: Maybe Text

  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.

• name :: Maybe Text

  The name of the SSM document.

Instances

ToJSON DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

toJSON :: DeleteAssociation -> Value

toEncoding :: DeleteAssociation -> Encoding

toJSONList :: [DeleteAssociation] -> Value

toEncodingList :: [DeleteAssociation] -> Encoding

ToHeaders DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

toHeaders :: DeleteAssociation -> [Header]

ToPath DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

toPath :: DeleteAssociation -> ByteString

ToQuery DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

toQuery :: DeleteAssociation -> QueryString

AWSRequest DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Associated Types

type AWSResponse DeleteAssociation

Methods

request :: (Service -> Service) -> DeleteAssociation -> Request DeleteAssociation

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteAssociation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteAssociation)))

Generic DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Associated Types

type Rep DeleteAssociation :: Type -> Type

Methods

from :: DeleteAssociation -> Rep DeleteAssociation x

to :: Rep DeleteAssociation x -> DeleteAssociation

Read DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

readsPrec :: Int -> ReadS DeleteAssociation

readList :: ReadS [DeleteAssociation]

readPrec :: ReadPrec DeleteAssociation

readListPrec :: ReadPrec [DeleteAssociation]

Show DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

showsPrec :: Int -> DeleteAssociation -> ShowS

show :: DeleteAssociation -> String

showList :: [DeleteAssociation] -> ShowS

NFData DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

rnf :: DeleteAssociation -> ()

Eq DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

(==) :: DeleteAssociation -> DeleteAssociation -> Bool

(/=) :: DeleteAssociation -> DeleteAssociation -> Bool

Hashable DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

Methods

hashWithSalt :: Int -> DeleteAssociation -> Int

hash :: DeleteAssociation -> Int

type AWSResponse DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

type AWSResponse DeleteAssociation = DeleteAssociationResponse

type Rep DeleteAssociation

Defined in Amazonka.SSM.DeleteAssociation

type Rep DeleteAssociation = D1 ('MetaData "DeleteAssociation" "Amazonka.SSM.DeleteAssociation" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" '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)))))

newDeleteAssociation :: DeleteAssociation

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:

DeleteAssociation, deleteAssociation_associationId - The association ID that you want to delete.

DeleteAssociation, deleteAssociation_instanceId - 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.

DeleteAssociation, deleteAssociation_name - The name of the SSM document.

Request Lenses

deleteAssociation_associationId :: Lens' DeleteAssociation (Maybe Text)

The association ID that you want to delete.

deleteAssociation_instanceId :: Lens' DeleteAssociation (Maybe Text)

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.

deleteAssociation_name :: Lens' DeleteAssociation (Maybe Text)

The name of the SSM document.

Destructuring the Response

data DeleteAssociationResponse

See: newDeleteAssociationResponse smart constructor.

Constructors

DeleteAssociationResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteAssociationResponse

Defined in Amazonka.SSM.DeleteAssociation

Associated Types

type Rep DeleteAssociationResponse :: Type -> Type

Methods

from :: DeleteAssociationResponse -> Rep DeleteAssociationResponse x

to :: Rep DeleteAssociationResponse x -> DeleteAssociationResponse

Read DeleteAssociationResponse

Defined in Amazonka.SSM.DeleteAssociation

Methods

readsPrec :: Int -> ReadS DeleteAssociationResponse

readList :: ReadS [DeleteAssociationResponse]

readPrec :: ReadPrec DeleteAssociationResponse

readListPrec :: ReadPrec [DeleteAssociationResponse]

Show DeleteAssociationResponse

Defined in Amazonka.SSM.DeleteAssociation

Methods

showsPrec :: Int -> DeleteAssociationResponse -> ShowS

show :: DeleteAssociationResponse -> String

showList :: [DeleteAssociationResponse] -> ShowS

NFData DeleteAssociationResponse

Defined in Amazonka.SSM.DeleteAssociation

Methods

rnf :: DeleteAssociationResponse -> ()

Eq DeleteAssociationResponse

Defined in Amazonka.SSM.DeleteAssociation

Methods

(==) :: DeleteAssociationResponse -> DeleteAssociationResponse -> Bool

(/=) :: DeleteAssociationResponse -> DeleteAssociationResponse -> Bool

type Rep DeleteAssociationResponse

Defined in Amazonka.SSM.DeleteAssociation

type Rep DeleteAssociationResponse = D1 ('MetaData "DeleteAssociationResponse" "Amazonka.SSM.DeleteAssociation" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DeleteAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteAssociationResponse

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

The response's http status code.