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 |
Updates an association. You can update the association name and version,
the document version, schedule, parameters, and Amazon Simple Storage
Service (Amazon S3) output. When you call UpdateAssociation
, the
system removes all optional parameters from the request and overwrites
the association with null values for those parameters. This is by
design. You must specify all optional parameters in the call, even if
you are not changing the parameters. This includes the Name
parameter.
Before calling this API action, we recommend that you call the
DescribeAssociation API operation and make a note of all optional
parameters required for your UpdateAssociation
call.
In order to call this API operation, your Identity and Access Management
(IAM) user account, group, or role must be configured with permission to
call the DescribeAssociation API operation. If you don't have
permission to call DescribeAssociation
, then you receive the following
error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against
the specified targets. You can add the ApplyOnlyAtCronInterval
parameter to run the association during the next schedule run.
Synopsis
- data UpdateAssociation = UpdateAssociation' {
- alarmConfiguration :: Maybe AlarmConfiguration
- applyOnlyAtCronInterval :: Maybe Bool
- associationName :: Maybe Text
- associationVersion :: Maybe Text
- automationTargetParameterName :: Maybe Text
- calendarNames :: Maybe [Text]
- complianceSeverity :: Maybe AssociationComplianceSeverity
- documentVersion :: Maybe Text
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- name :: Maybe Text
- outputLocation :: Maybe InstanceAssociationOutputLocation
- parameters :: Maybe (Sensitive (HashMap Text [Text]))
- scheduleExpression :: Maybe Text
- scheduleOffset :: Maybe Natural
- syncCompliance :: Maybe AssociationSyncCompliance
- targetLocations :: Maybe (NonEmpty TargetLocation)
- targetMaps :: Maybe [HashMap Text [Text]]
- targets :: Maybe [Target]
- associationId :: Text
- newUpdateAssociation :: Text -> UpdateAssociation
- updateAssociation_alarmConfiguration :: Lens' UpdateAssociation (Maybe AlarmConfiguration)
- updateAssociation_applyOnlyAtCronInterval :: Lens' UpdateAssociation (Maybe Bool)
- updateAssociation_associationName :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_associationVersion :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_automationTargetParameterName :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_calendarNames :: Lens' UpdateAssociation (Maybe [Text])
- updateAssociation_complianceSeverity :: Lens' UpdateAssociation (Maybe AssociationComplianceSeverity)
- updateAssociation_documentVersion :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_maxConcurrency :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_maxErrors :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_name :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_outputLocation :: Lens' UpdateAssociation (Maybe InstanceAssociationOutputLocation)
- updateAssociation_parameters :: Lens' UpdateAssociation (Maybe (HashMap Text [Text]))
- updateAssociation_scheduleExpression :: Lens' UpdateAssociation (Maybe Text)
- updateAssociation_scheduleOffset :: Lens' UpdateAssociation (Maybe Natural)
- updateAssociation_syncCompliance :: Lens' UpdateAssociation (Maybe AssociationSyncCompliance)
- updateAssociation_targetLocations :: Lens' UpdateAssociation (Maybe (NonEmpty TargetLocation))
- updateAssociation_targetMaps :: Lens' UpdateAssociation (Maybe [HashMap Text [Text]])
- updateAssociation_targets :: Lens' UpdateAssociation (Maybe [Target])
- updateAssociation_associationId :: Lens' UpdateAssociation Text
- data UpdateAssociationResponse = UpdateAssociationResponse' {}
- newUpdateAssociationResponse :: Int -> UpdateAssociationResponse
- updateAssociationResponse_associationDescription :: Lens' UpdateAssociationResponse (Maybe AssociationDescription)
- updateAssociationResponse_httpStatus :: Lens' UpdateAssociationResponse Int
Creating a Request
data UpdateAssociation Source #
See: newUpdateAssociation
smart constructor.
UpdateAssociation' | |
|
Instances
Create a value of UpdateAssociation
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:
UpdateAssociation
, updateAssociation_alarmConfiguration
- Undocumented member.
UpdateAssociation
, updateAssociation_applyOnlyAtCronInterval
- By default, when you update an association, the system runs it
immediately after it is updated and then according to the schedule you
specified. Specify this option if you don't want an association to run
immediately after you update it. This parameter isn't supported for
rate expressions.
If you chose this option when you created an association and later you
edit that association or you make changes to the SSM document on which
that association is based (by using the Documents page in the console),
State Manager applies the association at the next specified cron
interval. For example, if you chose the Latest
version of an SSM
document when you created an association and you edit the association by
choosing a different document version on the Documents page, State
Manager applies the association at the next specified cron interval if
you previously selected this option. If this option wasn't selected,
State Manager immediately runs the association.
You can reset this option. To do so, specify the
no-apply-only-at-cron-interval
parameter when you update the
association from the command line. This parameter forces the association
to run immediately after updating it and according to the interval
specified.
UpdateAssociation
, updateAssociation_associationName
- The name of the association that you want to update.
UpdateAssociation
, updateAssociation_associationVersion
- This parameter is provided for concurrency control purposes. You must
specify the latest association version in the service. If you want to
ensure that this request succeeds, either specify $LATEST
, or omit
this parameter.
UpdateAssociation
, updateAssociation_automationTargetParameterName
- Choose the parameter that will define how your automation will branch
out. This target is required for associations that use an Automation
runbook and target resources by using rate controls. Automation is a
capability of Amazon Web Services Systems Manager.
UpdateAssociation
, updateAssociation_calendarNames
- The names or Amazon Resource Names (ARNs) of the Change Calendar type
documents you want to gate your associations under. The associations
only run when that change calendar is open. For more information, see
Amazon Web Services Systems Manager Change Calendar.
UpdateAssociation
, updateAssociation_complianceSeverity
- The severity level to assign to the association.
UpdateAssociation
, updateAssociation_documentVersion
- The document version you want update for the association.
State Manager doesn't support running associations that use a new
version of a document if that document is shared from another account.
State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that
a new version was processed. If you want to run an association using a
new version of a document shared form another account, you must set the
document version to default
.
UpdateAssociation
, updateAssociation_maxConcurrency
- The maximum number of targets allowed to run the association at the same
time. You can specify a number, for example 10, or a percentage of the
target set, for example 10%. The default value is 100%, which means all
targets run the association at the same time.
If a new managed node starts and attempts to run an association while
Systems Manager is running MaxConcurrency
associations, the
association is allowed to run. During the next association interval, the
new managed node will process its association within the limit specified
for MaxConcurrency
.
UpdateAssociation
, updateAssociation_maxErrors
- The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify
either an absolute number of errors, for example 10, or a percentage of
the target set, for example 10%. If you specify 3, for example, the
system stops sending requests when the fourth error is received. If you
specify 0, then the system stops sending requests after the first error
is returned. If you run an association on 50 managed nodes and set
MaxError
to 10%, then the system stops sending the request when the
sixth error is received.
Executions that are already running an association when MaxErrors
is
reached are allowed to complete, but some of these executions may fail
as well. If you need to ensure that there won't be more than max-errors
failed executions, set MaxConcurrency
to 1 so that executions proceed
one at a time.
UpdateAssociation
, updateAssociation_name
- The name of the SSM Command document or Automation runbook that contains
the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:
region
:
account-id
:document/
document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you
created in your account, you only need to specify the document name. For
example, AWS-ApplyPatchBaseline
or My-Document
.
UpdateAssociation
, updateAssociation_outputLocation
- An S3 bucket where you want to store the results of this request.
UpdateAssociation
, updateAssociation_parameters
- The parameters you want to update for the association. If you create a
parameter using Parameter Store, a capability of Amazon Web Services
Systems Manager, you can reference the parameter using
{{ssm:parameter-name}}
.
UpdateAssociation
, updateAssociation_scheduleExpression
- The cron expression used to schedule the association that you want to
update.
UpdateAssociation
, updateAssociation_scheduleOffset
- Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of
cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the
association each Sunday after the second Thursday of the month. For more
information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager
in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system not to run an association
immediately after you create it.
UpdateAssociation
, updateAssociation_syncCompliance
- The mode for generating association compliance. You can specify AUTO
or MANUAL
. In AUTO
mode, the system uses the status of the
association execution to determine the compliance status. If the
association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the
association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter
for the PutComplianceItems API operation. In this case, compliance data
isn't managed by State Manager, a capability of Amazon Web Services
Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
UpdateAssociation
, updateAssociation_targetLocations
- A location is a combination of Amazon Web Services Regions and Amazon
Web Services accounts where you want to run the association. Use this
action to update an association in multiple Regions and multiple
accounts.
UpdateAssociation
, updateAssociation_targetMaps
- A key-value mapping of document parameters to target resources. Both
Targets and TargetMaps can't be specified together.
UpdateAssociation
, updateAssociation_targets
- The targets of the association.
UpdateAssociation
, updateAssociation_associationId
- The ID of the association you want to update.
Request Lenses
updateAssociation_alarmConfiguration :: Lens' UpdateAssociation (Maybe AlarmConfiguration) Source #
Undocumented member.
updateAssociation_applyOnlyAtCronInterval :: Lens' UpdateAssociation (Maybe Bool) Source #
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you
edit that association or you make changes to the SSM document on which
that association is based (by using the Documents page in the console),
State Manager applies the association at the next specified cron
interval. For example, if you chose the Latest
version of an SSM
document when you created an association and you edit the association by
choosing a different document version on the Documents page, State
Manager applies the association at the next specified cron interval if
you previously selected this option. If this option wasn't selected,
State Manager immediately runs the association.
You can reset this option. To do so, specify the
no-apply-only-at-cron-interval
parameter when you update the
association from the command line. This parameter forces the association
to run immediately after updating it and according to the interval
specified.
updateAssociation_associationName :: Lens' UpdateAssociation (Maybe Text) Source #
The name of the association that you want to update.
updateAssociation_associationVersion :: Lens' UpdateAssociation (Maybe Text) Source #
This parameter is provided for concurrency control purposes. You must
specify the latest association version in the service. If you want to
ensure that this request succeeds, either specify $LATEST
, or omit
this parameter.
updateAssociation_automationTargetParameterName :: Lens' UpdateAssociation (Maybe Text) Source #
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
updateAssociation_calendarNames :: Lens' UpdateAssociation (Maybe [Text]) Source #
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.
updateAssociation_complianceSeverity :: Lens' UpdateAssociation (Maybe AssociationComplianceSeverity) Source #
The severity level to assign to the association.
updateAssociation_documentVersion :: Lens' UpdateAssociation (Maybe Text) Source #
The document version you want update for the association.
State Manager doesn't support running associations that use a new
version of a document if that document is shared from another account.
State Manager always runs the default
version of a document if shared
from another account, even though the Systems Manager console shows that
a new version was processed. If you want to run an association using a
new version of a document shared form another account, you must set the
document version to default
.
updateAssociation_maxConcurrency :: Lens' UpdateAssociation (Maybe Text) Source #
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while
Systems Manager is running MaxConcurrency
associations, the
association is allowed to run. During the next association interval, the
new managed node will process its association within the limit specified
for MaxConcurrency
.
updateAssociation_maxErrors :: Lens' UpdateAssociation (Maybe Text) Source #
The number of errors that are allowed before the system stops sending
requests to run the association on additional targets. You can specify
either an absolute number of errors, for example 10, or a percentage of
the target set, for example 10%. If you specify 3, for example, the
system stops sending requests when the fourth error is received. If you
specify 0, then the system stops sending requests after the first error
is returned. If you run an association on 50 managed nodes and set
MaxError
to 10%, then the system stops sending the request when the
sixth error is received.
Executions that are already running an association when MaxErrors
is
reached are allowed to complete, but some of these executions may fail
as well. If you need to ensure that there won't be more than max-errors
failed executions, set MaxConcurrency
to 1 so that executions proceed
one at a time.
updateAssociation_name :: Lens' UpdateAssociation (Maybe Text) Source #
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:
region
:
account-id
:document/
document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For Amazon Web Services-predefined documents and SSM documents you
created in your account, you only need to specify the document name. For
example, AWS-ApplyPatchBaseline
or My-Document
.
updateAssociation_outputLocation :: Lens' UpdateAssociation (Maybe InstanceAssociationOutputLocation) Source #
An S3 bucket where you want to store the results of this request.
updateAssociation_parameters :: Lens' UpdateAssociation (Maybe (HashMap Text [Text])) Source #
The parameters you want to update for the association. If you create a
parameter using Parameter Store, a capability of Amazon Web Services
Systems Manager, you can reference the parameter using
{{ssm:parameter-name}}
.
updateAssociation_scheduleExpression :: Lens' UpdateAssociation (Maybe Text) Source #
The cron expression used to schedule the association that you want to update.
updateAssociation_scheduleOffset :: Lens' UpdateAssociation (Maybe Natural) Source #
Number of days to wait after the scheduled day to run an association.
For example, if you specified a cron schedule of
cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the
association each Sunday after the second Thursday of the month. For more
information about cron schedules for associations, see
Reference: Cron and rate expressions for Systems Manager
in the Amazon Web Services Systems Manager User Guide.
To use offsets, you must specify the ApplyOnlyAtCronInterval
parameter. This option tells the system not to run an association
immediately after you create it.
updateAssociation_syncCompliance :: Lens' UpdateAssociation (Maybe AssociationSyncCompliance) Source #
The mode for generating association compliance. You can specify AUTO
or MANUAL
. In AUTO
mode, the system uses the status of the
association execution to determine the compliance status. If the
association execution runs successfully, then the association is
COMPLIANT
. If the association execution doesn't run successfully, the
association is NON-COMPLIANT
.
In MANUAL
mode, you must specify the AssociationId
as a parameter
for the PutComplianceItems API operation. In this case, compliance data
isn't managed by State Manager, a capability of Amazon Web Services
Systems Manager. It is managed by your direct call to the
PutComplianceItems API operation.
By default, all associations use AUTO
mode.
updateAssociation_targetLocations :: Lens' UpdateAssociation (Maybe (NonEmpty TargetLocation)) Source #
A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
updateAssociation_targetMaps :: Lens' UpdateAssociation (Maybe [HashMap Text [Text]]) Source #
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
updateAssociation_targets :: Lens' UpdateAssociation (Maybe [Target]) Source #
The targets of the association.
updateAssociation_associationId :: Lens' UpdateAssociation Text Source #
The ID of the association you want to update.
Destructuring the Response
data UpdateAssociationResponse Source #
See: newUpdateAssociationResponse
smart constructor.
UpdateAssociationResponse' | |
|
Instances
newUpdateAssociationResponse Source #
Create a value of UpdateAssociationResponse
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:associationDescription:UpdateAssociationResponse'
, updateAssociationResponse_associationDescription
- The description of the association that was updated.
$sel:httpStatus:UpdateAssociationResponse'
, updateAssociationResponse_httpStatus
- The response's http status code.
Response Lenses
updateAssociationResponse_associationDescription :: Lens' UpdateAssociationResponse (Maybe AssociationDescription) Source #
The description of the association that was updated.
updateAssociationResponse_httpStatus :: Lens' UpdateAssociationResponse Int Source #
The response's http status code.