Amazonka.SSM.GetDocument

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

Creating a Request

data GetDocument

See: newGetDocument smart constructor.

Constructors

GetDocument'

Fields

• documentFormat :: Maybe DocumentFormat

  Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

• documentVersion :: Maybe Text

  The document version for which you want information.

• 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 GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

toJSON :: GetDocument -> Value

toEncoding :: GetDocument -> Encoding

toJSONList :: [GetDocument] -> Value

toEncodingList :: [GetDocument] -> Encoding

ToHeaders GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

toHeaders :: GetDocument -> [Header]

ToPath GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

toPath :: GetDocument -> ByteString

ToQuery GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

toQuery :: GetDocument -> QueryString

AWSRequest GetDocument

Defined in Amazonka.SSM.GetDocument

Associated Types

type AWSResponse GetDocument

Methods

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

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

Generic GetDocument

Defined in Amazonka.SSM.GetDocument

Associated Types

type Rep GetDocument :: Type -> Type

Methods

from :: GetDocument -> Rep GetDocument x

to :: Rep GetDocument x -> GetDocument

Read GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

readsPrec :: Int -> ReadS GetDocument

readList :: ReadS [GetDocument]

readPrec :: ReadPrec GetDocument

readListPrec :: ReadPrec [GetDocument]

Show GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

showsPrec :: Int -> GetDocument -> ShowS

show :: GetDocument -> String

showList :: [GetDocument] -> ShowS

NFData GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

rnf :: GetDocument -> ()

Eq GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

(==) :: GetDocument -> GetDocument -> Bool

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

Hashable GetDocument

Defined in Amazonka.SSM.GetDocument

Methods

hashWithSalt :: Int -> GetDocument -> Int

hash :: GetDocument -> Int

type AWSResponse GetDocument

Defined in Amazonka.SSM.GetDocument

type AWSResponse GetDocument = GetDocumentResponse

type Rep GetDocument

Defined in Amazonka.SSM.GetDocument

type Rep GetDocument = D1 ('MetaData "GetDocument" "Amazonka.SSM.GetDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetDocument'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentFormat)) :*: 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))))

newGetDocument

Arguments

:: Text

GetDocument

-> GetDocument

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

GetDocument, getDocument_documentFormat - Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

GetDocument, getDocument_documentVersion - The document version for which you want information.

GetDocument, getDocument_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.

GetDocument, getDocument_name - The name of the SSM document.

Request Lenses

getDocument_documentFormat :: Lens' GetDocument (Maybe DocumentFormat)

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

getDocument_documentVersion :: Lens' GetDocument (Maybe Text)

The document version for which you want information.

getDocument_versionName :: Lens' GetDocument (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.

getDocument_name :: Lens' GetDocument Text

The name of the SSM document.

Destructuring the Response

data GetDocumentResponse

See: newGetDocumentResponse smart constructor.

Constructors

GetDocumentResponse'

Fields

• attachmentsContent :: Maybe [AttachmentContent]

  A description of the document attachments, including names, locations, sizes, and so on.

• content :: Maybe Text

  The contents of the SSM document.

• createdDate :: Maybe POSIX

  The date the SSM document was created.

• displayName :: Maybe Text

  The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

• documentFormat :: Maybe DocumentFormat

  The document format, either JSON or YAML.

• documentType :: Maybe DocumentType

  The document type.

• documentVersion :: Maybe Text

  The document version.

• name :: Maybe Text

  The name of the SSM document.

• requires :: Maybe (NonEmpty DocumentRequires)

  A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

• reviewStatus :: Maybe ReviewStatus

  The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

  Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

  Only one version of an SSM document can be in review, or PENDING, at a time.

• status :: Maybe DocumentStatus

  The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

• statusInformation :: Maybe Text

  A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

• versionName :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetDocumentResponse

Defined in Amazonka.SSM.GetDocument

Associated Types

type Rep GetDocumentResponse :: Type -> Type

Methods

from :: GetDocumentResponse -> Rep GetDocumentResponse x

to :: Rep GetDocumentResponse x -> GetDocumentResponse

Read GetDocumentResponse

Defined in Amazonka.SSM.GetDocument

Methods

readsPrec :: Int -> ReadS GetDocumentResponse

readList :: ReadS [GetDocumentResponse]

readPrec :: ReadPrec GetDocumentResponse

readListPrec :: ReadPrec [GetDocumentResponse]

Show GetDocumentResponse

Defined in Amazonka.SSM.GetDocument

Methods

showsPrec :: Int -> GetDocumentResponse -> ShowS

show :: GetDocumentResponse -> String

showList :: [GetDocumentResponse] -> ShowS

NFData GetDocumentResponse

Defined in Amazonka.SSM.GetDocument

Methods

rnf :: GetDocumentResponse -> ()

Eq GetDocumentResponse

Defined in Amazonka.SSM.GetDocument

Methods

(==) :: GetDocumentResponse -> GetDocumentResponse -> Bool

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

type Rep GetDocumentResponse

Defined in Amazonka.SSM.GetDocument

type Rep GetDocumentResponse = D1 ('MetaData "GetDocumentResponse" "Amazonka.SSM.GetDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetDocumentResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentsContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttachmentContent])) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentFormat))) :*: (S1 ('MetaSel ('Just "documentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentType)) :*: S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "requires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentRequires))) :*: S1 ('MetaSel ('Just "reviewStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewStatus)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentStatus)) :*: S1 ('MetaSel ('Just "statusInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetDocumentResponse

Arguments

:: Int

$sel:httpStatus:GetDocumentResponse'

-> GetDocumentResponse

Create a value of GetDocumentResponse 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:attachmentsContent:GetDocumentResponse', getDocumentResponse_attachmentsContent - A description of the document attachments, including names, locations, sizes, and so on.

GetDocumentResponse, getDocumentResponse_content - The contents of the SSM document.

GetDocumentResponse, getDocumentResponse_createdDate - The date the SSM document was created.

GetDocumentResponse, getDocumentResponse_displayName - The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

GetDocument, getDocumentResponse_documentFormat - The document format, either JSON or YAML.

GetDocumentResponse, getDocumentResponse_documentType - The document type.

GetDocument, getDocumentResponse_documentVersion - The document version.

GetDocument, getDocumentResponse_name - The name of the SSM document.

GetDocumentResponse, getDocumentResponse_requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

GetDocumentResponse, getDocumentResponse_reviewStatus - The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

GetDocumentResponse, getDocumentResponse_status - The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

GetDocumentResponse, getDocumentResponse_statusInformation - A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

GetDocument, getDocumentResponse_versionName - 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.

$sel:httpStatus:GetDocumentResponse', getDocumentResponse_httpStatus - The response's http status code.

Response Lenses

getDocumentResponse_attachmentsContent :: Lens' GetDocumentResponse (Maybe [AttachmentContent])

A description of the document attachments, including names, locations, sizes, and so on.

getDocumentResponse_content :: Lens' GetDocumentResponse (Maybe Text)

The contents of the SSM document.

getDocumentResponse_createdDate :: Lens' GetDocumentResponse (Maybe UTCTime)

The date the SSM document was created.

getDocumentResponse_displayName :: Lens' GetDocumentResponse (Maybe Text)

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

getDocumentResponse_documentFormat :: Lens' GetDocumentResponse (Maybe DocumentFormat)

The document format, either JSON or YAML.

getDocumentResponse_documentType :: Lens' GetDocumentResponse (Maybe DocumentType)

The document type.

getDocumentResponse_documentVersion :: Lens' GetDocumentResponse (Maybe Text)

The document version.

getDocumentResponse_name :: Lens' GetDocumentResponse (Maybe Text)

The name of the SSM document.

getDocumentResponse_requires :: Lens' GetDocumentResponse (Maybe (NonEmpty DocumentRequires))

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

getDocumentResponse_reviewStatus :: Lens' GetDocumentResponse (Maybe ReviewStatus)

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

getDocumentResponse_status :: Lens' GetDocumentResponse (Maybe DocumentStatus)

The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

getDocumentResponse_statusInformation :: Lens' GetDocumentResponse (Maybe Text)

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

getDocumentResponse_versionName :: Lens' GetDocumentResponse (Maybe Text)

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.

getDocumentResponse_httpStatus :: Lens' GetDocumentResponse Int

The response's http status code.