AWS API Changes

2024/01/19 - Amazon DynamoDB - 1 new3 updated api methods

Changes This release adds support for including ApproximateCreationDateTimePrecision configurations in EnableKinesisStreamingDestination API, adds the same as an optional field in the response of DescribeKinesisStreamingDestination, and adds support for a new UpdateKinesisStreamingDestination API.

UpdateKinesisStreamingDestination (new)

Link ¶

The command to update the Kinesis stream destination.

See also: AWS API Documentation

Request Syntax

client.update_kinesis_streaming_destination(
    TableName='string',
    StreamArn='string',
    UpdateKinesisStreamingConfiguration={
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
)

type TableName:

string

param TableName:

[REQUIRED]

The table name for the Kinesis streaming destination input.

type StreamArn:

string

param StreamArn:

[REQUIRED]

The ARN for the Kinesis stream input.

type UpdateKinesisStreamingConfiguration:

dict

param UpdateKinesisStreamingConfiguration:

The command to update the Kinesis stream configuration.

ApproximateCreationDateTimePrecision (string) --

Enables updating the precision of Kinesis data stream timestamp.

rtype:

dict

returns:

Response Syntax

{
    'TableName': 'string',
    'StreamArn': 'string',
    'DestinationStatus': 'ENABLING'|'ACTIVE'|'DISABLING'|'DISABLED'|'ENABLE_FAILED'|'UPDATING',
    'UpdateKinesisStreamingConfiguration': {
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
}

Response Structure

(dict) --
- TableName (string) --
  
  The table name for the Kinesis streaming destination output.
- StreamArn (string) --
  
  The ARN for the Kinesis stream input.
- DestinationStatus (string) --
  
  The status of the attempt to update the Kinesis streaming destination output.
- UpdateKinesisStreamingConfiguration (dict) --
  
  The command to update the Kinesis streaming destination configuration.
  - ApproximateCreationDateTimePrecision (string) --
    
    Enables updating the precision of Kinesis data stream timestamp.

DescribeKinesisStreamingDestination (updated)

Link ¶
Changes (response)

{'KinesisDataStreamDestinations': {'ApproximateCreationDateTimePrecision': 'MILLISECOND '
                                                                           '| '
                                                                           'MICROSECOND',
                                   'DestinationStatus': {'UPDATING'}}}

Returns information about the status of Kinesis streaming.

See also: AWS API Documentation

Request Syntax

client.describe_kinesis_streaming_destination(
    TableName='string'
)

type TableName:

string

param TableName:

[REQUIRED]

The name of the table being described.

rtype:

dict

returns:

Response Syntax

{
    'TableName': 'string',
    'KinesisDataStreamDestinations': [
        {
            'StreamArn': 'string',
            'DestinationStatus': 'ENABLING'|'ACTIVE'|'DISABLING'|'DISABLED'|'ENABLE_FAILED'|'UPDATING',
            'DestinationStatusDescription': 'string',
            'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
        },
    ]
}

Response Structure

(dict) --
- TableName (string) --
  
  The name of the table being described.
- KinesisDataStreamDestinations (list) --
  
  The list of replica structures for the table being described.
  - (dict) --
    
    Describes a Kinesis data stream destination.
    - StreamArn (string) --
      
      The ARN for a specific Kinesis data stream.
    - DestinationStatus (string) --
      
      The current status of replication.
    - DestinationStatusDescription (string) --
      
      The human-readable string that corresponds to the replica status.
    - ApproximateCreationDateTimePrecision (string) --
      
      The precision of the Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.

DisableKinesisStreamingDestination (updated)

Link ¶
Changes (request, response)
Request

{'EnableKinesisStreamingConfiguration': {'ApproximateCreationDateTimePrecision': 'MILLISECOND '
                                                                                 '| '
                                                                                 'MICROSECOND'}}

Response

{'DestinationStatus': {'UPDATING'},
 'EnableKinesisStreamingConfiguration': {'ApproximateCreationDateTimePrecision': 'MILLISECOND '
                                                                                 '| '
                                                                                 'MICROSECOND'}}

Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.

See also: AWS API Documentation

Request Syntax

client.disable_kinesis_streaming_destination(
    TableName='string',
    StreamArn='string',
    EnableKinesisStreamingConfiguration={
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
)

type TableName:

string

param TableName:

[REQUIRED]

The name of the DynamoDB table.

type StreamArn:

string

param StreamArn:

[REQUIRED]

The ARN for a Kinesis data stream.

type EnableKinesisStreamingConfiguration:

dict

param EnableKinesisStreamingConfiguration:

The source for the Kinesis streaming information that is being enabled.

ApproximateCreationDateTimePrecision (string) --

Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.

rtype:

dict

returns:

Response Syntax

{
    'TableName': 'string',
    'StreamArn': 'string',
    'DestinationStatus': 'ENABLING'|'ACTIVE'|'DISABLING'|'DISABLED'|'ENABLE_FAILED'|'UPDATING',
    'EnableKinesisStreamingConfiguration': {
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
}

Response Structure

(dict) --
- TableName (string) --
  
  The name of the table being modified.
- StreamArn (string) --
  
  The ARN for the specific Kinesis data stream.
- DestinationStatus (string) --
  
  The current status of the replication.
- EnableKinesisStreamingConfiguration (dict) --
  
  The destination for the Kinesis streaming information that is being enabled.
  - ApproximateCreationDateTimePrecision (string) --
    
    Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.

EnableKinesisStreamingDestination (updated)

Link ¶
Changes (request, response)
Request

{'EnableKinesisStreamingConfiguration': {'ApproximateCreationDateTimePrecision': 'MILLISECOND '
                                                                                 '| '
                                                                                 'MICROSECOND'}}

Response

{'DestinationStatus': {'UPDATING'},
 'EnableKinesisStreamingConfiguration': {'ApproximateCreationDateTimePrecision': 'MILLISECOND '
                                                                                 '| '
                                                                                 'MICROSECOND'}}

Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.

See also: AWS API Documentation

Request Syntax

client.enable_kinesis_streaming_destination(
    TableName='string',
    StreamArn='string',
    EnableKinesisStreamingConfiguration={
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
)

type TableName:

string

param TableName:

[REQUIRED]

The name of the DynamoDB table.

type StreamArn:

string

param StreamArn:

[REQUIRED]

The ARN for a Kinesis data stream.

type EnableKinesisStreamingConfiguration:

dict

param EnableKinesisStreamingConfiguration:

The source for the Kinesis streaming information that is being enabled.

ApproximateCreationDateTimePrecision (string) --

Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.

rtype:

dict

returns:

Response Syntax

{
    'TableName': 'string',
    'StreamArn': 'string',
    'DestinationStatus': 'ENABLING'|'ACTIVE'|'DISABLING'|'DISABLED'|'ENABLE_FAILED'|'UPDATING',
    'EnableKinesisStreamingConfiguration': {
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
}

Response Structure

(dict) --
- TableName (string) --
  
  The name of the table being modified.
- StreamArn (string) --
  
  The ARN for the specific Kinesis data stream.
- DestinationStatus (string) --
  
  The current status of the replication.
- EnableKinesisStreamingConfiguration (dict) --
  
  The destination for the Kinesis streaming information that is being enabled.
  - ApproximateCreationDateTimePrecision (string) --
    
    Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.