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.DescribeAssociation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.

Synopsis

data DescribeAssociation = DescribeAssociation' {
- associationId :: Maybe Text
- instanceId :: Maybe Text
- name :: Maybe Text
- associationVersion :: Maybe Text
}
newDescribeAssociation :: DescribeAssociation
describeAssociation_associationId :: Lens' DescribeAssociation (Maybe Text)
describeAssociation_instanceId :: Lens' DescribeAssociation (Maybe Text)
describeAssociation_name :: Lens' DescribeAssociation (Maybe Text)
describeAssociation_associationVersion :: Lens' DescribeAssociation (Maybe Text)
data DescribeAssociationResponse = DescribeAssociationResponse' {
- associationDescription :: Maybe AssociationDescription
- httpStatus :: Int
}
newDescribeAssociationResponse :: Int -> DescribeAssociationResponse
describeAssociationResponse_associationDescription :: Lens' DescribeAssociationResponse (Maybe AssociationDescription)
describeAssociationResponse_httpStatus :: Lens' DescribeAssociationResponse Int

Creating a Request

data DescribeAssociation Source #

See: newDescribeAssociation smart constructor.

Constructors

DescribeAssociation'

Fields

associationId :: Maybe Text
The association ID for which you want information.
instanceId :: Maybe Text
The instance ID.
name :: Maybe Text
The name of the SSM document.
associationVersion :: Maybe Text
Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

Instances

Instances details

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

newDescribeAssociation :: DescribeAssociation Source #

Create a value of DescribeAssociation 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:DescribeAssociation', describeAssociation_associationId - The association ID for which you want information.

$sel:instanceId:DescribeAssociation', describeAssociation_instanceId - The instance ID.

$sel:name:DescribeAssociation', describeAssociation_name - The name of the SSM document.

$sel:associationVersion:DescribeAssociation', describeAssociation_associationVersion - Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

Request Lenses

describeAssociation_associationId :: Lens' DescribeAssociation (Maybe Text) Source #

The association ID for which you want information.

describeAssociation_instanceId :: Lens' DescribeAssociation (Maybe Text) Source #

The instance ID.

describeAssociation_name :: Lens' DescribeAssociation (Maybe Text) Source #

The name of the SSM document.

describeAssociation_associationVersion :: Lens' DescribeAssociation (Maybe Text) Source #

Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

Destructuring the Response

data DescribeAssociationResponse Source #

See: newDescribeAssociationResponse smart constructor.

Constructors

DescribeAssociationResponse'
Fields associationDescription :: Maybe AssociationDescription Information about the association. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeAssociationResponse Source #

Arguments

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

Create a value of DescribeAssociationResponse 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:associationDescription:DescribeAssociationResponse', describeAssociationResponse_associationDescription - Information about the association.

$sel:httpStatus:DescribeAssociationResponse', describeAssociationResponse_httpStatus - The response's http status code.

Response Lenses

describeAssociationResponse_associationDescription :: Lens' DescribeAssociationResponse (Maybe AssociationDescription) Source #

Information about the association.

describeAssociationResponse_httpStatus :: Lens' DescribeAssociationResponse Int Source #

The response's http status code.