DynamoDB / Client / describe_global_table_settings

describe_global_table_settings

DynamoDB.Client.describe_global_table_settings(**kwargs)

Describes Region-specific settings for a global table.

Warning

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you’re using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

See also: AWS API Documentation

Request Syntax

response = client.describe_global_table_settings(
    GlobalTableName='string'
)

Parameters:

GlobalTableName (string) –

[REQUIRED]

The name of the global table to describe.

Return type:

dict

Returns:

Response Syntax

{
    'GlobalTableName': 'string',
    'ReplicaSettings': [
        {
            'RegionName': 'string',
            'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS',
            'ReplicaBillingModeSummary': {
                'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
                'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
            },
            'ReplicaProvisionedReadCapacityUnits': 123,
            'ReplicaProvisionedReadCapacityAutoScalingSettings': {
                'MinimumUnits': 123,
                'MaximumUnits': 123,
                'AutoScalingDisabled': True|False,
                'AutoScalingRoleArn': 'string',
                'ScalingPolicies': [
                    {
                        'PolicyName': 'string',
                        'TargetTrackingScalingPolicyConfiguration': {
                            'DisableScaleIn': True|False,
                            'ScaleInCooldown': 123,
                            'ScaleOutCooldown': 123,
                            'TargetValue': 123.0
                        }
                    },
                ]
            },
            'ReplicaProvisionedWriteCapacityUnits': 123,
            'ReplicaProvisionedWriteCapacityAutoScalingSettings': {
                'MinimumUnits': 123,
                'MaximumUnits': 123,
                'AutoScalingDisabled': True|False,
                'AutoScalingRoleArn': 'string',
                'ScalingPolicies': [
                    {
                        'PolicyName': 'string',
                        'TargetTrackingScalingPolicyConfiguration': {
                            'DisableScaleIn': True|False,
                            'ScaleInCooldown': 123,
                            'ScaleOutCooldown': 123,
                            'TargetValue': 123.0
                        }
                    },
                ]
            },
            'ReplicaGlobalSecondaryIndexSettings': [
                {
                    'IndexName': 'string',
                    'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
                    'ProvisionedReadCapacityUnits': 123,
                    'ProvisionedReadCapacityAutoScalingSettings': {
                        'MinimumUnits': 123,
                        'MaximumUnits': 123,
                        'AutoScalingDisabled': True|False,
                        'AutoScalingRoleArn': 'string',
                        'ScalingPolicies': [
                            {
                                'PolicyName': 'string',
                                'TargetTrackingScalingPolicyConfiguration': {
                                    'DisableScaleIn': True|False,
                                    'ScaleInCooldown': 123,
                                    'ScaleOutCooldown': 123,
                                    'TargetValue': 123.0
                                }
                            },
                        ]
                    },
                    'ProvisionedWriteCapacityUnits': 123,
                    'ProvisionedWriteCapacityAutoScalingSettings': {
                        'MinimumUnits': 123,
                        'MaximumUnits': 123,
                        'AutoScalingDisabled': True|False,
                        'AutoScalingRoleArn': 'string',
                        'ScalingPolicies': [
                            {
                                'PolicyName': 'string',
                                'TargetTrackingScalingPolicyConfiguration': {
                                    'DisableScaleIn': True|False,
                                    'ScaleInCooldown': 123,
                                    'ScaleOutCooldown': 123,
                                    'TargetValue': 123.0
                                }
                            },
                        ]
                    }
                },
            ],
            'ReplicaTableClassSummary': {
                'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
                'LastUpdateDateTime': datetime(2015, 1, 1)
            }
        },
    ]
}

Response Structure

