Backup / Client / list_backup_selections

list_backup_selections

Backup.Client.list_backup_selections(**kwargs)

Returns an array containing metadata of the resources associated with the target backup plan.

See also: AWS API Documentation

Request Syntax

response = client.list_backup_selections(
    BackupPlanId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• BackupPlanId (string) –

  [REQUIRED]

  Uniquely identifies a backup plan.

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

• MaxResults (integer) – The maximum number of items to be returned.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'BackupSelectionsList': [
        {
            'SelectionId': 'string',
            'SelectionName': 'string',
            'BackupPlanId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'CreatorRequestId': 'string',
            'IamRoleArn': 'string'
        },
    ]
}

Response Structure

• (dict) –

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

  • BackupSelectionsList (list) –

    An array of backup selection list items containing metadata about each resource in the list.

    • (dict) –

      Contains metadata about a BackupSelection object.

      • SelectionId (string) –

        Uniquely identifies a request to assign a set of resources to a backup plan.

      • SelectionName (string) –

        The display name of a resource selection document.

      • BackupPlanId (string) –

        Uniquely identifies a backup plan.

      • CreationDate (datetime) –

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

      • CreatorRequestId (string) –

        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.

      • IamRoleArn (string) –

        Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Exceptions

• Backup.Client.exceptions.ResourceNotFoundException

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException