Amazon Simple Systems Manager (SSM)
    Amazon Simple Systems Manager (SSM)
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST

      /

      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      POST
      /
      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, a user, group, or role must be granted 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>
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
      --header 'X-Amz-Target;' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "AssociationId": "string",
          "Parameters": {
              "property1": [
                  "string"
              ],
              "property2": [
                  "string"
              ]
          },
          "DocumentVersion": "string",
          "ScheduleExpression": "string",
          "OutputLocation": {
              "S3Location": {
                  "OutputS3Region": "string",
                  "OutputS3BucketName": "string",
                  "OutputS3KeyPrefix": "string"
              }
          },
          "Name": "string",
          "Targets": [],
          "AssociationName": "string",
          "AssociationVersion": "string",
          "AutomationTargetParameterName": "string",
          "MaxErrors": "string",
          "MaxConcurrency": "string",
          "ComplianceSeverity": "CRITICAL",
          "SyncCompliance": "AUTO",
          "ApplyOnlyAtCronInterval": true,
          "CalendarNames": [],
          "TargetLocations": [],
          "ScheduleOffset": 0,
          "TargetMaps": [],
          "AlarmConfiguration": {
              "IgnorePollAlarmFailure": true,
              "Alarms": []
          }
      }'
      Response Response Example
      200 - Example 1
      {
          "AssociationDescription": {
              "Name": "string",
              "InstanceId": "string",
              "AssociationVersion": "string",
              "Date": "string",
              "LastUpdateAssociationDate": "string",
              "Status": {
                  "Date": "string",
                  "Name": "Pending",
                  "Message": "string",
                  "AdditionalInfo": "string"
              },
              "Overview": {
                  "Status": "string",
                  "DetailedStatus": "string",
                  "AssociationStatusAggregatedCount": {
                      "property1": 0,
                      "property2": 0
                  }
              },
              "DocumentVersion": "string",
              "AutomationTargetParameterName": "string",
              "Parameters": {
                  "property1": [
                      "string"
                  ],
                  "property2": [
                      "string"
                  ]
              },
              "AssociationId": "string",
              "Targets": [],
              "ScheduleExpression": "string",
              "OutputLocation": {
                  "S3Location": {
                      "OutputS3Region": "string",
                      "OutputS3BucketName": "string",
                      "OutputS3KeyPrefix": "string"
                  }
              },
              "LastExecutionDate": "string",
              "LastSuccessfulExecutionDate": "string",
              "AssociationName": "string",
              "MaxErrors": "string",
              "MaxConcurrency": "string",
              "ComplianceSeverity": "CRITICAL",
              "SyncCompliance": "AUTO",
              "ApplyOnlyAtCronInterval": true,
              "CalendarNames": [],
              "TargetLocations": [],
              "ScheduleOffset": 0,
              "TargetMaps": [],
              "AlarmConfiguration": {
                  "IgnorePollAlarmFailure": true,
                  "Alarms": []
              },
              "TriggeredAlarms": []
          }
      }

      Request

      Header Params

      Body Params application/json

      Examples

      Responses

      🟢200Success
      application/json
      Body

      đźź 480InternalServerError
      đźź 481InvalidSchedule
      đźź 482InvalidParameters
      đźź 483InvalidOutputLocation
      đźź 484InvalidDocumentVersion
      đźź 485AssociationDoesNotExist
      đźź 486InvalidUpdate
      đźź 487TooManyUpdates
      đźź 488InvalidDocument
      đźź 489InvalidTarget
      đźź 490InvalidAssociationVersion
      đźź 491AssociationVersionLimitExceeded
      đźź 492InvalidTargetMaps
      Modified at 2023-08-15 10:32:33
      Previous
      /
      Next
      /
      Built with