list_indexed_recovery_points
async
¶
list_indexed_recovery_points(
*,
config_overrides: Optional[AsyncBackupClientConfig] = None,
next_token: Optional[string] = None,
max_results: Optional[MaxResults] = None,
source_resource_arn: Optional[ARN] = None,
created_before: Optional[timestamp] = None,
created_after: Optional[timestamp] = None,
resource_type: Optional[ResourceType] = None,
index_status: Optional[IndexStatus] = None,
) -> ListIndexedRecoveryPointsOutput
This operation returns a list of recovery points that have an associated index, belonging to the specified account.
Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.
Parameters:
-
next_token(Optional[string], default:None) –The next item following a partial list of returned recovery points.
For example, if a request is made to return
MaxResultsnumber of indexed recovery points,NextTokenallows you to return more items in your list starting at the location pointed to by the next token. -
max_results(Optional[MaxResults], default:None) –The maximum number of resource list items to be returned.
-
source_resource_arn(Optional[ARN], default:None) –A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.
-
created_before(Optional[timestamp], default:None) –Returns only indexed recovery points that were created before the specified date.
-
created_after(Optional[timestamp], default:None) –Returns only indexed recovery points that were created after the specified date.
-
resource_type(Optional[ResourceType], default:None) –Returns a list of indexed recovery points for the specified resource type(s).
Accepted values include:
-
EBSfor Amazon Elastic Block Store -
S3for Amazon Simple Storage Service (Amazon S3)
-
-
index_status(Optional[IndexStatus], default:None) –Include this parameter to filter the returned list by the indicated statuses.
Accepted values:
PENDING|ACTIVE|FAILED|DELETINGA recovery point with an index that has the status of
ACTIVEcan be included in a search.
Raises:
-
InvalidParameterValueException–Indicates that something is wrong with a parameter's value. For example, the value is out of range.
-
ResourceNotFoundException–A resource that is required for the action doesn't exist.
-
ServiceUnavailableException–The request failed due to a temporary failure of the server.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_backup/_services/async_backup.py
5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 | |