aws-sdk-backup 1.115.0 → 1.117.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +349 -11
- data/lib/aws-sdk-backup/client_api.rb +196 -0
- data/lib/aws-sdk-backup/types.rb +407 -5
- data/lib/aws-sdk-backup.rb +1 -1
- data/sig/client.rbs +81 -2
- data/sig/types.rbs +95 -2
- metadata +1 -1
data/lib/aws-sdk-backup/types.rb
CHANGED
|
@@ -429,7 +429,7 @@ module Aws::Backup
|
|
|
429
429
|
include Aws::Structure
|
|
430
430
|
end
|
|
431
431
|
|
|
432
|
-
# This is a summary of jobs created or running within the most recent
|
|
432
|
+
# This is a summary of jobs created or running within the most recent 14
|
|
433
433
|
# days.
|
|
434
434
|
#
|
|
435
435
|
# The returned summary may contain the following: Region, Account,
|
|
@@ -1162,6 +1162,8 @@ module Aws::Backup
|
|
|
1162
1162
|
#
|
|
1163
1163
|
# @!attribute [rw] number_of_recovery_points
|
|
1164
1164
|
# The number of recovery points that are stored in a backup vault.
|
|
1165
|
+
# Recovery point count value displayed in the console can be an
|
|
1166
|
+
# approximation.
|
|
1165
1167
|
# @return [Integer]
|
|
1166
1168
|
#
|
|
1167
1169
|
# @!attribute [rw] locked
|
|
@@ -1756,7 +1758,7 @@ module Aws::Backup
|
|
|
1756
1758
|
end
|
|
1757
1759
|
|
|
1758
1760
|
# This is a summary of copy jobs created or running within the most
|
|
1759
|
-
# recent
|
|
1761
|
+
# recent 14 days.
|
|
1760
1762
|
#
|
|
1761
1763
|
# The returned summary may contain the following: Region, Account,
|
|
1762
1764
|
# State, RestourceType, MessageCategory, StartTime, EndTime, and Count
|
|
@@ -1832,6 +1834,85 @@ module Aws::Backup
|
|
|
1832
1834
|
include Aws::Structure
|
|
1833
1835
|
end
|
|
1834
1836
|
|
|
1837
|
+
# @!attribute [rw] access_point_metadata
|
|
1838
|
+
# Metadata for the backup access point. For continuous (point-in-time)
|
|
1839
|
+
# recovery points, you must include an `AccessPointInTime` timestamp
|
|
1840
|
+
# (in format `2021-11-27T03:30:27Z`). The access point provides access
|
|
1841
|
+
# to the content present in the backup at that specific time. You can
|
|
1842
|
+
# specify any time within the continuous backup's retention period,
|
|
1843
|
+
# up to the latest restorable time. For snapshot recovery points, do
|
|
1844
|
+
# not include `AccessPointInTime`.
|
|
1845
|
+
# @return [Hash<String,String>]
|
|
1846
|
+
#
|
|
1847
|
+
# @!attribute [rw] access_point_policy
|
|
1848
|
+
# An optional resource-based policy, in JSON format, to apply to the
|
|
1849
|
+
# underlying Amazon S3 access point. The policy controls how backup
|
|
1850
|
+
# data can be accessed through the access point. If you do not specify
|
|
1851
|
+
# a policy, access is governed by the caller's IAM permissions. For
|
|
1852
|
+
# more information, see [Configuring IAM policies for using access
|
|
1853
|
+
# points][1] in the *Amazon S3 User Guide*.
|
|
1854
|
+
#
|
|
1855
|
+
#
|
|
1856
|
+
#
|
|
1857
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html
|
|
1858
|
+
# @return [String]
|
|
1859
|
+
#
|
|
1860
|
+
# @!attribute [rw] name
|
|
1861
|
+
# The name of the backup access point. This name is shared with the
|
|
1862
|
+
# Amazon S3 access point namespace. It must be unique within your
|
|
1863
|
+
# account and Region and cannot conflict with an existing Amazon S3
|
|
1864
|
+
# access point. For more information about access point naming, see
|
|
1865
|
+
# [Access points naming rules, restrictions, and limitations][1] in
|
|
1866
|
+
# the *Amazon S3 User Guide*.
|
|
1867
|
+
#
|
|
1868
|
+
#
|
|
1869
|
+
#
|
|
1870
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-restrictions-limitations-naming-rules.html
|
|
1871
|
+
# @return [String]
|
|
1872
|
+
#
|
|
1873
|
+
# @!attribute [rw] recovery_point_arn
|
|
1874
|
+
# The Amazon Resource Name (ARN) of the recovery point for which to
|
|
1875
|
+
# create the backup access point. The recovery point must be an Amazon
|
|
1876
|
+
# S3 recovery point in the `AVAILABLE`, `STOPPED`, or `COMPLETED`
|
|
1877
|
+
# state.
|
|
1878
|
+
# @return [String]
|
|
1879
|
+
#
|
|
1880
|
+
# @!attribute [rw] tags
|
|
1881
|
+
# The tags to assign to the backup access point.
|
|
1882
|
+
# @return [Hash<String,String>]
|
|
1883
|
+
#
|
|
1884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupAccessPointRequest AWS API Documentation
|
|
1885
|
+
#
|
|
1886
|
+
class CreateBackupAccessPointRequest < Struct.new(
|
|
1887
|
+
:access_point_metadata,
|
|
1888
|
+
:access_point_policy,
|
|
1889
|
+
:name,
|
|
1890
|
+
:recovery_point_arn,
|
|
1891
|
+
:tags)
|
|
1892
|
+
SENSITIVE = [:access_point_metadata, :tags]
|
|
1893
|
+
include Aws::Structure
|
|
1894
|
+
end
|
|
1895
|
+
|
|
1896
|
+
# @!attribute [rw] access_point_arn
|
|
1897
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the created
|
|
1898
|
+
# backup access point.
|
|
1899
|
+
# @return [String]
|
|
1900
|
+
#
|
|
1901
|
+
# @!attribute [rw] status
|
|
1902
|
+
# The current status of the backup access point. A newly created
|
|
1903
|
+
# backup access point begins in the `CREATING` state and becomes
|
|
1904
|
+
# usable when it reaches `AVAILABLE`.
|
|
1905
|
+
# @return [String]
|
|
1906
|
+
#
|
|
1907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupAccessPointResponse AWS API Documentation
|
|
1908
|
+
#
|
|
1909
|
+
class CreateBackupAccessPointResponse < Struct.new(
|
|
1910
|
+
:access_point_arn,
|
|
1911
|
+
:status)
|
|
1912
|
+
SENSITIVE = []
|
|
1913
|
+
include Aws::Structure
|
|
1914
|
+
end
|
|
1915
|
+
|
|
1835
1916
|
# @!attribute [rw] backup_plan
|
|
1836
1917
|
# The body of a backup plan. Includes a `BackupPlanName` and one or
|
|
1837
1918
|
# more sets of `Rules`.
|
|
@@ -2645,6 +2726,18 @@ module Aws::Backup
|
|
|
2645
2726
|
include Aws::Structure
|
|
2646
2727
|
end
|
|
2647
2728
|
|
|
2729
|
+
# @!attribute [rw] access_point_arn
|
|
2730
|
+
# The Amazon Resource Name (ARN) of the backup access point to delete.
|
|
2731
|
+
# @return [String]
|
|
2732
|
+
#
|
|
2733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupAccessPointInput AWS API Documentation
|
|
2734
|
+
#
|
|
2735
|
+
class DeleteBackupAccessPointInput < Struct.new(
|
|
2736
|
+
:access_point_arn)
|
|
2737
|
+
SENSITIVE = []
|
|
2738
|
+
include Aws::Structure
|
|
2739
|
+
end
|
|
2740
|
+
|
|
2648
2741
|
# @!attribute [rw] backup_plan_id
|
|
2649
2742
|
# Uniquely identifies a backup plan.
|
|
2650
2743
|
# @return [String]
|
|
@@ -2883,6 +2976,97 @@ module Aws::Backup
|
|
|
2883
2976
|
include Aws::Structure
|
|
2884
2977
|
end
|
|
2885
2978
|
|
|
2979
|
+
# @!attribute [rw] access_point_arn
|
|
2980
|
+
# The Amazon Resource Name (ARN) of the backup access point to
|
|
2981
|
+
# describe.
|
|
2982
|
+
# @return [String]
|
|
2983
|
+
#
|
|
2984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupAccessPointInput AWS API Documentation
|
|
2985
|
+
#
|
|
2986
|
+
class DescribeBackupAccessPointInput < Struct.new(
|
|
2987
|
+
:access_point_arn)
|
|
2988
|
+
SENSITIVE = []
|
|
2989
|
+
include Aws::Structure
|
|
2990
|
+
end
|
|
2991
|
+
|
|
2992
|
+
# @!attribute [rw] access_point_arn
|
|
2993
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the backup
|
|
2994
|
+
# access point.
|
|
2995
|
+
# @return [String]
|
|
2996
|
+
#
|
|
2997
|
+
# @!attribute [rw] access_point_metadata
|
|
2998
|
+
# Metadata for the backup access point. After the backup access point
|
|
2999
|
+
# reaches the `AVAILABLE` status, this map contains `S3AccessPointArn`
|
|
3000
|
+
# and `S3AccessPointAlias`, which you use with standard Amazon S3 read
|
|
3001
|
+
# APIs to access the backup data. For continuous recovery points, this
|
|
3002
|
+
# map also contains `AccessPointInTime` (in format
|
|
3003
|
+
# `2021-11-27T03:30:27Z`). The access point provides access to the
|
|
3004
|
+
# content present in the backup at that specific time.
|
|
3005
|
+
# @return [Hash<String,String>]
|
|
3006
|
+
#
|
|
3007
|
+
# @!attribute [rw] backup_vault_arn
|
|
3008
|
+
# The Amazon Resource Name (ARN) of the backup vault that contains the
|
|
3009
|
+
# recovery point.
|
|
3010
|
+
# @return [String]
|
|
3011
|
+
#
|
|
3012
|
+
# @!attribute [rw] backup_vault_name
|
|
3013
|
+
# The name of the backup vault that contains the recovery point.
|
|
3014
|
+
# @return [String]
|
|
3015
|
+
#
|
|
3016
|
+
# @!attribute [rw] creation_time
|
|
3017
|
+
# The date and time that the backup access point was created, in Unix
|
|
3018
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
3019
|
+
# `CreationTime` is accurate to milliseconds. For example, the value
|
|
3020
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
3021
|
+
# @return [Time]
|
|
3022
|
+
#
|
|
3023
|
+
# @!attribute [rw] name
|
|
3024
|
+
# The name of the backup access point.
|
|
3025
|
+
# @return [String]
|
|
3026
|
+
#
|
|
3027
|
+
# @!attribute [rw] recovery_point_arn
|
|
3028
|
+
# The Amazon Resource Name (ARN) of the recovery point that the backup
|
|
3029
|
+
# access point provides access to.
|
|
3030
|
+
# @return [String]
|
|
3031
|
+
#
|
|
3032
|
+
# @!attribute [rw] resource_arn
|
|
3033
|
+
# The Amazon Resource Name (ARN) of the resource that was backed up,
|
|
3034
|
+
# such as an Amazon S3 bucket.
|
|
3035
|
+
# @return [String]
|
|
3036
|
+
#
|
|
3037
|
+
# @!attribute [rw] resource_type
|
|
3038
|
+
# The type of Amazon Web Services resource associated with the
|
|
3039
|
+
# recovery point. For example, `S3` for Amazon Simple Storage Service.
|
|
3040
|
+
# @return [String]
|
|
3041
|
+
#
|
|
3042
|
+
# @!attribute [rw] status
|
|
3043
|
+
# The current status of the backup access point.
|
|
3044
|
+
# @return [String]
|
|
3045
|
+
#
|
|
3046
|
+
# @!attribute [rw] status_message
|
|
3047
|
+
# A message that provides additional detail about the status of the
|
|
3048
|
+
# backup access point, such as the reason a creation or deletion
|
|
3049
|
+
# attempt failed.
|
|
3050
|
+
# @return [String]
|
|
3051
|
+
#
|
|
3052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupAccessPointResponse AWS API Documentation
|
|
3053
|
+
#
|
|
3054
|
+
class DescribeBackupAccessPointResponse < Struct.new(
|
|
3055
|
+
:access_point_arn,
|
|
3056
|
+
:access_point_metadata,
|
|
3057
|
+
:backup_vault_arn,
|
|
3058
|
+
:backup_vault_name,
|
|
3059
|
+
:creation_time,
|
|
3060
|
+
:name,
|
|
3061
|
+
:recovery_point_arn,
|
|
3062
|
+
:resource_arn,
|
|
3063
|
+
:resource_type,
|
|
3064
|
+
:status,
|
|
3065
|
+
:status_message)
|
|
3066
|
+
SENSITIVE = [:access_point_metadata]
|
|
3067
|
+
include Aws::Structure
|
|
3068
|
+
end
|
|
3069
|
+
|
|
2886
3070
|
# @!attribute [rw] backup_job_id
|
|
2887
3071
|
# Uniquely identifies a request to Backup to back up a resource.
|
|
2888
3072
|
# @return [String]
|
|
@@ -5651,6 +5835,221 @@ module Aws::Backup
|
|
|
5651
5835
|
include Aws::Structure
|
|
5652
5836
|
end
|
|
5653
5837
|
|
|
5838
|
+
# Contains metadata about a backup access point.
|
|
5839
|
+
#
|
|
5840
|
+
# @!attribute [rw] access_point_arn
|
|
5841
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the backup
|
|
5842
|
+
# access point.
|
|
5843
|
+
# @return [String]
|
|
5844
|
+
#
|
|
5845
|
+
# @!attribute [rw] access_point_metadata
|
|
5846
|
+
# Metadata for the backup access point. After the backup access point
|
|
5847
|
+
# reaches the `AVAILABLE` status, this map contains `S3AccessPointArn`
|
|
5848
|
+
# and `S3AccessPointAlias`, which you use with standard Amazon S3 read
|
|
5849
|
+
# APIs to access the backup data. For continuous recovery points, this
|
|
5850
|
+
# map also contains `AccessPointInTime` (in format
|
|
5851
|
+
# `2021-11-27T03:30:27Z`). The access point provides access to the
|
|
5852
|
+
# content present in the backup at that specific time.
|
|
5853
|
+
# @return [Hash<String,String>]
|
|
5854
|
+
#
|
|
5855
|
+
# @!attribute [rw] backup_vault_arn
|
|
5856
|
+
# The Amazon Resource Name (ARN) of the backup vault that contains the
|
|
5857
|
+
# recovery point.
|
|
5858
|
+
# @return [String]
|
|
5859
|
+
#
|
|
5860
|
+
# @!attribute [rw] backup_vault_name
|
|
5861
|
+
# The name of the backup vault that contains the recovery point.
|
|
5862
|
+
# @return [String]
|
|
5863
|
+
#
|
|
5864
|
+
# @!attribute [rw] creation_time
|
|
5865
|
+
# The date and time that the backup access point was created, in Unix
|
|
5866
|
+
# format and Coordinated Universal Time (UTC). The value of
|
|
5867
|
+
# `CreationTime` is accurate to milliseconds. For example, the value
|
|
5868
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
|
5869
|
+
# @return [Time]
|
|
5870
|
+
#
|
|
5871
|
+
# @!attribute [rw] name
|
|
5872
|
+
# The name of the backup access point.
|
|
5873
|
+
# @return [String]
|
|
5874
|
+
#
|
|
5875
|
+
# @!attribute [rw] recovery_point_arn
|
|
5876
|
+
# The Amazon Resource Name (ARN) of the recovery point that the backup
|
|
5877
|
+
# access point provides access to.
|
|
5878
|
+
# @return [String]
|
|
5879
|
+
#
|
|
5880
|
+
# @!attribute [rw] resource_arn
|
|
5881
|
+
# The Amazon Resource Name (ARN) of the resource that was backed up,
|
|
5882
|
+
# such as an Amazon S3 bucket.
|
|
5883
|
+
# @return [String]
|
|
5884
|
+
#
|
|
5885
|
+
# @!attribute [rw] resource_type
|
|
5886
|
+
# The type of Amazon Web Services resource associated with the
|
|
5887
|
+
# recovery point. For example, `S3` for Amazon Simple Storage Service.
|
|
5888
|
+
# @return [String]
|
|
5889
|
+
#
|
|
5890
|
+
# @!attribute [rw] status
|
|
5891
|
+
# The current status of the backup access point.
|
|
5892
|
+
# @return [String]
|
|
5893
|
+
#
|
|
5894
|
+
# @!attribute [rw] status_message
|
|
5895
|
+
# A message that provides additional detail about the status of the
|
|
5896
|
+
# backup access point, such as the reason a creation or deletion
|
|
5897
|
+
# attempt failed.
|
|
5898
|
+
# @return [String]
|
|
5899
|
+
#
|
|
5900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListAccessPointsMember AWS API Documentation
|
|
5901
|
+
#
|
|
5902
|
+
class ListAccessPointsMember < Struct.new(
|
|
5903
|
+
:access_point_arn,
|
|
5904
|
+
:access_point_metadata,
|
|
5905
|
+
:backup_vault_arn,
|
|
5906
|
+
:backup_vault_name,
|
|
5907
|
+
:creation_time,
|
|
5908
|
+
:name,
|
|
5909
|
+
:recovery_point_arn,
|
|
5910
|
+
:resource_arn,
|
|
5911
|
+
:resource_type,
|
|
5912
|
+
:status,
|
|
5913
|
+
:status_message)
|
|
5914
|
+
SENSITIVE = [:access_point_metadata]
|
|
5915
|
+
include Aws::Structure
|
|
5916
|
+
end
|
|
5917
|
+
|
|
5918
|
+
# @!attribute [rw] max_results
|
|
5919
|
+
# The maximum number of items to be returned.
|
|
5920
|
+
# @return [Integer]
|
|
5921
|
+
#
|
|
5922
|
+
# @!attribute [rw] next_token
|
|
5923
|
+
# The next item following a partial list of returned items. For
|
|
5924
|
+
# example, if a request is made to return `MaxResults` number of
|
|
5925
|
+
# items, `NextToken` allows you to return more items in your list
|
|
5926
|
+
# starting at the location pointed to by the next token.
|
|
5927
|
+
# @return [String]
|
|
5928
|
+
#
|
|
5929
|
+
# @!attribute [rw] recovery_point_arn
|
|
5930
|
+
# The Amazon Resource Name (ARN) of the recovery point whose backup
|
|
5931
|
+
# access points you want to list.
|
|
5932
|
+
# @return [String]
|
|
5933
|
+
#
|
|
5934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupAccessPointsByRecoveryPointRequest AWS API Documentation
|
|
5935
|
+
#
|
|
5936
|
+
class ListBackupAccessPointsByRecoveryPointRequest < Struct.new(
|
|
5937
|
+
:max_results,
|
|
5938
|
+
:next_token,
|
|
5939
|
+
:recovery_point_arn)
|
|
5940
|
+
SENSITIVE = []
|
|
5941
|
+
include Aws::Structure
|
|
5942
|
+
end
|
|
5943
|
+
|
|
5944
|
+
# @!attribute [rw] backup_access_points
|
|
5945
|
+
# A list of backup access points, each containing metadata such as its
|
|
5946
|
+
# name, ARN, status, and associated recovery point.
|
|
5947
|
+
# @return [Array<Types::ListAccessPointsMember>]
|
|
5948
|
+
#
|
|
5949
|
+
# @!attribute [rw] next_token
|
|
5950
|
+
# The next item following a partial list of returned items. For
|
|
5951
|
+
# example, if a request is made to return `MaxResults` number of
|
|
5952
|
+
# items, `NextToken` allows you to return more items in your list
|
|
5953
|
+
# starting at the location pointed to by the next token.
|
|
5954
|
+
# @return [String]
|
|
5955
|
+
#
|
|
5956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupAccessPointsByRecoveryPointResponse AWS API Documentation
|
|
5957
|
+
#
|
|
5958
|
+
class ListBackupAccessPointsByRecoveryPointResponse < Struct.new(
|
|
5959
|
+
:backup_access_points,
|
|
5960
|
+
:next_token)
|
|
5961
|
+
SENSITIVE = []
|
|
5962
|
+
include Aws::Structure
|
|
5963
|
+
end
|
|
5964
|
+
|
|
5965
|
+
# @!attribute [rw] max_results
|
|
5966
|
+
# The maximum number of items to be returned.
|
|
5967
|
+
# @return [Integer]
|
|
5968
|
+
#
|
|
5969
|
+
# @!attribute [rw] next_token
|
|
5970
|
+
# The next item following a partial list of returned items. For
|
|
5971
|
+
# example, if a request is made to return `MaxResults` number of
|
|
5972
|
+
# items, `NextToken` allows you to return more items in your list
|
|
5973
|
+
# starting at the location pointed to by the next token.
|
|
5974
|
+
# @return [String]
|
|
5975
|
+
#
|
|
5976
|
+
# @!attribute [rw] resource_arn
|
|
5977
|
+
# The Amazon Resource Name (ARN) of the resource whose backup access
|
|
5978
|
+
# points you want to list.
|
|
5979
|
+
# @return [String]
|
|
5980
|
+
#
|
|
5981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupAccessPointsByResourceRequest AWS API Documentation
|
|
5982
|
+
#
|
|
5983
|
+
class ListBackupAccessPointsByResourceRequest < Struct.new(
|
|
5984
|
+
:max_results,
|
|
5985
|
+
:next_token,
|
|
5986
|
+
:resource_arn)
|
|
5987
|
+
SENSITIVE = []
|
|
5988
|
+
include Aws::Structure
|
|
5989
|
+
end
|
|
5990
|
+
|
|
5991
|
+
# @!attribute [rw] backup_access_points
|
|
5992
|
+
# A list of backup access points, each containing metadata such as its
|
|
5993
|
+
# name, ARN, status, and associated recovery point.
|
|
5994
|
+
# @return [Array<Types::ListAccessPointsMember>]
|
|
5995
|
+
#
|
|
5996
|
+
# @!attribute [rw] next_token
|
|
5997
|
+
# The next item following a partial list of returned items. For
|
|
5998
|
+
# example, if a request is made to return `MaxResults` number of
|
|
5999
|
+
# items, `NextToken` allows you to return more items in your list
|
|
6000
|
+
# starting at the location pointed to by the next token.
|
|
6001
|
+
# @return [String]
|
|
6002
|
+
#
|
|
6003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupAccessPointsByResourceResponse AWS API Documentation
|
|
6004
|
+
#
|
|
6005
|
+
class ListBackupAccessPointsByResourceResponse < Struct.new(
|
|
6006
|
+
:backup_access_points,
|
|
6007
|
+
:next_token)
|
|
6008
|
+
SENSITIVE = []
|
|
6009
|
+
include Aws::Structure
|
|
6010
|
+
end
|
|
6011
|
+
|
|
6012
|
+
# @!attribute [rw] max_results
|
|
6013
|
+
# The maximum number of items to be returned.
|
|
6014
|
+
# @return [Integer]
|
|
6015
|
+
#
|
|
6016
|
+
# @!attribute [rw] next_token
|
|
6017
|
+
# The next item following a partial list of returned items. For
|
|
6018
|
+
# example, if a request is made to return `MaxResults` number of
|
|
6019
|
+
# items, `NextToken` allows you to return more items in your list
|
|
6020
|
+
# starting at the location pointed to by the next token.
|
|
6021
|
+
# @return [String]
|
|
6022
|
+
#
|
|
6023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupAccessPointsRequest AWS API Documentation
|
|
6024
|
+
#
|
|
6025
|
+
class ListBackupAccessPointsRequest < Struct.new(
|
|
6026
|
+
:max_results,
|
|
6027
|
+
:next_token)
|
|
6028
|
+
SENSITIVE = []
|
|
6029
|
+
include Aws::Structure
|
|
6030
|
+
end
|
|
6031
|
+
|
|
6032
|
+
# @!attribute [rw] backup_access_points
|
|
6033
|
+
# A list of backup access points, each containing metadata such as its
|
|
6034
|
+
# name, ARN, status, and associated recovery point.
|
|
6035
|
+
# @return [Array<Types::ListAccessPointsMember>]
|
|
6036
|
+
#
|
|
6037
|
+
# @!attribute [rw] next_token
|
|
6038
|
+
# The next item following a partial list of returned items. For
|
|
6039
|
+
# example, if a request is made to return `MaxResults` number of
|
|
6040
|
+
# items, `NextToken` allows you to return more items in your list
|
|
6041
|
+
# starting at the location pointed to by the next token.
|
|
6042
|
+
# @return [String]
|
|
6043
|
+
#
|
|
6044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupAccessPointsResponse AWS API Documentation
|
|
6045
|
+
#
|
|
6046
|
+
class ListBackupAccessPointsResponse < Struct.new(
|
|
6047
|
+
:backup_access_points,
|
|
6048
|
+
:next_token)
|
|
6049
|
+
SENSITIVE = []
|
|
6050
|
+
include Aws::Structure
|
|
6051
|
+
end
|
|
6052
|
+
|
|
5654
6053
|
# @!attribute [rw] account_id
|
|
5655
6054
|
# Returns the job count for the specified account.
|
|
5656
6055
|
#
|
|
@@ -6934,7 +7333,8 @@ module Aws::Backup
|
|
|
6934
7333
|
# associated with the selected resources that are managed by Backup.
|
|
6935
7334
|
#
|
|
6936
7335
|
# If this is set to `FALSE`, the response will contain all recovery
|
|
6937
|
-
# points associated with the selected resource
|
|
7336
|
+
# points associated with the selected resource, except for EBS
|
|
7337
|
+
# snapshots copied within the same Region and account.
|
|
6938
7338
|
#
|
|
6939
7339
|
# Type: Boolean
|
|
6940
7340
|
# @return [Boolean]
|
|
@@ -8924,7 +9324,7 @@ module Aws::Backup
|
|
|
8924
9324
|
end
|
|
8925
9325
|
|
|
8926
9326
|
# This is a summary of restore jobs created or running within the most
|
|
8927
|
-
# recent
|
|
9327
|
+
# recent 14 days.
|
|
8928
9328
|
#
|
|
8929
9329
|
# The returned summary may contain the following: Region, Account,
|
|
8930
9330
|
# State, ResourceType, MessageCategory, StartTime, EndTime, and Count of
|
|
@@ -9460,7 +9860,9 @@ module Aws::Backup
|
|
|
9460
9860
|
# @return [Array<String>]
|
|
9461
9861
|
#
|
|
9462
9862
|
# @!attribute [rw] selection_window_days
|
|
9463
|
-
# Accepted values are integers from 1 to 365.
|
|
9863
|
+
# Accepted values are integers from 1 to 365. If not included, the
|
|
9864
|
+
# value defaults to 30. The selection window is calculated from the
|
|
9865
|
+
# actual job execution time, not the plan's scheduled start time.
|
|
9464
9866
|
# @return [Integer]
|
|
9465
9867
|
#
|
|
9466
9868
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RestoreTestingRecoveryPointSelection AWS API Documentation
|
data/lib/aws-sdk-backup.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -97,6 +97,21 @@ module Aws
|
|
|
97
97
|
) -> _CancelLegalHoldResponseSuccess
|
|
98
98
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelLegalHoldResponseSuccess
|
|
99
99
|
|
|
100
|
+
interface _CreateBackupAccessPointResponseSuccess
|
|
101
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateBackupAccessPointResponse]
|
|
102
|
+
def access_point_arn: () -> ::String
|
|
103
|
+
def status: () -> ("AVAILABLE" | "CREATING" | "DELETING" | "DISASSOCIATED" | "DISASSOCIATING" | "EXPIRED" | "FAILED")
|
|
104
|
+
end
|
|
105
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#create_backup_access_point-instance_method
|
|
106
|
+
def create_backup_access_point: (
|
|
107
|
+
?access_point_metadata: Hash[::String, ::String],
|
|
108
|
+
?access_point_policy: ::String,
|
|
109
|
+
name: ::String,
|
|
110
|
+
recovery_point_arn: ::String,
|
|
111
|
+
?tags: Hash[::String, ::String]
|
|
112
|
+
) -> _CreateBackupAccessPointResponseSuccess
|
|
113
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBackupAccessPointResponseSuccess
|
|
114
|
+
|
|
100
115
|
interface _CreateBackupPlanResponseSuccess
|
|
101
116
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateBackupPlanOutput]
|
|
102
117
|
def backup_plan_id: () -> ::String
|
|
@@ -353,6 +368,12 @@ module Aws
|
|
|
353
368
|
) -> _CreateTieringConfigurationResponseSuccess
|
|
354
369
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateTieringConfigurationResponseSuccess
|
|
355
370
|
|
|
371
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#delete_backup_access_point-instance_method
|
|
372
|
+
def delete_backup_access_point: (
|
|
373
|
+
access_point_arn: ::String
|
|
374
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
375
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
376
|
+
|
|
356
377
|
interface _DeleteBackupPlanResponseSuccess
|
|
357
378
|
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBackupPlanOutput]
|
|
358
379
|
def backup_plan_id: () -> ::String
|
|
@@ -438,6 +459,26 @@ module Aws
|
|
|
438
459
|
) -> _DeleteTieringConfigurationResponseSuccess
|
|
439
460
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteTieringConfigurationResponseSuccess
|
|
440
461
|
|
|
462
|
+
interface _DescribeBackupAccessPointResponseSuccess
|
|
463
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeBackupAccessPointResponse]
|
|
464
|
+
def access_point_arn: () -> ::String
|
|
465
|
+
def access_point_metadata: () -> ::Hash[::String, ::String]
|
|
466
|
+
def backup_vault_arn: () -> ::String
|
|
467
|
+
def backup_vault_name: () -> ::String
|
|
468
|
+
def creation_time: () -> ::Time
|
|
469
|
+
def name: () -> ::String
|
|
470
|
+
def recovery_point_arn: () -> ::String
|
|
471
|
+
def resource_arn: () -> ::String
|
|
472
|
+
def resource_type: () -> ::String
|
|
473
|
+
def status: () -> ("AVAILABLE" | "CREATING" | "DELETING" | "DISASSOCIATED" | "DISASSOCIATING" | "EXPIRED" | "FAILED")
|
|
474
|
+
def status_message: () -> ::String
|
|
475
|
+
end
|
|
476
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#describe_backup_access_point-instance_method
|
|
477
|
+
def describe_backup_access_point: (
|
|
478
|
+
access_point_arn: ::String
|
|
479
|
+
) -> _DescribeBackupAccessPointResponseSuccess
|
|
480
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeBackupAccessPointResponseSuccess
|
|
481
|
+
|
|
441
482
|
interface _DescribeBackupJobResponseSuccess
|
|
442
483
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeBackupJobOutput]
|
|
443
484
|
def account_id: () -> ::String
|
|
@@ -798,7 +839,7 @@ module Aws
|
|
|
798
839
|
def backup_vault_name: () -> ::String
|
|
799
840
|
def backup_vault_arn: () -> ::String
|
|
800
841
|
def sns_topic_arn: () -> ::String
|
|
801
|
-
def backup_vault_events: () -> ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "CONTINUOUS_BACKUP_INTERRUPTED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED" | "EKS_RESTORE_OBJECT_FAILED" | "EKS_RESTORE_OBJECT_SKIPPED" | "EKS_BACKUP_OBJECT_FAILED")]
|
|
842
|
+
def backup_vault_events: () -> ::Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "CONTINUOUS_BACKUP_INTERRUPTED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED" | "EKS_RESTORE_OBJECT_FAILED" | "EKS_RESTORE_OBJECT_SKIPPED" | "EKS_BACKUP_OBJECT_FAILED" | "ACCESS_POINT_AVAILABLE" | "ACCESS_POINT_CREATION_FAILED" | "ACCESS_POINT_DELETED" | "ACCESS_POINT_DELETION_FAILED" | "ACCESS_POINT_EXPIRED" | "ACCESS_POINT_DISASSOCIATED")]
|
|
802
843
|
end
|
|
803
844
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#get_backup_vault_notifications-instance_method
|
|
804
845
|
def get_backup_vault_notifications: (
|
|
@@ -938,6 +979,44 @@ module Aws
|
|
|
938
979
|
) -> _GetTieringConfigurationResponseSuccess
|
|
939
980
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetTieringConfigurationResponseSuccess
|
|
940
981
|
|
|
982
|
+
interface _ListBackupAccessPointsResponseSuccess
|
|
983
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListBackupAccessPointsResponse]
|
|
984
|
+
def backup_access_points: () -> ::Array[Types::ListAccessPointsMember]
|
|
985
|
+
def next_token: () -> ::String
|
|
986
|
+
end
|
|
987
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#list_backup_access_points-instance_method
|
|
988
|
+
def list_backup_access_points: (
|
|
989
|
+
?max_results: ::Integer,
|
|
990
|
+
?next_token: ::String
|
|
991
|
+
) -> _ListBackupAccessPointsResponseSuccess
|
|
992
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBackupAccessPointsResponseSuccess
|
|
993
|
+
|
|
994
|
+
interface _ListBackupAccessPointsByRecoveryPointResponseSuccess
|
|
995
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListBackupAccessPointsByRecoveryPointResponse]
|
|
996
|
+
def backup_access_points: () -> ::Array[Types::ListAccessPointsMember]
|
|
997
|
+
def next_token: () -> ::String
|
|
998
|
+
end
|
|
999
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#list_backup_access_points_by_recovery_point-instance_method
|
|
1000
|
+
def list_backup_access_points_by_recovery_point: (
|
|
1001
|
+
?max_results: ::Integer,
|
|
1002
|
+
?next_token: ::String,
|
|
1003
|
+
recovery_point_arn: ::String
|
|
1004
|
+
) -> _ListBackupAccessPointsByRecoveryPointResponseSuccess
|
|
1005
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBackupAccessPointsByRecoveryPointResponseSuccess
|
|
1006
|
+
|
|
1007
|
+
interface _ListBackupAccessPointsByResourceResponseSuccess
|
|
1008
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListBackupAccessPointsByResourceResponse]
|
|
1009
|
+
def backup_access_points: () -> ::Array[Types::ListAccessPointsMember]
|
|
1010
|
+
def next_token: () -> ::String
|
|
1011
|
+
end
|
|
1012
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Backup/Client.html#list_backup_access_points_by_resource-instance_method
|
|
1013
|
+
def list_backup_access_points_by_resource: (
|
|
1014
|
+
?max_results: ::Integer,
|
|
1015
|
+
?next_token: ::String,
|
|
1016
|
+
resource_arn: ::String
|
|
1017
|
+
) -> _ListBackupAccessPointsByResourceResponseSuccess
|
|
1018
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBackupAccessPointsByResourceResponseSuccess
|
|
1019
|
+
|
|
941
1020
|
interface _ListBackupJobSummariesResponseSuccess
|
|
942
1021
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListBackupJobSummariesOutput]
|
|
943
1022
|
def backup_job_summaries: () -> ::Array[Types::BackupJobSummary]
|
|
@@ -1406,7 +1485,7 @@ module Aws
|
|
|
1406
1485
|
def put_backup_vault_notifications: (
|
|
1407
1486
|
backup_vault_name: ::String,
|
|
1408
1487
|
sns_topic_arn: ::String,
|
|
1409
|
-
backup_vault_events: Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "CONTINUOUS_BACKUP_INTERRUPTED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED" | "EKS_RESTORE_OBJECT_FAILED" | "EKS_RESTORE_OBJECT_SKIPPED" | "EKS_BACKUP_OBJECT_FAILED")]
|
|
1488
|
+
backup_vault_events: Array[("BACKUP_JOB_STARTED" | "BACKUP_JOB_COMPLETED" | "BACKUP_JOB_SUCCESSFUL" | "BACKUP_JOB_FAILED" | "BACKUP_JOB_EXPIRED" | "RESTORE_JOB_STARTED" | "RESTORE_JOB_COMPLETED" | "RESTORE_JOB_SUCCESSFUL" | "RESTORE_JOB_FAILED" | "COPY_JOB_STARTED" | "COPY_JOB_SUCCESSFUL" | "COPY_JOB_FAILED" | "RECOVERY_POINT_MODIFIED" | "BACKUP_PLAN_CREATED" | "BACKUP_PLAN_MODIFIED" | "S3_BACKUP_OBJECT_FAILED" | "S3_RESTORE_OBJECT_FAILED" | "CONTINUOUS_BACKUP_INTERRUPTED" | "RECOVERY_POINT_INDEX_COMPLETED" | "RECOVERY_POINT_INDEX_DELETED" | "RECOVERY_POINT_INDEXING_FAILED" | "EKS_RESTORE_OBJECT_FAILED" | "EKS_RESTORE_OBJECT_SKIPPED" | "EKS_BACKUP_OBJECT_FAILED" | "ACCESS_POINT_AVAILABLE" | "ACCESS_POINT_CREATION_FAILED" | "ACCESS_POINT_DELETED" | "ACCESS_POINT_DELETION_FAILED" | "ACCESS_POINT_EXPIRED" | "ACCESS_POINT_DISASSOCIATED")]
|
|
1410
1489
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
1411
1490
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
1412
1491
|
|