Backup / Client / create_tiering_configuration

create_tiering_configuration

Backup.Client.create_tiering_configuration(**kwargs)

Creates a tiering configuration.

A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault.

Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.

See also: AWS API Documentation

Request Syntax

response = client.create_tiering_configuration(
    TieringConfiguration={
        'TieringConfigurationName': 'string',
        'BackupVaultName': 'string',
        'ResourceSelection': [
            {
                'Resources': [
                    'string',
                ],
                'TieringDownSettingsInDays': 123,
                'ResourceType': 'string'
            },
        ]
    },
    TieringConfigurationTags={
        'string': 'string'
    },
    CreatorRequestId='string'
)
Parameters:

  • TieringConfiguration (dict) –

    [REQUIRED]

    A tiering configuration must contain a unique TieringConfigurationName string you create and must contain a BackupVaultName and ResourceSelection. You may optionally include a CreatorRequestId string.

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

    • TieringConfigurationName (string) – [REQUIRED]

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

    • BackupVaultName (string) – [REQUIRED]

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

    • ResourceSelection (list) – [REQUIRED]

      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) – [REQUIRED]

          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) – [REQUIRED]

          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) – [REQUIRED]

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

  • TieringConfigurationTags (dict) –

    The tags to assign to the tiering configuration.

    • (string) –

      • (string) –

  • 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. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'TieringConfigurationArn': 'string',
    'TieringConfigurationName': 'string',
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • TieringConfigurationArn (string) –

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

    • TieringConfigurationName (string) –

      This unique string is the name of the tiering configuration.

      The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 200.

    • 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.

Exceptions