Backup / Client / get_tiering_configuration

get_tiering_configuration

Backup.Client.get_tiering_configuration(**kwargs)

Returns TieringConfiguration details for the specified TieringConfigurationName. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.

See also: AWS API Documentation

Request Syntax

response = client.get_tiering_configuration(
    TieringConfigurationName='string'
)
Parameters:

TieringConfigurationName (string) –

[REQUIRED]

The unique name of a tiering configuration.

Return type:

dict

Returns:

Response Syntax

{
    'TieringConfiguration': {
        'TieringConfigurationName': 'string',
        'TieringConfigurationArn': 'string',
        'BackupVaultName': 'string',
        'ResourceSelection': [
            {
                'Resources': [
                    'string',
                ],
                'TieringDownSettingsInDays': 123,
                'ResourceType': 'string'
            },
        ],
        'CreatorRequestId': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • TieringConfiguration (dict) –

      Specifies the body of a tiering configuration. Includes TieringConfigurationName.

      • TieringConfigurationName (string) –

        The unique name of the tiering configuration. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

      • TieringConfigurationArn (string) –

        An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.

      • BackupVaultName (string) –

        The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults.

      • ResourceSelection (list) –

        An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.

        • (dict) –

          This contains metadata about resource selection for tiering configurations.

          You can specify up to 5 different resource selections per tiering configuration. Data moved to lower-cost tier remains there until deletion (one-way transition).

          • Resources (list) –

            An array of strings that either contains ARNs of the associated resources or contains a wildcard * to specify all resources. You can specify up to 100 specific resources per tiering configuration.

            • (string) –

          • TieringDownSettingsInDays (integer) –

            The number of days after creation within a backup vault that an object can transition to the low cost warm storage tier. Must be a positive integer between 60 and 36500 days.

          • ResourceType (string) –

            The type of Amazon Web Services resource; for example, S3 for Amazon S3. For tiering configurations, this is currently limited to S3.

      • CreatorRequestId (string) –

        This is a unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

      • CreationTime (datetime) –

        The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.

      • LastUpdatedTime (datetime) –

        The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of LastUpdatedTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.

Exceptions