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.Types.DocumentVersionInfo

Description

Synopsis

data DocumentVersionInfo = DocumentVersionInfo' {
- status :: Maybe DocumentStatus
- versionName :: Maybe Text
- reviewStatus :: Maybe ReviewStatus
- createdDate :: Maybe POSIX
- documentFormat :: Maybe DocumentFormat
- name :: Maybe Text
- documentVersion :: Maybe Text
- displayName :: Maybe Text
- statusInformation :: Maybe Text
- isDefaultVersion :: Maybe Bool
}
newDocumentVersionInfo :: DocumentVersionInfo
documentVersionInfo_status :: Lens' DocumentVersionInfo (Maybe DocumentStatus)
documentVersionInfo_versionName :: Lens' DocumentVersionInfo (Maybe Text)
documentVersionInfo_reviewStatus :: Lens' DocumentVersionInfo (Maybe ReviewStatus)
documentVersionInfo_createdDate :: Lens' DocumentVersionInfo (Maybe UTCTime)
documentVersionInfo_documentFormat :: Lens' DocumentVersionInfo (Maybe DocumentFormat)
documentVersionInfo_name :: Lens' DocumentVersionInfo (Maybe Text)
documentVersionInfo_documentVersion :: Lens' DocumentVersionInfo (Maybe Text)
documentVersionInfo_displayName :: Lens' DocumentVersionInfo (Maybe Text)
documentVersionInfo_statusInformation :: Lens' DocumentVersionInfo (Maybe Text)
documentVersionInfo_isDefaultVersion :: Lens' DocumentVersionInfo (Maybe Bool)

Documentation

data DocumentVersionInfo Source #

Version information about the document.

See: newDocumentVersionInfo smart constructor.

Constructors

DocumentVersionInfo'

Fields

status :: Maybe DocumentStatus
The status of the SSM document, such as Creating, Active, Failed, and Deleting.
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.
reviewStatus :: Maybe ReviewStatus
The current status of the approval review for the latest version of the document.
createdDate :: Maybe POSIX
The date the document was created.
documentFormat :: Maybe DocumentFormat
The document format, either JSON or YAML.
name :: Maybe Text
The document name.
documentVersion :: Maybe Text
The document version.
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.
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."
isDefaultVersion :: Maybe Bool
An identifier for the default version of the document.

Instances

Instances details

Eq DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo Methods (==) :: DocumentVersionInfo -> DocumentVersionInfo -> Bool # (/=) :: DocumentVersionInfo -> DocumentVersionInfo -> Bool #
Read DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo Methods readsPrec :: Int -> ReadS DocumentVersionInfo # readList :: ReadS [DocumentVersionInfo] # readPrec :: ReadPrec DocumentVersionInfo # readListPrec :: ReadPrec [DocumentVersionInfo] #
Show DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo Methods showsPrec :: Int -> DocumentVersionInfo -> ShowS # show :: DocumentVersionInfo -> String # showList :: [DocumentVersionInfo] -> ShowS #
Generic DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo Associated Types type Rep DocumentVersionInfo :: Type -> Type # Methods from :: DocumentVersionInfo -> Rep DocumentVersionInfo x # to :: Rep DocumentVersionInfo x -> DocumentVersionInfo #
NFData DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo Methods rnf :: DocumentVersionInfo -> () #
Hashable DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo Methods hashWithSalt :: Int -> DocumentVersionInfo -> Int # hash :: DocumentVersionInfo -> Int #
FromJSON DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo Methods parseJSON :: Value -> Parser DocumentVersionInfo # parseJSONList :: Value -> Parser [DocumentVersionInfo] #
type Rep DocumentVersionInfo Source #
Instance details Defined in Amazonka.SSM.Types.DocumentVersionInfo type Rep DocumentVersionInfo = D1 ('MetaData "DocumentVersionInfo" "Amazonka.SSM.Types.DocumentVersionInfo" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DocumentVersionInfo'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentStatus)) :: S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "reviewStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewStatus)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "documentFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentFormat))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "statusInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isDefaultVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newDocumentVersionInfo :: DocumentVersionInfo Source #

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:status:DocumentVersionInfo', documentVersionInfo_status - The status of the SSM document, such as Creating, Active, Failed, and Deleting.

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

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

$sel:createdDate:DocumentVersionInfo', documentVersionInfo_createdDate - The date the document was created.

$sel:documentFormat:DocumentVersionInfo', documentVersionInfo_documentFormat - The document format, either JSON or YAML.

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

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

$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: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:isDefaultVersion:DocumentVersionInfo', documentVersionInfo_isDefaultVersion - An identifier for the default version of the document.

documentVersionInfo_status :: Lens' DocumentVersionInfo (Maybe DocumentStatus) Source #

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

documentVersionInfo_versionName :: Lens' DocumentVersionInfo (Maybe Text) Source #

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_reviewStatus :: Lens' DocumentVersionInfo (Maybe ReviewStatus) Source #

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

documentVersionInfo_createdDate :: Lens' DocumentVersionInfo (Maybe UTCTime) Source #

The date the document was created.

documentVersionInfo_documentFormat :: Lens' DocumentVersionInfo (Maybe DocumentFormat) Source #

The document format, either JSON or YAML.

documentVersionInfo_name :: Lens' DocumentVersionInfo (Maybe Text) Source #

The document name.

documentVersionInfo_documentVersion :: Lens' DocumentVersionInfo (Maybe Text) Source #

The document version.

documentVersionInfo_displayName :: Lens' DocumentVersionInfo (Maybe Text) Source #

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_statusInformation :: Lens' DocumentVersionInfo (Maybe Text) Source #

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_isDefaultVersion :: Lens' DocumentVersionInfo (Maybe Bool) Source #

An identifier for the default version of the document.