Amazonka.SSM.Types.DocumentVersionInfo

Documentation

data DocumentVersionInfo

Version information about the document.

See: newDocumentVersionInfo smart constructor.

Constructors

DocumentVersionInfo'

Fields

• createdDate :: Maybe POSIX

  The date the 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.

• documentVersion :: Maybe Text

  The document version.

• isDefaultVersion :: Maybe Bool

  An identifier for the default version of the document.

• name :: Maybe Text

  The document name.

• reviewStatus :: Maybe ReviewStatus

  The current status of the approval review for the latest version of the document.

• status :: Maybe DocumentStatus

  The status of the SSM document, such as Creating, Active, 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.

Instances

FromJSON DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

Methods

parseJSON :: Value -> Parser DocumentVersionInfo

parseJSONList :: Value -> Parser [DocumentVersionInfo]

Generic DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

Associated Types

type Rep DocumentVersionInfo :: Type -> Type

Methods

from :: DocumentVersionInfo -> Rep DocumentVersionInfo x

to :: Rep DocumentVersionInfo x -> DocumentVersionInfo

Read DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

Methods

readsPrec :: Int -> ReadS DocumentVersionInfo

readList :: ReadS [DocumentVersionInfo]

readPrec :: ReadPrec DocumentVersionInfo

readListPrec :: ReadPrec [DocumentVersionInfo]

Show DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

Methods

showsPrec :: Int -> DocumentVersionInfo -> ShowS

show :: DocumentVersionInfo -> String

showList :: [DocumentVersionInfo] -> ShowS

NFData DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

Methods

rnf :: DocumentVersionInfo -> ()

Eq DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

Methods

(==) :: DocumentVersionInfo -> DocumentVersionInfo -> Bool

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

Hashable DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

Methods

hashWithSalt :: Int -> DocumentVersionInfo -> Int

hash :: DocumentVersionInfo -> Int

type Rep DocumentVersionInfo

Defined in Amazonka.SSM.Types.DocumentVersionInfo

type Rep DocumentVersionInfo = D1 ('MetaData "DocumentVersionInfo" "Amazonka.SSM.Types.DocumentVersionInfo" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DocumentVersionInfo'" 'PrefixI 'True) (((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 "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isDefaultVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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)))))))

newDocumentVersionInfo :: DocumentVersionInfo

Create a value of DocumentVersionInfo 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:createdDate:DocumentVersionInfo', documentVersionInfo_createdDate - The date the document was created.

$sel:displayName:DocumentVersionInfo', documentVersionInfo_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:DocumentVersionInfo', documentVersionInfo_documentFormat - The document format, either JSON or YAML.

$sel:documentVersion:DocumentVersionInfo', documentVersionInfo_documentVersion - The document version.

$sel:isDefaultVersion:DocumentVersionInfo', documentVersionInfo_isDefaultVersion - An identifier for the default version of the document.

$sel:name:DocumentVersionInfo', documentVersionInfo_name - The document name.

$sel:reviewStatus:DocumentVersionInfo', documentVersionInfo_reviewStatus - The current status of the approval review for the latest version of the document.

$sel:status:DocumentVersionInfo', documentVersionInfo_status - The status of the SSM document, such as Creating, Active, Failed, and Deleting.

$sel:statusInformation:DocumentVersionInfo', documentVersionInfo_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:versionName:DocumentVersionInfo', documentVersionInfo_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.

documentVersionInfo_createdDate :: Lens' DocumentVersionInfo (Maybe UTCTime)

The date the document was created.

documentVersionInfo_displayName :: Lens' DocumentVersionInfo (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.

documentVersionInfo_documentFormat :: Lens' DocumentVersionInfo (Maybe DocumentFormat)

The document format, either JSON or YAML.

documentVersionInfo_documentVersion :: Lens' DocumentVersionInfo (Maybe Text)

The document version.

documentVersionInfo_isDefaultVersion :: Lens' DocumentVersionInfo (Maybe Bool)

An identifier for the default version of the document.

documentVersionInfo_name :: Lens' DocumentVersionInfo (Maybe Text)

The document name.

documentVersionInfo_reviewStatus :: Lens' DocumentVersionInfo (Maybe ReviewStatus)

The current status of the approval review for the latest version of the document.

documentVersionInfo_status :: Lens' DocumentVersionInfo (Maybe DocumentStatus)

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

documentVersionInfo_statusInformation :: Lens' DocumentVersionInfo (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."

documentVersionInfo_versionName :: Lens' DocumentVersionInfo (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.