DescribeServiceUpdates - Amazon MemoryDB
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

DescribeServiceUpdates

Returns details of the service updates

Request Syntax

{
   "ClusterNames": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "ServiceUpdateName": "string",
   "Status": [ "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 list of cluster names to identify service updates to apply

Type: Array of strings

Array Members: Maximum number of 20 items.

Required: No

MaxResults

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Type: Integer

Required: No

NextToken

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Type: String

Required: No

ServiceUpdateName

The unique ID of the service update to describe.

Type: String

Required: No

Status

The status(es) of the service updates to filter on

Type: Array of strings

Array Members: Maximum number of 4 items.

Valid Values: available | in-progress | complete | scheduled

Required: No

Response Syntax

{
   "NextToken": "string",
   "ServiceUpdates": [ 
      { 
         "AutoUpdateStartDate": number,
         "ClusterName": "string",
         "Description": "string",
         "NodesUpdated": "string",
         "ReleaseDate": number,
         "ServiceUpdateName": "string",
         "Status": "string",
         "Type": "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.

NextToken

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Type: String

ServiceUpdates

A list of service updates

Type: Array of ServiceUpdate objects

Errors

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

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: