2025/11/18 - AWS Backup - 5 new api methods
Changes AWS Backup now supports a low-cost warm storage tier for Amazon S3 backup data.
Returns a list of tiering configurations.
See also: AWS API Documentation
Request Syntax
client.list_tiering_configurations(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of items to be returned.
string
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
dict
Response Syntax
{
'TieringConfigurations': [
{
'TieringConfigurationArn': 'string',
'TieringConfigurationName': 'string',
'BackupVaultName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TieringConfigurations (list) --
An array of tiering configurations returned by the ListTieringConfigurations call.
(dict) --
This contains metadata about a tiering configuration returned in a list.
TieringConfigurationArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.
TieringConfigurationName (string) --
The unique name of the tiering configuration.
BackupVaultName (string) --
The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults.
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.
NextToken (string) --
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
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
client.create_tiering_configuration(
TieringConfiguration={
'TieringConfigurationName': 'string',
'BackupVaultName': 'string',
'ResourceSelection': [
{
'Resources': [
'string',
],
'TieringDownSettingsInDays': 123,
'ResourceType': 'string'
},
]
},
TieringConfigurationTags={
'string': 'string'
},
CreatorRequestId='string'
)
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.
dict
The tags to assign to the tiering configuration.
(string) --
(string) --
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.
dict
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.
Deletes the tiering configuration specified by a tiering configuration name.
See also: AWS API Documentation
Request Syntax
client.delete_tiering_configuration(
TieringConfigurationName='string'
)
string
[REQUIRED]
The unique name of a tiering configuration.
dict
Response Syntax
{}
Response Structure
(dict) --
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
client.get_tiering_configuration(
TieringConfigurationName='string'
)
string
[REQUIRED]
The unique name of a tiering configuration.
dict
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.
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
client.update_tiering_configuration(
TieringConfigurationName='string',
TieringConfiguration={
'ResourceSelection': [
{
'Resources': [
'string',
],
'TieringDownSettingsInDays': 123,
'ResourceType': 'string'
},
],
'BackupVaultName': 'string'
}
)
string
[REQUIRED]
The name of a tiering configuration to update.
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.
dict
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.