Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.UpdateDocument

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates one or more values for an SSM document.

Synopsis

data UpdateDocument = UpdateDocument' {
- attachments :: Maybe [AttachmentsSource]
- displayName :: Maybe Text
- documentFormat :: Maybe DocumentFormat
- documentVersion :: Maybe Text
- targetType :: Maybe Text
- versionName :: Maybe Text
- content :: Text
- name :: Text
}
newUpdateDocument :: Text -> Text -> UpdateDocument
updateDocument_attachments :: Lens' UpdateDocument (Maybe [AttachmentsSource])
updateDocument_displayName :: Lens' UpdateDocument (Maybe Text)
updateDocument_documentFormat :: Lens' UpdateDocument (Maybe DocumentFormat)
updateDocument_documentVersion :: Lens' UpdateDocument (Maybe Text)
updateDocument_targetType :: Lens' UpdateDocument (Maybe Text)
updateDocument_versionName :: Lens' UpdateDocument (Maybe Text)
updateDocument_content :: Lens' UpdateDocument Text
updateDocument_name :: Lens' UpdateDocument Text
data UpdateDocumentResponse = UpdateDocumentResponse' {
- documentDescription :: Maybe DocumentDescription
- httpStatus :: Int
}
newUpdateDocumentResponse :: Int -> UpdateDocumentResponse
updateDocumentResponse_documentDescription :: Lens' UpdateDocumentResponse (Maybe DocumentDescription)
updateDocumentResponse_httpStatus :: Lens' UpdateDocumentResponse Int

Creating a Request

data UpdateDocument Source #

See: newUpdateDocument smart constructor.

Constructors

UpdateDocument'

Fields

attachments :: Maybe [AttachmentsSource]
A list of key-value pairs that describe attachments to a version of a document.
displayName :: Maybe Text
The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.
documentFormat :: Maybe DocumentFormat
Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
documentVersion :: Maybe Text
The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.
If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.
targetType :: Maybe Text
Specify a new target type for the document.
versionName :: Maybe Text
An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
content :: Text
A valid JSON or YAML string.
name :: Text
The name of the SSM document that you want to update.

Instances

Instances details

ToJSON UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods toJSON :: UpdateDocument -> Value # toEncoding :: UpdateDocument -> Encoding # toJSONList :: [UpdateDocument] -> Value # toEncodingList :: [UpdateDocument] -> Encoding #
ToHeaders UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods toHeaders :: UpdateDocument -> [Header] #
ToPath UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods toPath :: UpdateDocument -> ByteString #
ToQuery UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods toQuery :: UpdateDocument -> QueryString #
AWSRequest UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Associated Types type AWSResponse UpdateDocument # Methods request :: (Service -> Service) -> UpdateDocument -> Request UpdateDocument # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDocument -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDocument))) #
Generic UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Associated Types type Rep UpdateDocument :: Type -> Type # Methods from :: UpdateDocument -> Rep UpdateDocument x # to :: Rep UpdateDocument x -> UpdateDocument #
Read UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods readsPrec :: Int -> ReadS UpdateDocument # readList :: ReadS [UpdateDocument] # readPrec :: ReadPrec UpdateDocument # readListPrec :: ReadPrec [UpdateDocument] #
Show UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods showsPrec :: Int -> UpdateDocument -> ShowS # show :: UpdateDocument -> String # showList :: [UpdateDocument] -> ShowS #
NFData UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods rnf :: UpdateDocument -> () #
Eq UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods (==) :: UpdateDocument -> UpdateDocument -> Bool # (/=) :: UpdateDocument -> UpdateDocument -> Bool #
Hashable UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods hashWithSalt :: Int -> UpdateDocument -> Int # hash :: UpdateDocument -> Int #
type AWSResponse UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument type AWSResponse UpdateDocument = UpdateDocumentResponse
type Rep UpdateDocument Source #
Instance details Defined in Amazonka.SSM.UpdateDocument type Rep UpdateDocument = D1 ('MetaData "UpdateDocument" "Amazonka.SSM.UpdateDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdateDocument'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttachmentsSource])) :: 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 "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateDocument Source #

Arguments

:: Text	`UpdateDocument`
-> Text	`UpdateDocument`
-> UpdateDocument

Create a value of UpdateDocument 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:attachments:UpdateDocument', updateDocument_attachments - A list of key-value pairs that describe attachments to a version of a document.

UpdateDocument, updateDocument_displayName - The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

UpdateDocument, updateDocument_documentFormat - Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

UpdateDocument, updateDocument_documentVersion - The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

UpdateDocument, updateDocument_targetType - Specify a new target type for the document.

UpdateDocument, updateDocument_versionName - An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

UpdateDocument, updateDocument_content - A valid JSON or YAML string.

UpdateDocument, updateDocument_name - The name of the SSM document that you want to update.

Request Lenses

updateDocument_attachments :: Lens' UpdateDocument (Maybe [AttachmentsSource]) Source #

A list of key-value pairs that describe attachments to a version of a document.

updateDocument_displayName :: Lens' UpdateDocument (Maybe Text) Source #

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

updateDocument_documentFormat :: Lens' UpdateDocument (Maybe DocumentFormat) Source #

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

updateDocument_documentVersion :: Lens' UpdateDocument (Maybe Text) Source #

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

updateDocument_targetType :: Lens' UpdateDocument (Maybe Text) Source #

Specify a new target type for the document.

updateDocument_versionName :: Lens' UpdateDocument (Maybe Text) Source #

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

updateDocument_content :: Lens' UpdateDocument Text Source #

A valid JSON or YAML string.

updateDocument_name :: Lens' UpdateDocument Text Source #

The name of the SSM document that you want to update.

Destructuring the Response

data UpdateDocumentResponse Source #

See: newUpdateDocumentResponse smart constructor.

Constructors

UpdateDocumentResponse'
Fields documentDescription :: Maybe DocumentDescription A description of the document that was updated. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Associated Types type Rep UpdateDocumentResponse :: Type -> Type # Methods from :: UpdateDocumentResponse -> Rep UpdateDocumentResponse x # to :: Rep UpdateDocumentResponse x -> UpdateDocumentResponse #
Read UpdateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods readsPrec :: Int -> ReadS UpdateDocumentResponse # readList :: ReadS [UpdateDocumentResponse] # readPrec :: ReadPrec UpdateDocumentResponse # readListPrec :: ReadPrec [UpdateDocumentResponse] #
Show UpdateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods showsPrec :: Int -> UpdateDocumentResponse -> ShowS # show :: UpdateDocumentResponse -> String # showList :: [UpdateDocumentResponse] -> ShowS #
NFData UpdateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods rnf :: UpdateDocumentResponse -> () #
Eq UpdateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.UpdateDocument Methods (==) :: UpdateDocumentResponse -> UpdateDocumentResponse -> Bool # (/=) :: UpdateDocumentResponse -> UpdateDocumentResponse -> Bool #
type Rep UpdateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.UpdateDocument type Rep UpdateDocumentResponse = D1 ('MetaData "UpdateDocumentResponse" "Amazonka.SSM.UpdateDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdateDocumentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateDocumentResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDocumentResponse'`
-> UpdateDocumentResponse

Create a value of UpdateDocumentResponse 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:documentDescription:UpdateDocumentResponse', updateDocumentResponse_documentDescription - A description of the document that was updated.

$sel:httpStatus:UpdateDocumentResponse', updateDocumentResponse_httpStatus - The response's http status code.

Response Lenses

updateDocumentResponse_documentDescription :: Lens' UpdateDocumentResponse (Maybe DocumentDescription) Source #

A description of the document that was updated.

updateDocumentResponse_httpStatus :: Lens' UpdateDocumentResponse Int Source #

The response's http status code.