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 |
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
Synopsis
- data StartChangeRequestExecution = StartChangeRequestExecution' {
- autoApprove :: Maybe Bool
- changeDetails :: Maybe Text
- changeRequestName :: Maybe Text
- clientToken :: Maybe Text
- documentVersion :: Maybe Text
- parameters :: Maybe (HashMap Text [Text])
- scheduledEndTime :: Maybe POSIX
- scheduledTime :: Maybe POSIX
- tags :: Maybe [Tag]
- documentName :: Text
- runbooks :: NonEmpty Runbook
- newStartChangeRequestExecution :: Text -> NonEmpty Runbook -> StartChangeRequestExecution
- startChangeRequestExecution_autoApprove :: Lens' StartChangeRequestExecution (Maybe Bool)
- startChangeRequestExecution_changeDetails :: Lens' StartChangeRequestExecution (Maybe Text)
- startChangeRequestExecution_changeRequestName :: Lens' StartChangeRequestExecution (Maybe Text)
- startChangeRequestExecution_clientToken :: Lens' StartChangeRequestExecution (Maybe Text)
- startChangeRequestExecution_documentVersion :: Lens' StartChangeRequestExecution (Maybe Text)
- startChangeRequestExecution_parameters :: Lens' StartChangeRequestExecution (Maybe (HashMap Text [Text]))
- startChangeRequestExecution_scheduledEndTime :: Lens' StartChangeRequestExecution (Maybe UTCTime)
- startChangeRequestExecution_scheduledTime :: Lens' StartChangeRequestExecution (Maybe UTCTime)
- startChangeRequestExecution_tags :: Lens' StartChangeRequestExecution (Maybe [Tag])
- startChangeRequestExecution_documentName :: Lens' StartChangeRequestExecution Text
- startChangeRequestExecution_runbooks :: Lens' StartChangeRequestExecution (NonEmpty Runbook)
- data StartChangeRequestExecutionResponse = StartChangeRequestExecutionResponse' {}
- newStartChangeRequestExecutionResponse :: Int -> StartChangeRequestExecutionResponse
- startChangeRequestExecutionResponse_automationExecutionId :: Lens' StartChangeRequestExecutionResponse (Maybe Text)
- startChangeRequestExecutionResponse_httpStatus :: Lens' StartChangeRequestExecutionResponse Int
Creating a Request
data StartChangeRequestExecution Source #
See: newStartChangeRequestExecution
smart constructor.
StartChangeRequestExecution' | |
|
Instances
newStartChangeRequestExecution Source #
Create a value of StartChangeRequestExecution
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:autoApprove:StartChangeRequestExecution'
, startChangeRequestExecution_autoApprove
- Indicates whether the change request can be approved automatically
without the need for manual approvals.
If AutoApprovable
is enabled in a change template, then setting
AutoApprove
to true
in StartChangeRequestExecution
creates a
change request that bypasses approver review.
Change Calendar restrictions are not bypassed in this scenario. If the
state of an associated calendar is CLOSED
, change freeze approvers
must still grant permission for this change request to run. If they
don't, the change won't be processed until the calendar state is again
OPEN
.
$sel:changeDetails:StartChangeRequestExecution'
, startChangeRequestExecution_changeDetails
- User-provided details about the change. If no details are provided,
content specified in the Template information section of the
associated change template is added.
StartChangeRequestExecution
, startChangeRequestExecution_changeRequestName
- The name of the change request associated with the runbook workflow to
be run.
$sel:clientToken:StartChangeRequestExecution'
, startChangeRequestExecution_clientToken
- The user-provided idempotency token. The token must be unique, is case
insensitive, enforces the UUID format, and can't be reused.
StartChangeRequestExecution
, startChangeRequestExecution_documentVersion
- The version of the change template document to run during the runbook
workflow.
StartChangeRequestExecution
, startChangeRequestExecution_parameters
- A key-value map of parameters that match the declared parameters in the
change template document.
$sel:scheduledEndTime:StartChangeRequestExecution'
, startChangeRequestExecution_scheduledEndTime
- The time that the requester expects the runbook workflow related to the
change request to complete. The time is an estimate only that the
requester provides for reviewers.
StartChangeRequestExecution
, startChangeRequestExecution_scheduledTime
- The date and time specified in the change request to run the Automation
runbooks.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
StartChangeRequestExecution
, startChangeRequestExecution_tags
- Optional metadata that you assign to a resource. You can specify a
maximum of five tags for a change request. Tags enable you to categorize
a resource in different ways, such as by purpose, owner, or environment.
For example, you might want to tag a change request to identify an
environment or target Amazon Web Services Region. In this case, you
could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
StartChangeRequestExecution
, startChangeRequestExecution_documentName
- The name of the change template document to run during the runbook
workflow.
StartChangeRequestExecution
, startChangeRequestExecution_runbooks
- Information about the Automation runbooks that are run during the
runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Request Lenses
startChangeRequestExecution_autoApprove :: Lens' StartChangeRequestExecution (Maybe Bool) Source #
Indicates whether the change request can be approved automatically without the need for manual approvals.
If AutoApprovable
is enabled in a change template, then setting
AutoApprove
to true
in StartChangeRequestExecution
creates a
change request that bypasses approver review.
Change Calendar restrictions are not bypassed in this scenario. If the
state of an associated calendar is CLOSED
, change freeze approvers
must still grant permission for this change request to run. If they
don't, the change won't be processed until the calendar state is again
OPEN
.
startChangeRequestExecution_changeDetails :: Lens' StartChangeRequestExecution (Maybe Text) Source #
User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.
startChangeRequestExecution_changeRequestName :: Lens' StartChangeRequestExecution (Maybe Text) Source #
The name of the change request associated with the runbook workflow to be run.
startChangeRequestExecution_clientToken :: Lens' StartChangeRequestExecution (Maybe Text) Source #
The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
startChangeRequestExecution_documentVersion :: Lens' StartChangeRequestExecution (Maybe Text) Source #
The version of the change template document to run during the runbook workflow.
startChangeRequestExecution_parameters :: Lens' StartChangeRequestExecution (Maybe (HashMap Text [Text])) Source #
A key-value map of parameters that match the declared parameters in the change template document.
startChangeRequestExecution_scheduledEndTime :: Lens' StartChangeRequestExecution (Maybe UTCTime) Source #
The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.
startChangeRequestExecution_scheduledTime :: Lens' StartChangeRequestExecution (Maybe UTCTime) Source #
The date and time specified in the change request to run the Automation runbooks.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
startChangeRequestExecution_tags :: Lens' StartChangeRequestExecution (Maybe [Tag]) Source #
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
startChangeRequestExecution_documentName :: Lens' StartChangeRequestExecution Text Source #
The name of the change template document to run during the runbook workflow.
startChangeRequestExecution_runbooks :: Lens' StartChangeRequestExecution (NonEmpty Runbook) Source #
Information about the Automation runbooks that are run during the runbook workflow.
The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.
Destructuring the Response
data StartChangeRequestExecutionResponse Source #
See: newStartChangeRequestExecutionResponse
smart constructor.
StartChangeRequestExecutionResponse' | |
|
Instances
Generic StartChangeRequestExecutionResponse Source # | |
Read StartChangeRequestExecutionResponse Source # | |
Show StartChangeRequestExecutionResponse Source # | |
NFData StartChangeRequestExecutionResponse Source # | |
Defined in Amazonka.SSM.StartChangeRequestExecution rnf :: StartChangeRequestExecutionResponse -> () # | |
Eq StartChangeRequestExecutionResponse Source # | |
type Rep StartChangeRequestExecutionResponse Source # | |
Defined in Amazonka.SSM.StartChangeRequestExecution type Rep StartChangeRequestExecutionResponse = D1 ('MetaData "StartChangeRequestExecutionResponse" "Amazonka.SSM.StartChangeRequestExecution" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "StartChangeRequestExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "automationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStartChangeRequestExecutionResponse Source #
Create a value of StartChangeRequestExecutionResponse
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:
StartChangeRequestExecutionResponse
, startChangeRequestExecutionResponse_automationExecutionId
- The unique ID of a runbook workflow operation. (A runbook workflow is a
type of Automation operation.)
$sel:httpStatus:StartChangeRequestExecutionResponse'
, startChangeRequestExecutionResponse_httpStatus
- The response's http status code.
Response Lenses
startChangeRequestExecutionResponse_automationExecutionId :: Lens' StartChangeRequestExecutionResponse (Maybe Text) Source #
The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)
startChangeRequestExecutionResponse_httpStatus :: Lens' StartChangeRequestExecutionResponse Int Source #
The response's http status code.