Get AWS Protection List
API to get the list of AWS protections for a specific cloud assembly.
Path Parameters
- accountId int64 required
Cloud Rewind account ID.
- projectId string required
Cloud Rewind project ID.
- cloudAssemblyId int64 required
AWS cloud assembly ID.
Query Parameters
- start_time int64 required
Start time to filter protections. Format: Epoch/Unix Timestamp in milli seconds.
- end_time int64 required
End time to filter protections. Format: Epoch/Unix Timestamp in milli seconds.
Header Parameters
- Range string
Default value:
items=1-100
Filter to specify the page range for paginated results. Format: items=startIndex-endIndex.
- 200
- 401
- 403
- 404
- 409
- 412
- 500
OK
- */*
- Schema
- Example (from schema)
Schema array
- id string
Unique identifier for the protection.
- name string
A descriptive name used to identify and manage this protection.
- status string
Possible values: [
created
,preparing
,preparation-completed
,in-progress
,partially-protected
,success
,skipped
,failed
,pruning-failed
,elapsed
]Status of the protection.
Value Description created Indicates the protection was created and initialization is pending. preparing The protection is being prepared, including metadata and resource population. preparation-completed Represents that the resource population phase is completed and the protection is ready to proceed. in-progress Shows that the protection process has started and is currently ongoing. partially-protected Indicates that some associated data or resources are not fully protected. success Indicates that the protection process has completed successfully. skipped Indicates that the protection process was skipped, possibly due to no resources being available. failed Indicates that the protection process has failed. The reason for the failure can be reviewed in the associated error logs. pruning-failed Indicates that the pruning of associated data or metadata has failed. elapsed Indicates that the protection has been pruned or removed, and its associated data and metadata are no longer available. - duration int64
Specifies how long in seconds, the protection was actively running to protect the resources.
- protectionPolicyId int64
Unique identifier for the protection policy.
primaryRegionProtectionDetails object
Defines the details of source-region protection for the protection.
region stringIndicates the AWS region where the (protection or replication) is applied.
status stringPossible values: [
created
,preparing
,preparation-completed
,in-progress
,partially-protected
,success
,skipped
,failed
,pruning-failed
,elapsed
]Status of the (protection or replication) in specific region.
duration int64Specifies how long in seconds, the (protection or replication) was actively running to protect the resources.
crossRegionReplicationDetails object[]
Defines the details of cross-region replication for the protection.
region stringIndicates the AWS region where the (protection or replication) is applied.
status stringPossible values: [
created
,preparing
,preparation-completed
,in-progress
,partially-protected
,success
,skipped
,failed
,pruning-failed
,elapsed
]Status of the (protection or replication) in specific region.
duration int64Specifies how long in seconds, the (protection or replication) was actively running to protect the resources.
- hasRecovery boolean
Indicates whether any recovery has been initiated for this protection.
crossAccountReplicationDetails object[]
Defines the details of cross-account replication for the protection.
region stringIndicates the AWS region where the (protection or replication) is applied.
status stringPossible values: [
created
,preparing
,preparation-completed
,in-progress
,partially-protected
,success
,skipped
,failed
,pruning-failed
,elapsed
]Status of the (protection or replication) in specific region.
duration int64Specifies how long in seconds, the (protection or replication) was actively running to protect the resources.
cloudConnectionId stringIndicates the Cloud connection id where the cross-account replication is configured.
[
{
"id": "string",
"name": "string",
"status": "created",
"duration": 0,
"protectionPolicyId": 0,
"primaryRegionProtectionDetails": {
"region": "string",
"status": "created",
"duration": 0
},
"crossRegionReplicationDetails": [
{
"region": "string",
"status": "created",
"duration": 0
}
],
"hasRecovery": true,
"crossAccountReplicationDetails": [
{
"region": "string",
"status": "created",
"duration": 0,
"cloudConnectionId": "string"
}
]
}
]
Unauthorized
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Forbidden
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Not Found
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Conflict
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Precondition Failed
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}
Internal Server Error
- */*
- Schema
- Example (from schema)
Schema
errors object[]
code stringmessage stringtype stringfieldErrors object
property name*
string- message string
- requiredPermissions string[]
{
"errors": [
{
"code": "string",
"message": "string",
"type": "string"
}
],
"fieldErrors": {},
"message": "string",
"requiredPermissions": [
"string"
]
}