ElastiCache / Client / describe_service_updates

describe_service_updates#

ElastiCache.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',
    ServiceUpdateStatus=[
        'available'|'cancelled'|'expired',
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters:

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

  • ServiceUpdateStatus (list) –

    The status of the service update

    • (string) –

  • MaxRecords (integer) – The maximum number of records to include in the response

  • Marker (string) – An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'ServiceUpdates': [
        {
            'ServiceUpdateName': 'string',
            'ServiceUpdateReleaseDate': datetime(2015, 1, 1),
            'ServiceUpdateEndDate': datetime(2015, 1, 1),
            'ServiceUpdateSeverity': 'critical'|'important'|'medium'|'low',
            'ServiceUpdateRecommendedApplyByDate': datetime(2015, 1, 1),
            'ServiceUpdateStatus': 'available'|'cancelled'|'expired',
            'ServiceUpdateDescription': 'string',
            'ServiceUpdateType': 'security-update',
            'Engine': 'string',
            'EngineVersion': 'string',
            'AutoUpdateAfterRecommendedApplyByDate': True|False,
            'EstimatedUpdateTime': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • ServiceUpdates (list) –

      A list of service updates

      • (dict) –

        An update that you can apply to your Redis clusters.

        • ServiceUpdateName (string) –

          The unique ID of the service update

        • ServiceUpdateReleaseDate (datetime) –

          The date when the service update is initially available

        • ServiceUpdateEndDate (datetime) –

          The date after which the service update is no longer available

        • ServiceUpdateSeverity (string) –

          The severity of the service update

        • ServiceUpdateRecommendedApplyByDate (datetime) –

          The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

        • ServiceUpdateStatus (string) –

          The status of the service update

        • ServiceUpdateDescription (string) –

          Provides details of the service update

        • ServiceUpdateType (string) –

          Reflects the nature of the service update

        • Engine (string) –

          The Elasticache engine to which the update applies. Either Redis or Memcached

        • EngineVersion (string) –

          The Elasticache engine version to which the update applies. Either Redis or Memcached engine version

        • AutoUpdateAfterRecommendedApplyByDate (boolean) –

          Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.

        • EstimatedUpdateTime (string) –

          The estimated length of time the service update will take

Exceptions

  • ElastiCache.Client.exceptions.ServiceUpdateNotFoundFault

  • ElastiCache.Client.exceptions.InvalidParameterValueException

  • ElastiCache.Client.exceptions.InvalidParameterCombinationException