Amazonka.SSM.Types.DocumentDescription

Documentation

data DocumentDescription

Describes an Amazon Web Services Systems Manager document (SSM document).

See: newDocumentDescription smart constructor.

Constructors

DocumentDescription'

Fields

• approvedVersion :: Maybe Text

  The version of the document currently approved for use in the organization.

• attachmentsInformation :: Maybe [AttachmentInformation]

  Details about the document attachments, including names, locations, sizes, and so on.

• author :: Maybe Text

  The user in your organization who created the document.

• category :: Maybe [Text]

  The classification of a document to help you identify and categorize its use.

• categoryEnum :: Maybe [Text]

  The value that identifies a document's category.

• createdDate :: Maybe POSIX

  The date when the document was created.

• defaultVersion :: Maybe Text

  The default version.

• description :: Maybe Text

  A description of the document.

• 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 type of document.

• documentVersion :: Maybe Text

  The document version.

• hash :: Maybe Text

  The Sha256 or Sha1 hash created by the system when the document was created.

  Sha1 hashes have been deprecated.

• hashType :: Maybe DocumentHashType

  The hash type of the document. Valid values include Sha256 or Sha1.

  Sha1 hashes have been deprecated.

• latestVersion :: Maybe Text

  The latest version of the document.

• name :: Maybe Text

  The name of the SSM document.

• owner :: Maybe Text

  The Amazon Web Services user account that created the document.

• parameters :: Maybe [DocumentParameter]

  A description of the parameters for a document.

• pendingReviewVersion :: Maybe Text

  The version of the document that is currently under review.

• platformTypes :: Maybe [PlatformType]

  The list of operating system (OS) platforms compatible with this SSM document.

• requires :: Maybe (NonEmpty DocumentRequires)

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

• reviewInformation :: Maybe (NonEmpty ReviewInformation)

  Details about the review of a document.

• reviewStatus :: Maybe ReviewStatus

  The current status of the review.

• schemaVersion :: Maybe Text

  The schema version.

• sha1 :: Maybe Text

  The SHA1 hash of the document, which you can use for verification.

• status :: Maybe DocumentStatus

  The status of the SSM document.

• 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."

• tags :: Maybe [Tag]

  The tags, or metadata, that have been applied to the document.

• targetType :: Maybe Text

  The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

• versionName :: Maybe Text

  The version of the artifact associated with the document.

Instances

FromJSON DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

Methods

parseJSON :: Value -> Parser DocumentDescription

parseJSONList :: Value -> Parser [DocumentDescription]

Generic DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

Associated Types

type Rep DocumentDescription :: Type -> Type

Methods

from :: DocumentDescription -> Rep DocumentDescription x

to :: Rep DocumentDescription x -> DocumentDescription

Read DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

Methods

readsPrec :: Int -> ReadS DocumentDescription

readList :: ReadS [DocumentDescription]

readPrec :: ReadPrec DocumentDescription

readListPrec :: ReadPrec [DocumentDescription]

Show DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

Methods

showsPrec :: Int -> DocumentDescription -> ShowS

show :: DocumentDescription -> String

showList :: [DocumentDescription] -> ShowS

NFData DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

Methods

rnf :: DocumentDescription -> ()

Eq DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

Methods

(==) :: DocumentDescription -> DocumentDescription -> Bool

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

Hashable DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

Methods

hashWithSalt :: Int -> DocumentDescription -> Int

hash :: DocumentDescription -> Int

type Rep DocumentDescription

Defined in Amazonka.SSM.Types.DocumentDescription

type Rep DocumentDescription = D1 ('MetaData "DocumentDescription" "Amazonka.SSM.Types.DocumentDescription" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DocumentDescription'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "approvedVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "attachmentsInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttachmentInformation])) :*: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "categoryEnum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "defaultVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "hash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "hashType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentHashType)) :*: S1 ('MetaSel ('Just "latestVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentParameter])))) :*: ((S1 ('MetaSel ('Just "pendingReviewVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformType]))) :*: (S1 ('MetaSel ('Just "requires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentRequires))) :*: S1 ('MetaSel ('Just "reviewInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ReviewInformation)))))) :*: (((S1 ('MetaSel ('Just "reviewStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewStatus)) :*: S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sha1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentStatus)))) :*: ((S1 ('MetaSel ('Just "statusInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newDocumentDescription :: DocumentDescription

Create a value of DocumentDescription 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:approvedVersion:DocumentDescription', documentDescription_approvedVersion - The version of the document currently approved for use in the organization.

$sel:attachmentsInformation:DocumentDescription', documentDescription_attachmentsInformation - Details about the document attachments, including names, locations, sizes, and so on.

$sel:author:DocumentDescription', documentDescription_author - The user in your organization who created the document.

$sel:category:DocumentDescription', documentDescription_category - The classification of a document to help you identify and categorize its use.

$sel:categoryEnum:DocumentDescription', documentDescription_categoryEnum - The value that identifies a document's category.

$sel:createdDate:DocumentDescription', documentDescription_createdDate - The date when the document was created.

$sel:defaultVersion:DocumentDescription', documentDescription_defaultVersion - The default version.

DocumentDescription, documentDescription_description - A description of the document.

$sel:displayName:DocumentDescription', documentDescription_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.

$sel:documentFormat:DocumentDescription', documentDescription_documentFormat - The document format, either JSON or YAML.

$sel:documentType:DocumentDescription', documentDescription_documentType - The type of document.

$sel:documentVersion:DocumentDescription', documentDescription_documentVersion - The document version.

$sel:hash:DocumentDescription', documentDescription_hash - The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

$sel:hashType:DocumentDescription', documentDescription_hashType - The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

$sel:latestVersion:DocumentDescription', documentDescription_latestVersion - The latest version of the document.

DocumentDescription, documentDescription_name - The name of the SSM document.

$sel:owner:DocumentDescription', documentDescription_owner - The Amazon Web Services user account that created the document.

$sel:parameters:DocumentDescription', documentDescription_parameters - A description of the parameters for a document.

$sel:pendingReviewVersion:DocumentDescription', documentDescription_pendingReviewVersion - The version of the document that is currently under review.

$sel:platformTypes:DocumentDescription', documentDescription_platformTypes - The list of operating system (OS) platforms compatible with this SSM document.

$sel:requires:DocumentDescription', documentDescription_requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

$sel:reviewInformation:DocumentDescription', documentDescription_reviewInformation - Details about the review of a document.

$sel:reviewStatus:DocumentDescription', documentDescription_reviewStatus - The current status of the review.

$sel:schemaVersion:DocumentDescription', documentDescription_schemaVersion - The schema version.

$sel:sha1:DocumentDescription', documentDescription_sha1 - The SHA1 hash of the document, which you can use for verification.

DocumentDescription, documentDescription_status - The status of the SSM document.

$sel:statusInformation:DocumentDescription', documentDescription_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."

$sel:tags:DocumentDescription', documentDescription_tags - The tags, or metadata, that have been applied to the document.

$sel:targetType:DocumentDescription', documentDescription_targetType - The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

DocumentDescription, documentDescription_versionName - The version of the artifact associated with the document.

documentDescription_approvedVersion :: Lens' DocumentDescription (Maybe Text)

The version of the document currently approved for use in the organization.

documentDescription_attachmentsInformation :: Lens' DocumentDescription (Maybe [AttachmentInformation])

Details about the document attachments, including names, locations, sizes, and so on.

documentDescription_author :: Lens' DocumentDescription (Maybe Text)

The user in your organization who created the document.

documentDescription_category :: Lens' DocumentDescription (Maybe [Text])

The classification of a document to help you identify and categorize its use.

documentDescription_categoryEnum :: Lens' DocumentDescription (Maybe [Text])

The value that identifies a document's category.

documentDescription_createdDate :: Lens' DocumentDescription (Maybe UTCTime)

The date when the document was created.

documentDescription_defaultVersion :: Lens' DocumentDescription (Maybe Text)

The default version.

documentDescription_description :: Lens' DocumentDescription (Maybe Text)

A description of the document.

documentDescription_displayName :: Lens' DocumentDescription (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.

documentDescription_documentFormat :: Lens' DocumentDescription (Maybe DocumentFormat)

The document format, either JSON or YAML.

documentDescription_documentType :: Lens' DocumentDescription (Maybe DocumentType)

The type of document.

documentDescription_documentVersion :: Lens' DocumentDescription (Maybe Text)

The document version.

documentDescription_hash :: Lens' DocumentDescription (Maybe Text)

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

documentDescription_hashType :: Lens' DocumentDescription (Maybe DocumentHashType)

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

documentDescription_latestVersion :: Lens' DocumentDescription (Maybe Text)

The latest version of the document.

documentDescription_name :: Lens' DocumentDescription (Maybe Text)

The name of the SSM document.

documentDescription_owner :: Lens' DocumentDescription (Maybe Text)

The Amazon Web Services user account that created the document.

documentDescription_parameters :: Lens' DocumentDescription (Maybe [DocumentParameter])

A description of the parameters for a document.

documentDescription_pendingReviewVersion :: Lens' DocumentDescription (Maybe Text)

The version of the document that is currently under review.

documentDescription_platformTypes :: Lens' DocumentDescription (Maybe [PlatformType])

The list of operating system (OS) platforms compatible with this SSM document.

documentDescription_requires :: Lens' DocumentDescription (Maybe (NonEmpty DocumentRequires))

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

documentDescription_reviewInformation :: Lens' DocumentDescription (Maybe (NonEmpty ReviewInformation))

Details about the review of a document.

documentDescription_reviewStatus :: Lens' DocumentDescription (Maybe ReviewStatus)

The current status of the review.

documentDescription_schemaVersion :: Lens' DocumentDescription (Maybe Text)

The schema version.

documentDescription_sha1 :: Lens' DocumentDescription (Maybe Text)

The SHA1 hash of the document, which you can use for verification.

documentDescription_status :: Lens' DocumentDescription (Maybe DocumentStatus)

The status of the SSM document.

documentDescription_statusInformation :: Lens' DocumentDescription (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."

documentDescription_tags :: Lens' DocumentDescription (Maybe [Tag])

The tags, or metadata, that have been applied to the document.

documentDescription_targetType :: Lens' DocumentDescription (Maybe Text)

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

documentDescription_versionName :: Lens' DocumentDescription (Maybe Text)

The version of the artifact associated with the document.