Skip to content

UpdateGlobalSecondaryIndexAction

Source code in docs_src/capo_dynamodb/types/update_global_secondary_index_action.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class UpdateGlobalSecondaryIndexAction(TypedDict, closed=True):
    index_name: "capo_dynamodb.types.index_name.IndexName"
    """<p>The name of the global secondary index to be updated.</p>"""
    provisioned_throughput: NotRequired[
        "capo_dynamodb.types.provisioned_throughput.ProvisionedThroughput"
    ]
    """<p>Represents the provisioned throughput settings for the specified global secondary index.</p> <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"""
    on_demand_throughput: NotRequired[
        "capo_dynamodb.types.on_demand_throughput.OnDemandThroughput"
    ]
    """<p>Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify <code>MaxReadRequestUnits</code>, <code>MaxWriteRequestUnits</code>, or both.</p>"""
    warm_throughput: NotRequired["capo_dynamodb.types.warm_throughput.WarmThroughput"]
    """<p>Represents the warm throughput value of the new provisioned throughput settings to be applied to a global secondary index.</p>"""

index_name instance-attribute 

index_name: IndexName

The name of the global secondary index to be updated.

on_demand_throughput instance-attribute 

on_demand_throughput: NotRequired[OnDemandThroughput]

Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

provisioned_throughput instance-attribute 

provisioned_throughput: NotRequired[ProvisionedThroughput]

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

warm_throughput instance-attribute 

warm_throughput: NotRequired[WarmThroughput]

Represents the warm throughput value of the new provisioned throughput settings to be applied to a global secondary index.