Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

BatchUpdateCluster

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

Request Syntax


{
   "ClusterNames": [ "string" ],
   "ServiceUpdate": { 
      "ServiceUpdateNameToApply": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterNames

The cluster names to apply the updates.

Type: Array of strings

Array Members: Maximum number of 20 items.

Required: Yes

ServiceUpdate

The unique ID of the service update

Type: ServiceUpdateRequest object

Required: No

Response Syntax


{
   "ProcessedClusters": [ 
      { 
         "ACLName": "string",
         "ARN": "string",
         "AutoMinorVersionUpgrade": boolean,
         "AvailabilityMode": "string",
         "ClusterEndpoint": { 
            "Address": "string",
            "Port": number
         },
         "DataTiering": "string",
         "Description": "string",
         "EnginePatchVersion": "string",
         "EngineVersion": "string",
         "KmsKeyId": "string",
         "MaintenanceWindow": "string",
         "Name": "string",
         "NodeType": "string",
         "NumberOfShards": number,
         "ParameterGroupName": "string",
         "ParameterGroupStatus": "string",
         "PendingUpdates": { 
            "ACLs": { 
               "ACLToApply": "string"
            },
            "Resharding": { 
               "SlotMigration": { 
                  "ProgressPercentage": number
               }
            },
            "ServiceUpdates": [ 
               { 
                  "ServiceUpdateName": "string",
                  "Status": "string"
               }
            ]
         },
         "SecurityGroups": [ 
            { 
               "SecurityGroupId": "string",
               "Status": "string"
            }
         ],
         "Shards": [ 
            { 
               "Name": "string",
               "Nodes": [ 
                  { 
                     "AvailabilityZone": "string",
                     "CreateTime": number,
                     "Endpoint": { 
                        "Address": "string",
                        "Port": number
                     },
                     "Name": "string",
                     "Status": "string"
                  }
               ],
               "NumberOfNodes": number,
               "Slots": "string",
               "Status": "string"
            }
         ],
         "SnapshotRetentionLimit": number,
         "SnapshotWindow": "string",
         "SnsTopicArn": "string",
         "SnsTopicStatus": "string",
         "Status": "string",
         "SubnetGroupName": "string",
         "TLSEnabled": boolean
      }
   ],
   "UnprocessedClusters": [ 
      { 
         "ClusterName": "string",
         "ErrorMessage": "string",
         "ErrorType": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ProcessedClusters

The list of clusters that have been updated.

Type: Array of Cluster objects

UnprocessedClusters

The list of clusters where updates have not been applied.

Type: Array of UnprocessedCluster objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

HTTP Status Code: 400

ServiceUpdateNotFoundFault

HTTP Status Code: 400