• (dict) –

  • GlobalTableName (string) –

    The name of the global table.

  • ReplicaSettings (list) –

    The Region-specific settings for the global table.

    • (dict) –

      Represents the properties of a replica.

      • RegionName (string) –

        The Region name of the replica.

      • ReplicaStatus (string) –

        The current state of the Region:

        • CREATING - The Region is being created.

        • UPDATING - The Region is being updated.

        • DELETING - The Region is being deleted.

        • ACTIVE - The Region is ready for use.

      • ReplicaBillingModeSummary (dict) –

        The read/write capacity mode of the replica.

        • BillingMode (string) –

          Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

          • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

          • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

        • LastUpdateToPayPerRequestDateTime (datetime) –

          Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

      • ReplicaProvisionedReadCapacityUnits (integer) –

        The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

      • ReplicaProvisionedReadCapacityAutoScalingSettings (dict) –

        Auto scaling settings for a global table replica’s read capacity units.

        • MinimumUnits (integer) –

          The minimum capacity units that a global table or global secondary index should be scaled down to.

        • MaximumUnits (integer) –

          The maximum capacity units that a global table or global secondary index should be scaled up to.

        • AutoScalingDisabled (boolean) –

          Disabled auto scaling for this global table or global secondary index.

        • AutoScalingRoleArn (string) –

          Role ARN used for configuring the auto scaling policy.

        • ScalingPolicies (list) –

          Information about the scaling policies.

          • (dict) –

            Represents the properties of the scaling policy.

            • PolicyName (string) –

              The name of the scaling policy.

            • TargetTrackingScalingPolicyConfiguration (dict) –

              Represents a target tracking scaling policy configuration.

              • DisableScaleIn (boolean) –

                Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

              • ScaleInCooldown (integer) –

                The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.

              • ScaleOutCooldown (integer) –

                The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

              • TargetValue (float) –

                The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

      • ReplicaProvisionedWriteCapacityUnits (integer) –

        The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

      • ReplicaProvisionedWriteCapacityAutoScalingSettings (dict) –

        Auto scaling settings for a global table replica’s write capacity units.

        • MinimumUnits (integer) –

          The minimum capacity units that a global table or global secondary index should be scaled down to.

        • MaximumUnits (integer) –

          The maximum capacity units that a global table or global secondary index should be scaled up to.

        • AutoScalingDisabled (boolean) –

          Disabled auto scaling for this global table or global secondary index.

        • AutoScalingRoleArn (string) –

          Role ARN used for configuring the auto scaling policy.

        • ScalingPolicies (list) –

          Information about the scaling policies.

          • (dict) –

            Represents the properties of the scaling policy.

            • PolicyName (string) –

              The name of the scaling policy.

            • TargetTrackingScalingPolicyConfiguration (dict) –

              Represents a target tracking scaling policy configuration.

              • DisableScaleIn (boolean) –

                Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

              • ScaleInCooldown (integer) –

                The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.

              • ScaleOutCooldown (integer) –

                The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

              • TargetValue (float) –

                The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

      • ReplicaGlobalSecondaryIndexSettings (list) –

        Replica global secondary index settings for the global table.

        • (dict) –

          Represents the properties of a global secondary index.

          • IndexName (string) –

            The name of the global secondary index. The name must be unique among all other indexes on this table.

          • IndexStatus (string) –

            The current status of the global secondary index:

            • CREATING - The global secondary index is being created.

            • UPDATING - The global secondary index is being updated.

            • DELETING - The global secondary index is being deleted.

            • ACTIVE - The global secondary index is ready for use.

          • ProvisionedReadCapacityUnits (integer) –

            The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

          • ProvisionedReadCapacityAutoScalingSettings (dict) –

            Auto scaling settings for a global secondary index replica’s read capacity units.

            • MinimumUnits (integer) –

              The minimum capacity units that a global table or global secondary index should be scaled down to.

            • MaximumUnits (integer) –

              The maximum capacity units that a global table or global secondary index should be scaled up to.

            • AutoScalingDisabled (boolean) –

              Disabled auto scaling for this global table or global secondary index.

            • AutoScalingRoleArn (string) –

              Role ARN used for configuring the auto scaling policy.

            • ScalingPolicies (list) –

              Information about the scaling policies.

              • (dict) –

                Represents the properties of the scaling policy.

                • PolicyName (string) –

                  The name of the scaling policy.

                • TargetTrackingScalingPolicyConfiguration (dict) –

                  Represents a target tracking scaling policy configuration.

                  • DisableScaleIn (boolean) –

                    Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

                  • ScaleInCooldown (integer) –

                    The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.

                  • ScaleOutCooldown (integer) –

                    The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

                  • TargetValue (float) –

                    The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

          • ProvisionedWriteCapacityUnits (integer) –

            The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

          • ProvisionedWriteCapacityAutoScalingSettings (dict) –

            Auto scaling settings for a global secondary index replica’s write capacity units.

            • MinimumUnits (integer) –

              The minimum capacity units that a global table or global secondary index should be scaled down to.

            • MaximumUnits (integer) –

              The maximum capacity units that a global table or global secondary index should be scaled up to.

            • AutoScalingDisabled (boolean) –

              Disabled auto scaling for this global table or global secondary index.

            • AutoScalingRoleArn (string) –

              Role ARN used for configuring the auto scaling policy.

            • ScalingPolicies (list) –

              Information about the scaling policies.

              • (dict) –

                Represents the properties of the scaling policy.

                • PolicyName (string) –

                  The name of the scaling policy.

                • TargetTrackingScalingPolicyConfiguration (dict) –

                  Represents a target tracking scaling policy configuration.

                  • DisableScaleIn (boolean) –

                    Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won’t remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

                  • ScaleInCooldown (integer) –

                    The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application’s availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.

                  • ScaleOutCooldown (integer) –

                    The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

                  • TargetValue (float) –

                    The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

      • ReplicaTableClassSummary (dict) –

        Contains details of the table class.

        • TableClass (string) –

          The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

        • LastUpdateDateTime (datetime) –

          The date and time at which the table class was last updated.

Exceptions

• DynamoDB.Client.exceptions.GlobalTableNotFoundException

• DynamoDB.Client.exceptions.InternalServerError