Skip to main content

List AWS Protection policies​

API to list AWS protection policies

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
  • sort_by string

    Default value: name

    Specifies the policy property by which the results should be sorted.
    Allowed values:

    • name, frequency-type
  • sort_order string

    Default value: asc

    Specifies the order in which the results should be sorted.
    Allowed values:

    • asc, desc
  • name string

    Name of the protection policy.
    Constraints: It must begin with a letter and may include only letters, numbers, and hyphens.

Header Parameters
  • Range string

    Default value: items=1-100

    Filter to specify the page range for paginated results. Format: items=startIndex-endIndex.

Responses

OK

Schema array
  • accountId int64

    Cloud Rewind account ID.

  • projectId string

    Cloud Rewind project ID.

  • id int64

    Unique identifier for the protection policy

  • name string

    Name of the protection policy

  • description string

    Description of the protection policy

  • frequencyType string

    AWS resource type for the protection policy

  • timeZone string

    Time zone for the protection policy schedule

  • frequencyDetails object

    Details about the frequency configuration of the policy template

  • daysOfWeek string[]

    Days of the week

  • months string[]

    Months of the year

  • daysOfMonth int32[]

    Days of the month

  • hours int32[]

    Hours of the day

  • offset int32

    Delays the defined scheduled execution time (in minutes)

  • status string

    Possible values: [enabled, disabled, paused, error, schedule-create-failed, delete-pending, delete-in-progress, delete-snapshots, delete-resources, delete-failed]

    Status of the policy.

    ValueDescription
    enabledThe policy is enabled.
    disabledThe policy is disabled.
    pausedThe policy is paused.
    errorThe policy is in error state.
    schedule-create-failedThe policy scheduler creation failed.
    delete-pendingThe policy delete process is pending.
    delete-in-progressThe policy delete process is in progress.
    delete-snapshotsThe policy delete process is deleting snapshots.
    delete-resourcesThe policy delete process is deleting resources.
    delete-failedThe policy delete process failed.
  • createdAt date-time

    Timestamp indicating when the protection policy was created

  • retentionCount int32

    Number of backups to retain

  • updatedAt date-time

    Timestamp indicating when the protection policy was last updated

Loading...