Backup / Client / update_tiering_configuration

update_tiering_configuration

Backup.Client.update_tiering_configuration(**kwargs)

This request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created.

ResourceSelection can contain:

  • Resources

  • TieringDownSettingsInDays

  • ResourceType

See also: AWS API Documentation

Request Syntax

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

  • TieringConfigurationName (string) –

    [REQUIRED]

    The name of a tiering configuration to update.

  • TieringConfiguration (dict) –

    [REQUIRED]

    Specifies the body of a tiering configuration.

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

    • BackupVaultName (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • TieringConfigurationArn (string) –

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

    • TieringConfigurationName (string) –

      This unique string is the name of the tiering configuration.

    • 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