MemoryDB / Client / describe_service_updates

describe_service_updates#

MemoryDB.Client.describe_service_updates(**kwargs)#

Returns details of the service updates

See also: AWS API Documentation

Request Syntax

response = client.describe_service_updates(
    ServiceUpdateName='string',
    ClusterNames=[
        'string',
    ],
    Status=[
        'available'|'in-progress'|'complete'|'scheduled',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ServiceUpdateName (string) – The unique ID of the service update to describe.

  • ClusterNames (list) –

    The list of cluster names to identify service updates to apply

    • (string) –

  • Status (list) –

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

    • (string) –

  • MaxResults (integer) – 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.

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ServiceUpdates': [
        {
            'ClusterName': 'string',
            'ServiceUpdateName': 'string',
            'ReleaseDate': datetime(2015, 1, 1),
            'Description': 'string',
            'Status': 'available'|'in-progress'|'complete'|'scheduled',
            'Type': 'security-update',
            'Engine': 'string',
            'NodesUpdated': 'string',
            'AutoUpdateStartDate': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      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.

    • ServiceUpdates (list) –

      A list of service updates

      • (dict) –

        An update that you can apply to your MemoryDB clusters.

        • ClusterName (string) –

          The name of the cluster to which the service update applies

        • ServiceUpdateName (string) –

          The unique ID of the service update

        • ReleaseDate (datetime) –

          The date when the service update is initially available

        • Description (string) –

          Provides details of the service update

        • Status (string) –

          The status of the service update

        • Type (string) –

          Reflects the nature of the service update

        • Engine (string) –

          The MemoryDB engine to which the update applies. The values are either Redis or Valkey.

        • NodesUpdated (string) –

          A list of nodes updated by the service update

        • AutoUpdateStartDate (datetime) –

          The date at which the service update will be automatically applied

Exceptions

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException