Amazonka.SSM.DescribeDocument

Describes the specified Amazon Web Services Systems Manager document (SSM document).

Creating a Request

data DescribeDocument

See: newDescribeDocument smart constructor.

Constructors

DescribeDocument'

Fields

• documentVersion :: Maybe Text

  The document version for which you want information. Can be a specific version or the default version.

• versionName :: Maybe Text

  An optional field specifying 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 can't be changed.

• name :: Text

  The name of the SSM document.

Instances

ToJSON DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

toJSON :: DescribeDocument -> Value

toEncoding :: DescribeDocument -> Encoding

toJSONList :: [DescribeDocument] -> Value

toEncodingList :: [DescribeDocument] -> Encoding

ToHeaders DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

toHeaders :: DescribeDocument -> [Header]

ToPath DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

toPath :: DescribeDocument -> ByteString

ToQuery DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

toQuery :: DescribeDocument -> QueryString

AWSRequest DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Associated Types

type AWSResponse DescribeDocument

Methods

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

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

Generic DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Associated Types

type Rep DescribeDocument :: Type -> Type

Methods

from :: DescribeDocument -> Rep DescribeDocument x

to :: Rep DescribeDocument x -> DescribeDocument

Read DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

readsPrec :: Int -> ReadS DescribeDocument

readList :: ReadS [DescribeDocument]

readPrec :: ReadPrec DescribeDocument

readListPrec :: ReadPrec [DescribeDocument]

Show DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

showsPrec :: Int -> DescribeDocument -> ShowS

show :: DescribeDocument -> String

showList :: [DescribeDocument] -> ShowS

NFData DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

rnf :: DescribeDocument -> ()

Eq DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

(==) :: DescribeDocument -> DescribeDocument -> Bool

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

Hashable DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

Methods

hashWithSalt :: Int -> DescribeDocument -> Int

hash :: DescribeDocument -> Int

type AWSResponse DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

type AWSResponse DescribeDocument = DescribeDocumentResponse

type Rep DescribeDocument

Defined in Amazonka.SSM.DescribeDocument

type Rep DescribeDocument = D1 ('MetaData "DescribeDocument" "Amazonka.SSM.DescribeDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeDocument

Arguments

:: Text

DescribeDocument

-> DescribeDocument

Create a value of DescribeDocument 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:

DescribeDocument, describeDocument_documentVersion - The document version for which you want information. Can be a specific version or the default version.

DescribeDocument, describeDocument_versionName - An optional field specifying 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 can't be changed.

DescribeDocument, describeDocument_name - The name of the SSM document.

Request Lenses

describeDocument_documentVersion :: Lens' DescribeDocument (Maybe Text)

The document version for which you want information. Can be a specific version or the default version.

describeDocument_versionName :: Lens' DescribeDocument (Maybe Text)

An optional field specifying 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 can't be changed.

describeDocument_name :: Lens' DescribeDocument Text

The name of the SSM document.

Destructuring the Response

data DescribeDocumentResponse

See: newDescribeDocumentResponse smart constructor.

Constructors

DescribeDocumentResponse'

Fields

• document :: Maybe DocumentDescription

  Information about the SSM document.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeDocumentResponse

Defined in Amazonka.SSM.DescribeDocument

Associated Types

type Rep DescribeDocumentResponse :: Type -> Type

Methods

from :: DescribeDocumentResponse -> Rep DescribeDocumentResponse x

to :: Rep DescribeDocumentResponse x -> DescribeDocumentResponse

Read DescribeDocumentResponse

Defined in Amazonka.SSM.DescribeDocument

Methods

readsPrec :: Int -> ReadS DescribeDocumentResponse

readList :: ReadS [DescribeDocumentResponse]

readPrec :: ReadPrec DescribeDocumentResponse

readListPrec :: ReadPrec [DescribeDocumentResponse]

Show DescribeDocumentResponse

Defined in Amazonka.SSM.DescribeDocument

Methods

showsPrec :: Int -> DescribeDocumentResponse -> ShowS

show :: DescribeDocumentResponse -> String

showList :: [DescribeDocumentResponse] -> ShowS

NFData DescribeDocumentResponse

Defined in Amazonka.SSM.DescribeDocument

Methods

rnf :: DescribeDocumentResponse -> ()

Eq DescribeDocumentResponse

Defined in Amazonka.SSM.DescribeDocument

Methods

(==) :: DescribeDocumentResponse -> DescribeDocumentResponse -> Bool

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

type Rep DescribeDocumentResponse

Defined in Amazonka.SSM.DescribeDocument

type Rep DescribeDocumentResponse = D1 ('MetaData "DescribeDocumentResponse" "Amazonka.SSM.DescribeDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeDocumentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeDocumentResponse

Arguments

:: Int

$sel:httpStatus:DescribeDocumentResponse'

-> DescribeDocumentResponse

Create a value of DescribeDocumentResponse 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:document:DescribeDocumentResponse', describeDocumentResponse_document - Information about the SSM document.

$sel:httpStatus:DescribeDocumentResponse', describeDocumentResponse_httpStatus - The response's http status code.

Response Lenses

describeDocumentResponse_document :: Lens' DescribeDocumentResponse (Maybe DocumentDescription)

Information about the SSM document.

describeDocumentResponse_httpStatus :: Lens' DescribeDocumentResponse Int

The response's http status code.