paws.database (version 0.1.11)

dynamodb_describe_global_table: Returns information about the specified global table

Description

Returns information about the specified global table.

This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use describe_table instead.

Usage

dynamodb_describe_global_table(GlobalTableName)

Arguments

GlobalTableName

[required] The name of the global table.

Value

A list with the following syntax:

list(
  GlobalTableDescription = list(
    ReplicationGroup = list(
      list(
        RegionName = "string",
        ReplicaStatus = "CREATING"|"CREATION_FAILED"|"UPDATING"|"DELETING"|"ACTIVE"|"REGION_DISABLED"|"INACCESSIBLE_ENCRYPTION_CREDENTIALS",
        ReplicaStatusDescription = "string",
        ReplicaStatusPercentProgress = "string",
        KMSMasterKeyId = "string",
        ProvisionedThroughputOverride = list(
          ReadCapacityUnits = 123
        ),
        GlobalSecondaryIndexes = list(
          list(
            IndexName = "string",
            ProvisionedThroughputOverride = list(
              ReadCapacityUnits = 123
            )
          )
        ),
        ReplicaInaccessibleDateTime = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    GlobalTableArn = "string",
    CreationDateTime = as.POSIXct(
      "2015-01-01"
    ),
    GlobalTableStatus = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING",
    GlobalTableName = "string"
  )
)

Request syntax

svc$describe_global_table(
  GlobalTableName = "string"
)