aws-sdk-storagegateway 1.103.0 → 1.104.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5868793b64b8986134d081a5934b99d826ce675405c336fab1f50da6d7c551f3
4
- data.tar.gz: f983c8180a812f814dd0b90c66aec072c2a6af618363a78923c5047c25b35b65
3
+ metadata.gz: 8e74c741ad4b21705f0778f20ac7b11f92b999f2ee5143accfd4e9469f45ddd3
4
+ data.tar.gz: 15d3f5fb83ff82f9e44d46820eedb8de973b455ba9dffae23729727151830986
5
5
  SHA512:
6
- metadata.gz: da29ff0b2df8d1eab0a365e891a87744a16a5ee568535d786776b9fc5c872d7fc784b0c59fd4b8a4d794a3992a8061894886e380a394fb1b013af518dd42dcdb
7
- data.tar.gz: fe908fd07244cbdd51763673c2c239e2fa87192400f9742e6a3bb1ae6971391b2bbb2c46a86ed58700a120a12a33845cad28a8be8a2d66b89067aa8f05a5be11
6
+ metadata.gz: 55eedad2bac2222f464c2ca6bacc03a31b4a5d705763c83078358e9e7a2832afbf3cc515342977e1dc84ca77671bb697d858f89491c46a8940cf7dd33ab258eb
7
+ data.tar.gz: 3eb1d73256285f4fa027902d8b72839ccc436bf339771f6cfcb6a48701c2160455d86de6aeb3bc6c6cdbbc1ea16ed00dd63ed55c7c6321d22e02006205e67345
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.104.0 (2025-02-13)
5
+ ------------------
6
+
7
+ * Feature - This release adds support for generating cache reports on S3 File Gateways for files that fail to upload.
8
+
4
9
  1.103.0 (2025-02-06)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.103.0
1
+ 1.104.0
@@ -1162,6 +1162,39 @@ module Aws::StorageGateway
1162
1162
  req.send_request(options)
1163
1163
  end
1164
1164
 
1165
+ # Cancels generation of a specified cache report. You can use this
1166
+ # operation to manually cancel an IN-PROGRESS report for any reason.
1167
+ # This action changes the report status from IN-PROGRESS to CANCELLED.
1168
+ # You can only cancel in-progress reports. If the the report you attempt
1169
+ # to cancel is in FAILED, ERROR, or COMPLETED state, the cancel
1170
+ # operation returns an error.
1171
+ #
1172
+ # @option params [required, String] :cache_report_arn
1173
+ # The Amazon Resource Name (ARN) of the cache report you want to cancel.
1174
+ #
1175
+ # @return [Types::CancelCacheReportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1176
+ #
1177
+ # * {Types::CancelCacheReportOutput#cache_report_arn #cache_report_arn} => String
1178
+ #
1179
+ # @example Request syntax with placeholder values
1180
+ #
1181
+ # resp = client.cancel_cache_report({
1182
+ # cache_report_arn: "CacheReportARN", # required
1183
+ # })
1184
+ #
1185
+ # @example Response structure
1186
+ #
1187
+ # resp.cache_report_arn #=> String
1188
+ #
1189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CancelCacheReport AWS API Documentation
1190
+ #
1191
+ # @overload cancel_cache_report(params = {})
1192
+ # @param [Hash] params ({})
1193
+ def cancel_cache_report(params = {}, options = {})
1194
+ req = build_request(:cancel_cache_report, params)
1195
+ req.send_request(options)
1196
+ end
1197
+
1165
1198
  # Cancels retrieval of a virtual tape from the virtual tape shelf (VTS)
1166
1199
  # to a gateway after the retrieval process is initiated. The virtual
1167
1200
  # tape is returned to the VTS. This operation is only supported in the
@@ -2782,6 +2815,43 @@ module Aws::StorageGateway
2782
2815
  req.send_request(options)
2783
2816
  end
2784
2817
 
2818
+ # Deletes the specified cache report and any associated tags from the
2819
+ # Storage Gateway database. You can only delete completed reports. If
2820
+ # the status of the report you attempt to delete still IN-PROGRESS, the
2821
+ # delete operation returns an error. You can use `CancelCacheReport` to
2822
+ # cancel an IN-PROGRESS report.
2823
+ #
2824
+ # <note markdown="1"> `DeleteCacheReport` does not delete the report object from your Amazon
2825
+ # S3 bucket.
2826
+ #
2827
+ # </note>
2828
+ #
2829
+ # @option params [required, String] :cache_report_arn
2830
+ # The Amazon Resource Name (ARN) of the cache report you want to delete.
2831
+ #
2832
+ # @return [Types::DeleteCacheReportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2833
+ #
2834
+ # * {Types::DeleteCacheReportOutput#cache_report_arn #cache_report_arn} => String
2835
+ #
2836
+ # @example Request syntax with placeholder values
2837
+ #
2838
+ # resp = client.delete_cache_report({
2839
+ # cache_report_arn: "CacheReportARN", # required
2840
+ # })
2841
+ #
2842
+ # @example Response structure
2843
+ #
2844
+ # resp.cache_report_arn #=> String
2845
+ #
2846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteCacheReport AWS API Documentation
2847
+ #
2848
+ # @overload delete_cache_report(params = {})
2849
+ # @param [Hash] params ({})
2850
+ def delete_cache_report(params = {}, options = {})
2851
+ req = build_request(:delete_cache_report, params)
2852
+ req.send_request(options)
2853
+ end
2854
+
2785
2855
  # Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials
2786
2856
  # for a specified iSCSI target and initiator pair. This operation is
2787
2857
  # supported in volume and tape gateway types.
@@ -3430,6 +3500,55 @@ module Aws::StorageGateway
3430
3500
  req.send_request(options)
3431
3501
  end
3432
3502
 
3503
+ # Returns information about the specified cache report, including
3504
+ # completion status and generation progress.
3505
+ #
3506
+ # @option params [required, String] :cache_report_arn
3507
+ # The Amazon Resource Name (ARN) of the cache report you want to
3508
+ # describe.
3509
+ #
3510
+ # @return [Types::DescribeCacheReportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3511
+ #
3512
+ # * {Types::DescribeCacheReportOutput#cache_report_info #cache_report_info} => Types::CacheReportInfo
3513
+ #
3514
+ # @example Request syntax with placeholder values
3515
+ #
3516
+ # resp = client.describe_cache_report({
3517
+ # cache_report_arn: "CacheReportARN", # required
3518
+ # })
3519
+ #
3520
+ # @example Response structure
3521
+ #
3522
+ # resp.cache_report_info.cache_report_arn #=> String
3523
+ # resp.cache_report_info.cache_report_status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELED", "FAILED", "ERROR"
3524
+ # resp.cache_report_info.report_completion_percent #=> Integer
3525
+ # resp.cache_report_info.end_time #=> Time
3526
+ # resp.cache_report_info.role #=> String
3527
+ # resp.cache_report_info.file_share_arn #=> String
3528
+ # resp.cache_report_info.location_arn #=> String
3529
+ # resp.cache_report_info.start_time #=> Time
3530
+ # resp.cache_report_info.inclusion_filters #=> Array
3531
+ # resp.cache_report_info.inclusion_filters[0].name #=> String, one of "UploadState", "UploadFailureReason"
3532
+ # resp.cache_report_info.inclusion_filters[0].values #=> Array
3533
+ # resp.cache_report_info.inclusion_filters[0].values[0] #=> String
3534
+ # resp.cache_report_info.exclusion_filters #=> Array
3535
+ # resp.cache_report_info.exclusion_filters[0].name #=> String, one of "UploadState", "UploadFailureReason"
3536
+ # resp.cache_report_info.exclusion_filters[0].values #=> Array
3537
+ # resp.cache_report_info.exclusion_filters[0].values[0] #=> String
3538
+ # resp.cache_report_info.report_name #=> String
3539
+ # resp.cache_report_info.tags #=> Array
3540
+ # resp.cache_report_info.tags[0].key #=> String
3541
+ # resp.cache_report_info.tags[0].value #=> String
3542
+ #
3543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCacheReport AWS API Documentation
3544
+ #
3545
+ # @overload describe_cache_report(params = {})
3546
+ # @param [Hash] params ({})
3547
+ def describe_cache_report(params = {}, options = {})
3548
+ req = build_request(:describe_cache_report, params)
3549
+ req.send_request(options)
3550
+ end
3551
+
3433
3552
  # Returns a description of the gateway volumes specified in the request.
3434
3553
  # This operation is only supported in the cached volume gateway types.
3435
3554
  #
@@ -4944,6 +5063,62 @@ module Aws::StorageGateway
4944
5063
  req.send_request(options)
4945
5064
  end
4946
5065
 
5066
+ # Returns a list of existing cache reports for all file shares
5067
+ # associated with your Amazon Web Services account. This list includes
5068
+ # all information provided by the `DescribeCacheReport` action, such as
5069
+ # report name, status, completion progress, start time, end time,
5070
+ # filters, and tags.
5071
+ #
5072
+ # @option params [String] :marker
5073
+ # Opaque pagination token returned from a previous `ListCacheReports`
5074
+ # operation. If present, `Marker` specifies where to continue the list
5075
+ # from after a previous call to `ListCacheReports`. Optional.
5076
+ #
5077
+ # @return [Types::ListCacheReportsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5078
+ #
5079
+ # * {Types::ListCacheReportsOutput#cache_report_list #cache_report_list} => Array&lt;Types::CacheReportInfo&gt;
5080
+ # * {Types::ListCacheReportsOutput#marker #marker} => String
5081
+ #
5082
+ # @example Request syntax with placeholder values
5083
+ #
5084
+ # resp = client.list_cache_reports({
5085
+ # marker: "Marker",
5086
+ # })
5087
+ #
5088
+ # @example Response structure
5089
+ #
5090
+ # resp.cache_report_list #=> Array
5091
+ # resp.cache_report_list[0].cache_report_arn #=> String
5092
+ # resp.cache_report_list[0].cache_report_status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELED", "FAILED", "ERROR"
5093
+ # resp.cache_report_list[0].report_completion_percent #=> Integer
5094
+ # resp.cache_report_list[0].end_time #=> Time
5095
+ # resp.cache_report_list[0].role #=> String
5096
+ # resp.cache_report_list[0].file_share_arn #=> String
5097
+ # resp.cache_report_list[0].location_arn #=> String
5098
+ # resp.cache_report_list[0].start_time #=> Time
5099
+ # resp.cache_report_list[0].inclusion_filters #=> Array
5100
+ # resp.cache_report_list[0].inclusion_filters[0].name #=> String, one of "UploadState", "UploadFailureReason"
5101
+ # resp.cache_report_list[0].inclusion_filters[0].values #=> Array
5102
+ # resp.cache_report_list[0].inclusion_filters[0].values[0] #=> String
5103
+ # resp.cache_report_list[0].exclusion_filters #=> Array
5104
+ # resp.cache_report_list[0].exclusion_filters[0].name #=> String, one of "UploadState", "UploadFailureReason"
5105
+ # resp.cache_report_list[0].exclusion_filters[0].values #=> Array
5106
+ # resp.cache_report_list[0].exclusion_filters[0].values[0] #=> String
5107
+ # resp.cache_report_list[0].report_name #=> String
5108
+ # resp.cache_report_list[0].tags #=> Array
5109
+ # resp.cache_report_list[0].tags[0].key #=> String
5110
+ # resp.cache_report_list[0].tags[0].value #=> String
5111
+ # resp.marker #=> String
5112
+ #
5113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListCacheReports AWS API Documentation
5114
+ #
5115
+ # @overload list_cache_reports(params = {})
5116
+ # @param [Hash] params ({})
5117
+ def list_cache_reports(params = {}, options = {})
5118
+ req = build_request(:list_cache_reports, params)
5119
+ req.send_request(options)
5120
+ end
5121
+
4947
5122
  # Gets a list of the file shares for a specific S3 File Gateway, or the
4948
5123
  # list of file shares that belong to the calling Amazon Web Services
4949
5124
  # account. This operation is only supported for S3 File Gateways.
@@ -5615,18 +5790,18 @@ module Aws::StorageGateway
5615
5790
  req.send_request(options)
5616
5791
  end
5617
5792
 
5618
- # Sends you notification through CloudWatch Events when all files
5793
+ # Sends you notification through Amazon EventBridge when all files
5619
5794
  # written to your file share have been uploaded to Amazon S3.
5620
5795
  #
5621
- # Storage Gateway can send a notification through Amazon CloudWatch
5622
- # Events when all files written to your file share up to that point in
5623
- # time have been uploaded to Amazon S3. These files include files
5624
- # written to the file share up to the time that you make a request for
5796
+ # Storage Gateway can send a notification through Amazon EventBridge
5797
+ # when all files written to your file share up to that point in time
5798
+ # have been uploaded to Amazon S3. These files include files written to
5799
+ # the file share up to the time that you make a request for
5625
5800
  # notification. When the upload is done, Storage Gateway sends you
5626
- # notification through an Amazon CloudWatch Event. You can configure
5627
- # CloudWatch Events to send the notification through event targets such
5628
- # as Amazon SNS or Lambda function. This operation is only supported for
5629
- # S3 File Gateways.
5801
+ # notification through EventBridge. You can configure EventBridge to
5802
+ # send the notification through event targets such as Amazon SNS or
5803
+ # Lambda function. This operation is only supported for S3 File
5804
+ # Gateways.
5630
5805
  #
5631
5806
  # For more information, see [Getting file upload notification][1] in the
5632
5807
  # *Amazon S3 File Gateway User Guide*.
@@ -6204,6 +6379,134 @@ module Aws::StorageGateway
6204
6379
  req.send_request(options)
6205
6380
  end
6206
6381
 
6382
+ # Starts generating a report of the file metadata currently cached by an
6383
+ # S3 File Gateway for a specific file share. You can use this report to
6384
+ # identify and resolve issues if you have files failing upload from your
6385
+ # gateway to Amazon S3. The report is a CSV file containing a list of
6386
+ # files which match the set of filter parameters you specify in the
6387
+ # request.
6388
+ #
6389
+ # <note markdown="1"> The **Files Failing Upload** flag is reset every 24 hours and during
6390
+ # gateway reboot. If this report captures the files after the reset, but
6391
+ # before they become flagged again, they will not be reported as **Files
6392
+ # Failing Upload**.
6393
+ #
6394
+ # </note>
6395
+ #
6396
+ # The following requirements must be met to successfully generate a
6397
+ # cache report:
6398
+ #
6399
+ # * You must have permissions to list the entire Amazon S3 bucket
6400
+ # associated with the specified file share.
6401
+ #
6402
+ # * No other cache reports can currently be in-progress for the
6403
+ # specified file share.
6404
+ #
6405
+ # * There must be fewer than 10 existing cache reports for the specified
6406
+ # file share.
6407
+ #
6408
+ # * The gateway must be online and connected to Amazon Web Services.
6409
+ #
6410
+ # * The root disk must have at least 20GB of free space when report
6411
+ # generation starts.
6412
+ #
6413
+ # * You must specify at least one value for `InclusionFilters` or
6414
+ # `ExclusionFilters` in the request.
6415
+ #
6416
+ # @option params [required, String] :file_share_arn
6417
+ # The Amazon Resource Name (ARN) of the file share.
6418
+ #
6419
+ # @option params [required, String] :role
6420
+ # The ARN of the IAM role used when saving the cache report to Amazon
6421
+ # S3.
6422
+ #
6423
+ # @option params [required, String] :location_arn
6424
+ # The ARN of the Amazon S3 bucket where the cache report will be saved.
6425
+ #
6426
+ # <note markdown="1"> We do not recommend saving the cache report to the same Amazon S3
6427
+ # bucket for which you are generating the report.
6428
+ #
6429
+ # This field does not accept access point ARNs.
6430
+ #
6431
+ # </note>
6432
+ #
6433
+ # @option params [required, String] :bucket_region
6434
+ # The Amazon Web Services Region of the Amazon S3 bucket associated with
6435
+ # the file share for which you want to generate the cache report.
6436
+ #
6437
+ # @option params [String] :vpc_endpoint_dns_name
6438
+ # The DNS name of the VPC endpoint associated with the Amazon S3 where
6439
+ # you want to save the cache report. Optional.
6440
+ #
6441
+ # @option params [Array<Types::CacheReportFilter>] :inclusion_filters
6442
+ # The list of filters and parameters that determine which files are
6443
+ # included in the report. You must specify at least one value for
6444
+ # `InclusionFilters` or `ExclusionFilters` in a `StartCacheReport`
6445
+ # request.
6446
+ #
6447
+ # @option params [Array<Types::CacheReportFilter>] :exclusion_filters
6448
+ # The list of filters and parameters that determine which files are
6449
+ # excluded from the report. You must specify at least one value for
6450
+ # `InclusionFilters` or `ExclusionFilters` in a `StartCacheReport`
6451
+ # request.
6452
+ #
6453
+ # @option params [required, String] :client_token
6454
+ # A unique identifier that you use to ensure idempotent report
6455
+ # generation if you need to retry an unsuccessful `StartCacheReport`
6456
+ # request. If you retry a request, use the same `ClientToken` you
6457
+ # specified in the initial request.
6458
+ #
6459
+ # @option params [Array<Types::Tag>] :tags
6460
+ # A list of up to 50 key/value tags that you can assign to the cache
6461
+ # report. Using tags can help you categorize your reports and more
6462
+ # easily locate them in search results.
6463
+ #
6464
+ # @return [Types::StartCacheReportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6465
+ #
6466
+ # * {Types::StartCacheReportOutput#cache_report_arn #cache_report_arn} => String
6467
+ #
6468
+ # @example Request syntax with placeholder values
6469
+ #
6470
+ # resp = client.start_cache_report({
6471
+ # file_share_arn: "FileShareARN", # required
6472
+ # role: "Role", # required
6473
+ # location_arn: "LocationARN", # required
6474
+ # bucket_region: "RegionId", # required
6475
+ # vpc_endpoint_dns_name: "DNSHostName",
6476
+ # inclusion_filters: [
6477
+ # {
6478
+ # name: "UploadState", # required, accepts UploadState, UploadFailureReason
6479
+ # values: ["CacheReportFilterValue"], # required
6480
+ # },
6481
+ # ],
6482
+ # exclusion_filters: [
6483
+ # {
6484
+ # name: "UploadState", # required, accepts UploadState, UploadFailureReason
6485
+ # values: ["CacheReportFilterValue"], # required
6486
+ # },
6487
+ # ],
6488
+ # client_token: "ClientToken", # required
6489
+ # tags: [
6490
+ # {
6491
+ # key: "TagKey", # required
6492
+ # value: "TagValue", # required
6493
+ # },
6494
+ # ],
6495
+ # })
6496
+ #
6497
+ # @example Response structure
6498
+ #
6499
+ # resp.cache_report_arn #=> String
6500
+ #
6501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartCacheReport AWS API Documentation
6502
+ #
6503
+ # @overload start_cache_report(params = {})
6504
+ # @param [Hash] params ({})
6505
+ def start_cache_report(params = {}, options = {})
6506
+ req = build_request(:start_cache_report, params)
6507
+ req.send_request(options)
6508
+ end
6509
+
6207
6510
  # Starts a gateway that you previously shut down (see ShutdownGateway).
6208
6511
  # After the gateway starts, you can then make other API calls, your
6209
6512
  # applications can read from or write to the gateway's storage volumes
@@ -7603,7 +7906,7 @@ module Aws::StorageGateway
7603
7906
  tracer: tracer
7604
7907
  )
7605
7908
  context[:gem_name] = 'aws-sdk-storagegateway'
7606
- context[:gem_version] = '1.103.0'
7909
+ context[:gem_version] = '1.104.0'
7607
7910
  Seahorse::Client::Request.new(handlers, context)
7608
7911
  end
7609
7912
 
@@ -47,11 +47,23 @@ module Aws::StorageGateway
47
47
  BandwidthUploadRateLimit = Shapes::IntegerShape.new(name: 'BandwidthUploadRateLimit')
48
48
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
49
49
  CacheAttributes = Shapes::StructureShape.new(name: 'CacheAttributes')
50
+ CacheReportARN = Shapes::StringShape.new(name: 'CacheReportARN')
51
+ CacheReportFilter = Shapes::StructureShape.new(name: 'CacheReportFilter')
52
+ CacheReportFilterList = Shapes::ListShape.new(name: 'CacheReportFilterList')
53
+ CacheReportFilterName = Shapes::StringShape.new(name: 'CacheReportFilterName')
54
+ CacheReportFilterValue = Shapes::StringShape.new(name: 'CacheReportFilterValue')
55
+ CacheReportFilterValues = Shapes::ListShape.new(name: 'CacheReportFilterValues')
56
+ CacheReportInfo = Shapes::StructureShape.new(name: 'CacheReportInfo')
57
+ CacheReportList = Shapes::ListShape.new(name: 'CacheReportList')
58
+ CacheReportName = Shapes::StringShape.new(name: 'CacheReportName')
59
+ CacheReportStatus = Shapes::StringShape.new(name: 'CacheReportStatus')
50
60
  CacheStaleTimeoutInSeconds = Shapes::IntegerShape.new(name: 'CacheStaleTimeoutInSeconds')
51
61
  CachediSCSIVolume = Shapes::StructureShape.new(name: 'CachediSCSIVolume')
52
62
  CachediSCSIVolumes = Shapes::ListShape.new(name: 'CachediSCSIVolumes')
53
63
  CancelArchivalInput = Shapes::StructureShape.new(name: 'CancelArchivalInput')
54
64
  CancelArchivalOutput = Shapes::StructureShape.new(name: 'CancelArchivalOutput')
65
+ CancelCacheReportInput = Shapes::StructureShape.new(name: 'CancelCacheReportInput')
66
+ CancelCacheReportOutput = Shapes::StructureShape.new(name: 'CancelCacheReportOutput')
55
67
  CancelRetrievalInput = Shapes::StructureShape.new(name: 'CancelRetrievalInput')
56
68
  CancelRetrievalOutput = Shapes::StructureShape.new(name: 'CancelRetrievalOutput')
57
69
  CaseSensitivity = Shapes::StringShape.new(name: 'CaseSensitivity')
@@ -87,6 +99,8 @@ module Aws::StorageGateway
87
99
  DeleteAutomaticTapeCreationPolicyOutput = Shapes::StructureShape.new(name: 'DeleteAutomaticTapeCreationPolicyOutput')
88
100
  DeleteBandwidthRateLimitInput = Shapes::StructureShape.new(name: 'DeleteBandwidthRateLimitInput')
89
101
  DeleteBandwidthRateLimitOutput = Shapes::StructureShape.new(name: 'DeleteBandwidthRateLimitOutput')
102
+ DeleteCacheReportInput = Shapes::StructureShape.new(name: 'DeleteCacheReportInput')
103
+ DeleteCacheReportOutput = Shapes::StructureShape.new(name: 'DeleteCacheReportOutput')
90
104
  DeleteChapCredentialsInput = Shapes::StructureShape.new(name: 'DeleteChapCredentialsInput')
91
105
  DeleteChapCredentialsOutput = Shapes::StructureShape.new(name: 'DeleteChapCredentialsOutput')
92
106
  DeleteFileShareInput = Shapes::StructureShape.new(name: 'DeleteFileShareInput')
@@ -112,6 +126,8 @@ module Aws::StorageGateway
112
126
  DescribeBandwidthRateLimitScheduleOutput = Shapes::StructureShape.new(name: 'DescribeBandwidthRateLimitScheduleOutput')
113
127
  DescribeCacheInput = Shapes::StructureShape.new(name: 'DescribeCacheInput')
114
128
  DescribeCacheOutput = Shapes::StructureShape.new(name: 'DescribeCacheOutput')
129
+ DescribeCacheReportInput = Shapes::StructureShape.new(name: 'DescribeCacheReportInput')
130
+ DescribeCacheReportOutput = Shapes::StructureShape.new(name: 'DescribeCacheReportOutput')
115
131
  DescribeCachediSCSIVolumesInput = Shapes::StructureShape.new(name: 'DescribeCachediSCSIVolumesInput')
116
132
  DescribeCachediSCSIVolumesOutput = Shapes::StructureShape.new(name: 'DescribeCachediSCSIVolumesOutput')
117
133
  DescribeChapCredentialsInput = Shapes::StructureShape.new(name: 'DescribeChapCredentialsInput')
@@ -223,6 +239,8 @@ module Aws::StorageGateway
223
239
  LastSoftwareUpdate = Shapes::StringShape.new(name: 'LastSoftwareUpdate')
224
240
  ListAutomaticTapeCreationPoliciesInput = Shapes::StructureShape.new(name: 'ListAutomaticTapeCreationPoliciesInput')
225
241
  ListAutomaticTapeCreationPoliciesOutput = Shapes::StructureShape.new(name: 'ListAutomaticTapeCreationPoliciesOutput')
242
+ ListCacheReportsInput = Shapes::StructureShape.new(name: 'ListCacheReportsInput')
243
+ ListCacheReportsOutput = Shapes::StructureShape.new(name: 'ListCacheReportsOutput')
226
244
  ListFileSharesInput = Shapes::StructureShape.new(name: 'ListFileSharesInput')
227
245
  ListFileSharesOutput = Shapes::StructureShape.new(name: 'ListFileSharesOutput')
228
246
  ListFileSystemAssociationsInput = Shapes::StructureShape.new(name: 'ListFileSystemAssociationsInput')
@@ -279,6 +297,7 @@ module Aws::StorageGateway
279
297
  RegionId = Shapes::StringShape.new(name: 'RegionId')
280
298
  RemoveTagsFromResourceInput = Shapes::StructureShape.new(name: 'RemoveTagsFromResourceInput')
281
299
  RemoveTagsFromResourceOutput = Shapes::StructureShape.new(name: 'RemoveTagsFromResourceOutput')
300
+ ReportCompletionPercent = Shapes::IntegerShape.new(name: 'ReportCompletionPercent')
282
301
  ResetCacheInput = Shapes::StructureShape.new(name: 'ResetCacheInput')
283
302
  ResetCacheOutput = Shapes::StructureShape.new(name: 'ResetCacheOutput')
284
303
  ResourceARN = Shapes::StringShape.new(name: 'ResourceARN')
@@ -309,6 +328,8 @@ module Aws::StorageGateway
309
328
  Squash = Shapes::StringShape.new(name: 'Squash')
310
329
  StartAvailabilityMonitorTestInput = Shapes::StructureShape.new(name: 'StartAvailabilityMonitorTestInput')
311
330
  StartAvailabilityMonitorTestOutput = Shapes::StructureShape.new(name: 'StartAvailabilityMonitorTestOutput')
331
+ StartCacheReportInput = Shapes::StructureShape.new(name: 'StartCacheReportInput')
332
+ StartCacheReportOutput = Shapes::StructureShape.new(name: 'StartCacheReportOutput')
312
333
  StartGatewayInput = Shapes::StructureShape.new(name: 'StartGatewayInput')
313
334
  StartGatewayOutput = Shapes::StructureShape.new(name: 'StartGatewayOutput')
314
335
  StorageClass = Shapes::StringShape.new(name: 'StorageClass')
@@ -505,6 +526,30 @@ module Aws::StorageGateway
505
526
  CacheAttributes.add_member(:cache_stale_timeout_in_seconds, Shapes::ShapeRef.new(shape: CacheStaleTimeoutInSeconds, location_name: "CacheStaleTimeoutInSeconds"))
506
527
  CacheAttributes.struct_class = Types::CacheAttributes
507
528
 
529
+ CacheReportFilter.add_member(:name, Shapes::ShapeRef.new(shape: CacheReportFilterName, required: true, location_name: "Name"))
530
+ CacheReportFilter.add_member(:values, Shapes::ShapeRef.new(shape: CacheReportFilterValues, required: true, location_name: "Values"))
531
+ CacheReportFilter.struct_class = Types::CacheReportFilter
532
+
533
+ CacheReportFilterList.member = Shapes::ShapeRef.new(shape: CacheReportFilter)
534
+
535
+ CacheReportFilterValues.member = Shapes::ShapeRef.new(shape: CacheReportFilterValue)
536
+
537
+ CacheReportInfo.add_member(:cache_report_arn, Shapes::ShapeRef.new(shape: CacheReportARN, location_name: "CacheReportARN"))
538
+ CacheReportInfo.add_member(:cache_report_status, Shapes::ShapeRef.new(shape: CacheReportStatus, location_name: "CacheReportStatus"))
539
+ CacheReportInfo.add_member(:report_completion_percent, Shapes::ShapeRef.new(shape: ReportCompletionPercent, location_name: "ReportCompletionPercent"))
540
+ CacheReportInfo.add_member(:end_time, Shapes::ShapeRef.new(shape: Time, location_name: "EndTime"))
541
+ CacheReportInfo.add_member(:role, Shapes::ShapeRef.new(shape: Role, location_name: "Role"))
542
+ CacheReportInfo.add_member(:file_share_arn, Shapes::ShapeRef.new(shape: FileShareARN, location_name: "FileShareARN"))
543
+ CacheReportInfo.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationARN, location_name: "LocationARN"))
544
+ CacheReportInfo.add_member(:start_time, Shapes::ShapeRef.new(shape: Time, location_name: "StartTime"))
545
+ CacheReportInfo.add_member(:inclusion_filters, Shapes::ShapeRef.new(shape: CacheReportFilterList, location_name: "InclusionFilters"))
546
+ CacheReportInfo.add_member(:exclusion_filters, Shapes::ShapeRef.new(shape: CacheReportFilterList, location_name: "ExclusionFilters"))
547
+ CacheReportInfo.add_member(:report_name, Shapes::ShapeRef.new(shape: CacheReportName, location_name: "ReportName"))
548
+ CacheReportInfo.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
549
+ CacheReportInfo.struct_class = Types::CacheReportInfo
550
+
551
+ CacheReportList.member = Shapes::ShapeRef.new(shape: CacheReportInfo)
552
+
508
553
  CachediSCSIVolume.add_member(:volume_arn, Shapes::ShapeRef.new(shape: VolumeARN, location_name: "VolumeARN"))
509
554
  CachediSCSIVolume.add_member(:volume_id, Shapes::ShapeRef.new(shape: VolumeId, location_name: "VolumeId"))
510
555
  CachediSCSIVolume.add_member(:volume_type, Shapes::ShapeRef.new(shape: VolumeType, location_name: "VolumeType"))
@@ -529,6 +574,12 @@ module Aws::StorageGateway
529
574
  CancelArchivalOutput.add_member(:tape_arn, Shapes::ShapeRef.new(shape: TapeARN, location_name: "TapeARN"))
530
575
  CancelArchivalOutput.struct_class = Types::CancelArchivalOutput
531
576
 
577
+ CancelCacheReportInput.add_member(:cache_report_arn, Shapes::ShapeRef.new(shape: CacheReportARN, required: true, location_name: "CacheReportARN"))
578
+ CancelCacheReportInput.struct_class = Types::CancelCacheReportInput
579
+
580
+ CancelCacheReportOutput.add_member(:cache_report_arn, Shapes::ShapeRef.new(shape: CacheReportARN, location_name: "CacheReportARN"))
581
+ CancelCacheReportOutput.struct_class = Types::CancelCacheReportOutput
582
+
532
583
  CancelRetrievalInput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayARN, required: true, location_name: "GatewayARN"))
533
584
  CancelRetrievalInput.add_member(:tape_arn, Shapes::ShapeRef.new(shape: TapeARN, required: true, location_name: "TapeARN"))
534
585
  CancelRetrievalInput.struct_class = Types::CancelRetrievalInput
@@ -707,6 +758,12 @@ module Aws::StorageGateway
707
758
  DeleteBandwidthRateLimitOutput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayARN, location_name: "GatewayARN"))
708
759
  DeleteBandwidthRateLimitOutput.struct_class = Types::DeleteBandwidthRateLimitOutput
709
760
 
761
+ DeleteCacheReportInput.add_member(:cache_report_arn, Shapes::ShapeRef.new(shape: CacheReportARN, required: true, location_name: "CacheReportARN"))
762
+ DeleteCacheReportInput.struct_class = Types::DeleteCacheReportInput
763
+
764
+ DeleteCacheReportOutput.add_member(:cache_report_arn, Shapes::ShapeRef.new(shape: CacheReportARN, location_name: "CacheReportARN"))
765
+ DeleteCacheReportOutput.struct_class = Types::DeleteCacheReportOutput
766
+
710
767
  DeleteChapCredentialsInput.add_member(:target_arn, Shapes::ShapeRef.new(shape: TargetARN, required: true, location_name: "TargetARN"))
711
768
  DeleteChapCredentialsInput.add_member(:initiator_name, Shapes::ShapeRef.new(shape: IqnName, required: true, location_name: "InitiatorName"))
712
769
  DeleteChapCredentialsInput.struct_class = Types::DeleteChapCredentialsInput
@@ -796,6 +853,12 @@ module Aws::StorageGateway
796
853
  DescribeCacheOutput.add_member(:cache_miss_percentage, Shapes::ShapeRef.new(shape: double, location_name: "CacheMissPercentage"))
797
854
  DescribeCacheOutput.struct_class = Types::DescribeCacheOutput
798
855
 
856
+ DescribeCacheReportInput.add_member(:cache_report_arn, Shapes::ShapeRef.new(shape: CacheReportARN, required: true, location_name: "CacheReportARN"))
857
+ DescribeCacheReportInput.struct_class = Types::DescribeCacheReportInput
858
+
859
+ DescribeCacheReportOutput.add_member(:cache_report_info, Shapes::ShapeRef.new(shape: CacheReportInfo, location_name: "CacheReportInfo"))
860
+ DescribeCacheReportOutput.struct_class = Types::DescribeCacheReportOutput
861
+
799
862
  DescribeCachediSCSIVolumesInput.add_member(:volume_arns, Shapes::ShapeRef.new(shape: VolumeARNs, required: true, location_name: "VolumeARNs"))
800
863
  DescribeCachediSCSIVolumesInput.struct_class = Types::DescribeCachediSCSIVolumesInput
801
864
 
@@ -1090,6 +1153,13 @@ module Aws::StorageGateway
1090
1153
  ListAutomaticTapeCreationPoliciesOutput.add_member(:automatic_tape_creation_policy_infos, Shapes::ShapeRef.new(shape: AutomaticTapeCreationPolicyInfos, location_name: "AutomaticTapeCreationPolicyInfos"))
1091
1154
  ListAutomaticTapeCreationPoliciesOutput.struct_class = Types::ListAutomaticTapeCreationPoliciesOutput
1092
1155
 
1156
+ ListCacheReportsInput.add_member(:marker, Shapes::ShapeRef.new(shape: Marker, location_name: "Marker"))
1157
+ ListCacheReportsInput.struct_class = Types::ListCacheReportsInput
1158
+
1159
+ ListCacheReportsOutput.add_member(:cache_report_list, Shapes::ShapeRef.new(shape: CacheReportList, location_name: "CacheReportList"))
1160
+ ListCacheReportsOutput.add_member(:marker, Shapes::ShapeRef.new(shape: Marker, location_name: "Marker"))
1161
+ ListCacheReportsOutput.struct_class = Types::ListCacheReportsOutput
1162
+
1093
1163
  ListFileSharesInput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayARN, location_name: "GatewayARN"))
1094
1164
  ListFileSharesInput.add_member(:limit, Shapes::ShapeRef.new(shape: PositiveIntObject, location_name: "Limit"))
1095
1165
  ListFileSharesInput.add_member(:marker, Shapes::ShapeRef.new(shape: Marker, location_name: "Marker"))
@@ -1341,6 +1411,20 @@ module Aws::StorageGateway
1341
1411
  StartAvailabilityMonitorTestOutput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayARN, location_name: "GatewayARN"))
1342
1412
  StartAvailabilityMonitorTestOutput.struct_class = Types::StartAvailabilityMonitorTestOutput
1343
1413
 
1414
+ StartCacheReportInput.add_member(:file_share_arn, Shapes::ShapeRef.new(shape: FileShareARN, required: true, location_name: "FileShareARN"))
1415
+ StartCacheReportInput.add_member(:role, Shapes::ShapeRef.new(shape: Role, required: true, location_name: "Role"))
1416
+ StartCacheReportInput.add_member(:location_arn, Shapes::ShapeRef.new(shape: LocationARN, required: true, location_name: "LocationARN"))
1417
+ StartCacheReportInput.add_member(:bucket_region, Shapes::ShapeRef.new(shape: RegionId, required: true, location_name: "BucketRegion"))
1418
+ StartCacheReportInput.add_member(:vpc_endpoint_dns_name, Shapes::ShapeRef.new(shape: DNSHostName, location_name: "VPCEndpointDNSName"))
1419
+ StartCacheReportInput.add_member(:inclusion_filters, Shapes::ShapeRef.new(shape: CacheReportFilterList, location_name: "InclusionFilters"))
1420
+ StartCacheReportInput.add_member(:exclusion_filters, Shapes::ShapeRef.new(shape: CacheReportFilterList, location_name: "ExclusionFilters"))
1421
+ StartCacheReportInput.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, required: true, location_name: "ClientToken"))
1422
+ StartCacheReportInput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
1423
+ StartCacheReportInput.struct_class = Types::StartCacheReportInput
1424
+
1425
+ StartCacheReportOutput.add_member(:cache_report_arn, Shapes::ShapeRef.new(shape: CacheReportARN, location_name: "CacheReportARN"))
1426
+ StartCacheReportOutput.struct_class = Types::StartCacheReportOutput
1427
+
1344
1428
  StartGatewayInput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayARN, required: true, location_name: "GatewayARN"))
1345
1429
  StartGatewayInput.struct_class = Types::StartGatewayInput
1346
1430
 
@@ -1744,6 +1828,16 @@ module Aws::StorageGateway
1744
1828
  o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
1745
1829
  end)
1746
1830
 
1831
+ api.add_operation(:cancel_cache_report, Seahorse::Model::Operation.new.tap do |o|
1832
+ o.name = "CancelCacheReport"
1833
+ o.http_method = "POST"
1834
+ o.http_request_uri = "/"
1835
+ o.input = Shapes::ShapeRef.new(shape: CancelCacheReportInput)
1836
+ o.output = Shapes::ShapeRef.new(shape: CancelCacheReportOutput)
1837
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGatewayRequestException)
1838
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
1839
+ end)
1840
+
1747
1841
  api.add_operation(:cancel_retrieval, Seahorse::Model::Operation.new.tap do |o|
1748
1842
  o.name = "CancelRetrieval"
1749
1843
  o.http_method = "POST"
@@ -1866,6 +1960,16 @@ module Aws::StorageGateway
1866
1960
  o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
1867
1961
  end)
1868
1962
 
1963
+ api.add_operation(:delete_cache_report, Seahorse::Model::Operation.new.tap do |o|
1964
+ o.name = "DeleteCacheReport"
1965
+ o.http_method = "POST"
1966
+ o.http_request_uri = "/"
1967
+ o.input = Shapes::ShapeRef.new(shape: DeleteCacheReportInput)
1968
+ o.output = Shapes::ShapeRef.new(shape: DeleteCacheReportOutput)
1969
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGatewayRequestException)
1970
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
1971
+ end)
1972
+
1869
1973
  api.add_operation(:delete_chap_credentials, Seahorse::Model::Operation.new.tap do |o|
1870
1974
  o.name = "DeleteChapCredentials"
1871
1975
  o.http_method = "POST"
@@ -1986,6 +2090,16 @@ module Aws::StorageGateway
1986
2090
  o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
1987
2091
  end)
1988
2092
 
2093
+ api.add_operation(:describe_cache_report, Seahorse::Model::Operation.new.tap do |o|
2094
+ o.name = "DescribeCacheReport"
2095
+ o.http_method = "POST"
2096
+ o.http_request_uri = "/"
2097
+ o.input = Shapes::ShapeRef.new(shape: DescribeCacheReportInput)
2098
+ o.output = Shapes::ShapeRef.new(shape: DescribeCacheReportOutput)
2099
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGatewayRequestException)
2100
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
2101
+ end)
2102
+
1989
2103
  api.add_operation(:describe_cached_iscsi_volumes, Seahorse::Model::Operation.new.tap do |o|
1990
2104
  o.name = "DescribeCachediSCSIVolumes"
1991
2105
  o.http_method = "POST"
@@ -2220,6 +2334,16 @@ module Aws::StorageGateway
2220
2334
  o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
2221
2335
  end)
2222
2336
 
2337
+ api.add_operation(:list_cache_reports, Seahorse::Model::Operation.new.tap do |o|
2338
+ o.name = "ListCacheReports"
2339
+ o.http_method = "POST"
2340
+ o.http_request_uri = "/"
2341
+ o.input = Shapes::ShapeRef.new(shape: ListCacheReportsInput)
2342
+ o.output = Shapes::ShapeRef.new(shape: ListCacheReportsOutput)
2343
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGatewayRequestException)
2344
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
2345
+ end)
2346
+
2223
2347
  api.add_operation(:list_file_shares, Seahorse::Model::Operation.new.tap do |o|
2224
2348
  o.name = "ListFileShares"
2225
2349
  o.http_method = "POST"
@@ -2462,6 +2586,16 @@ module Aws::StorageGateway
2462
2586
  o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
2463
2587
  end)
2464
2588
 
2589
+ api.add_operation(:start_cache_report, Seahorse::Model::Operation.new.tap do |o|
2590
+ o.name = "StartCacheReport"
2591
+ o.http_method = "POST"
2592
+ o.http_request_uri = "/"
2593
+ o.input = Shapes::ShapeRef.new(shape: StartCacheReportInput)
2594
+ o.output = Shapes::ShapeRef.new(shape: StartCacheReportOutput)
2595
+ o.errors << Shapes::ShapeRef.new(shape: InvalidGatewayRequestException)
2596
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
2597
+ end)
2598
+
2465
2599
  api.add_operation(:start_gateway, Seahorse::Model::Operation.new.tap do |o|
2466
2600
  o.name = "StartGateway"
2467
2601
  o.http_method = "POST"
@@ -699,6 +699,122 @@ module Aws::StorageGateway
699
699
  include Aws::Structure
700
700
  end
701
701
 
702
+ # A list of filter parameters and associated values that determine which
703
+ # files are included or excluded from a cache report created by a
704
+ # `StartCacheReport` request. Multiple instances of the same filter
705
+ # parameter are combined with an OR operation, while different
706
+ # parameters are combined with an AND operation.
707
+ #
708
+ # @!attribute [rw] name
709
+ # The parameter name for a filter that determines which files are
710
+ # included or excluded from a cache report.
711
+ #
712
+ # **Valid Names:**
713
+ #
714
+ # UploadFailureReason \| UploadState
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] values
718
+ # The parameter value for a filter that determines which files are
719
+ # included or excluded from a cache report.
720
+ #
721
+ # **Valid `UploadFailureReason` Values:**
722
+ #
723
+ # `InaccessibleStorageClass` \| `InvalidObjectState` \|
724
+ # `ObjectMissing` \| `S3AccessDenied`
725
+ #
726
+ # **Valid `UploadState` Values:**
727
+ #
728
+ # `FailingUpload`
729
+ # @return [Array<String>]
730
+ #
731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CacheReportFilter AWS API Documentation
732
+ #
733
+ class CacheReportFilter < Struct.new(
734
+ :name,
735
+ :values)
736
+ SENSITIVE = []
737
+ include Aws::Structure
738
+ end
739
+
740
+ # Contains all informational fields associated with a cache report.
741
+ # Includes name, ARN, tags, status, progress, filters, start time, and
742
+ # end time.
743
+ #
744
+ # @!attribute [rw] cache_report_arn
745
+ # The Amazon Resource Name (ARN) of the cache report you want to
746
+ # describe.
747
+ # @return [String]
748
+ #
749
+ # @!attribute [rw] cache_report_status
750
+ # The status of the specified cache report.
751
+ # @return [String]
752
+ #
753
+ # @!attribute [rw] report_completion_percent
754
+ # The percentage of the report generation process that has been
755
+ # completed at time of inquiry.
756
+ # @return [Integer]
757
+ #
758
+ # @!attribute [rw] end_time
759
+ # The time at which the gateway stopped generating the cache report.
760
+ # @return [Time]
761
+ #
762
+ # @!attribute [rw] role
763
+ # The ARN of the IAM role that an S3 File Gateway assumes when it
764
+ # accesses the underlying storage.
765
+ # @return [String]
766
+ #
767
+ # @!attribute [rw] file_share_arn
768
+ # The Amazon Resource Name (ARN) of the file share.
769
+ # @return [String]
770
+ #
771
+ # @!attribute [rw] location_arn
772
+ # The ARN of the Amazon S3 bucket location where the cache report is
773
+ # saved.
774
+ # @return [String]
775
+ #
776
+ # @!attribute [rw] start_time
777
+ # The time at which the gateway started generating the cache report.
778
+ # @return [Time]
779
+ #
780
+ # @!attribute [rw] inclusion_filters
781
+ # The list of filters and parameters that determine which files are
782
+ # included in the report.
783
+ # @return [Array<Types::CacheReportFilter>]
784
+ #
785
+ # @!attribute [rw] exclusion_filters
786
+ # The list of filters and parameters that determine which files are
787
+ # excluded from the report.
788
+ # @return [Array<Types::CacheReportFilter>]
789
+ #
790
+ # @!attribute [rw] report_name
791
+ # The file name of the completed cache report object stored in Amazon
792
+ # S3.
793
+ # @return [String]
794
+ #
795
+ # @!attribute [rw] tags
796
+ # The list of key/value tags associated with the report.
797
+ # @return [Array<Types::Tag>]
798
+ #
799
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CacheReportInfo AWS API Documentation
800
+ #
801
+ class CacheReportInfo < Struct.new(
802
+ :cache_report_arn,
803
+ :cache_report_status,
804
+ :report_completion_percent,
805
+ :end_time,
806
+ :role,
807
+ :file_share_arn,
808
+ :location_arn,
809
+ :start_time,
810
+ :inclusion_filters,
811
+ :exclusion_filters,
812
+ :report_name,
813
+ :tags)
814
+ SENSITIVE = []
815
+ include Aws::Structure
816
+ end
817
+
702
818
  # Describes an iSCSI cached volume.
703
819
  #
704
820
  # @!attribute [rw] volume_arn
@@ -854,6 +970,32 @@ module Aws::StorageGateway
854
970
  include Aws::Structure
855
971
  end
856
972
 
973
+ # @!attribute [rw] cache_report_arn
974
+ # The Amazon Resource Name (ARN) of the cache report you want to
975
+ # cancel.
976
+ # @return [String]
977
+ #
978
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CancelCacheReportInput AWS API Documentation
979
+ #
980
+ class CancelCacheReportInput < Struct.new(
981
+ :cache_report_arn)
982
+ SENSITIVE = []
983
+ include Aws::Structure
984
+ end
985
+
986
+ # @!attribute [rw] cache_report_arn
987
+ # The Amazon Resource Name (ARN) of the cache report you want to
988
+ # cancel.
989
+ # @return [String]
990
+ #
991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CancelCacheReportOutput AWS API Documentation
992
+ #
993
+ class CancelCacheReportOutput < Struct.new(
994
+ :cache_report_arn)
995
+ SENSITIVE = []
996
+ include Aws::Structure
997
+ end
998
+
857
999
  # CancelRetrievalInput
858
1000
  #
859
1001
  # @!attribute [rw] gateway_arn
@@ -2288,6 +2430,32 @@ module Aws::StorageGateway
2288
2430
  include Aws::Structure
2289
2431
  end
2290
2432
 
2433
+ # @!attribute [rw] cache_report_arn
2434
+ # The Amazon Resource Name (ARN) of the cache report you want to
2435
+ # delete.
2436
+ # @return [String]
2437
+ #
2438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteCacheReportInput AWS API Documentation
2439
+ #
2440
+ class DeleteCacheReportInput < Struct.new(
2441
+ :cache_report_arn)
2442
+ SENSITIVE = []
2443
+ include Aws::Structure
2444
+ end
2445
+
2446
+ # @!attribute [rw] cache_report_arn
2447
+ # The Amazon Resource Name (ARN) of the cache report you want to
2448
+ # delete.
2449
+ # @return [String]
2450
+ #
2451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteCacheReportOutput AWS API Documentation
2452
+ #
2453
+ class DeleteCacheReportOutput < Struct.new(
2454
+ :cache_report_arn)
2455
+ SENSITIVE = []
2456
+ include Aws::Structure
2457
+ end
2458
+
2291
2459
  # A JSON object containing one or more of the following fields:
2292
2460
  #
2293
2461
  # * DeleteChapCredentialsInput$InitiatorName
@@ -2754,6 +2922,33 @@ module Aws::StorageGateway
2754
2922
  include Aws::Structure
2755
2923
  end
2756
2924
 
2925
+ # @!attribute [rw] cache_report_arn
2926
+ # The Amazon Resource Name (ARN) of the cache report you want to
2927
+ # describe.
2928
+ # @return [String]
2929
+ #
2930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCacheReportInput AWS API Documentation
2931
+ #
2932
+ class DescribeCacheReportInput < Struct.new(
2933
+ :cache_report_arn)
2934
+ SENSITIVE = []
2935
+ include Aws::Structure
2936
+ end
2937
+
2938
+ # @!attribute [rw] cache_report_info
2939
+ # Contains all informational fields associated with a cache report.
2940
+ # Includes name, ARN, tags, status, progress, filters, start time, and
2941
+ # end time.
2942
+ # @return [Types::CacheReportInfo]
2943
+ #
2944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCacheReportOutput AWS API Documentation
2945
+ #
2946
+ class DescribeCacheReportOutput < Struct.new(
2947
+ :cache_report_info)
2948
+ SENSITIVE = []
2949
+ include Aws::Structure
2950
+ end
2951
+
2757
2952
  # @!attribute [rw] volume_arns
2758
2953
  # An array of strings where each string represents the Amazon Resource
2759
2954
  # Name (ARN) of a cached volume. All of the specified cached volumes
@@ -3220,6 +3415,12 @@ module Aws::StorageGateway
3220
3415
  # Indicates the status of a gateway that is a member of the Active
3221
3416
  # Directory domain.
3222
3417
  #
3418
+ # <note markdown="1"> This field is only used as part of a `JoinDomain` request. It is not
3419
+ # affected by Active Directory connectivity changes that occur after
3420
+ # the `JoinDomain` request succeeds.
3421
+ #
3422
+ # </note>
3423
+ #
3223
3424
  # * `ACCESS_DENIED`: Indicates that the `JoinDomain` operation failed
3224
3425
  # due to an authentication error.
3225
3426
  #
@@ -4363,6 +4564,12 @@ module Aws::StorageGateway
4363
4564
  # Indicates the status of the gateway as a member of the Active
4364
4565
  # Directory domain.
4365
4566
  #
4567
+ # <note markdown="1"> This field is only used as part of a `JoinDomain` request. It is not
4568
+ # affected by Active Directory connectivity changes that occur after
4569
+ # the `JoinDomain` request succeeds.
4570
+ #
4571
+ # </note>
4572
+ #
4366
4573
  # * `ACCESS_DENIED`: Indicates that the `JoinDomain` operation failed
4367
4574
  # due to an authentication error.
4368
4575
  #
@@ -4420,6 +4627,41 @@ module Aws::StorageGateway
4420
4627
  include Aws::Structure
4421
4628
  end
4422
4629
 
4630
+ # @!attribute [rw] marker
4631
+ # Opaque pagination token returned from a previous `ListCacheReports`
4632
+ # operation. If present, `Marker` specifies where to continue the list
4633
+ # from after a previous call to `ListCacheReports`. Optional.
4634
+ # @return [String]
4635
+ #
4636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListCacheReportsInput AWS API Documentation
4637
+ #
4638
+ class ListCacheReportsInput < Struct.new(
4639
+ :marker)
4640
+ SENSITIVE = []
4641
+ include Aws::Structure
4642
+ end
4643
+
4644
+ # @!attribute [rw] cache_report_list
4645
+ # A list of existing cache reports for all file shares associated with
4646
+ # your Amazon Web Services account. This list includes all information
4647
+ # provided by the `DescribeCacheReport` action, such as report status,
4648
+ # completion progress, start time, end time, filters, and tags.
4649
+ # @return [Array<Types::CacheReportInfo>]
4650
+ #
4651
+ # @!attribute [rw] marker
4652
+ # If the request includes `Marker`, the response returns that value in
4653
+ # this field.
4654
+ # @return [String]
4655
+ #
4656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListCacheReportsOutput AWS API Documentation
4657
+ #
4658
+ class ListCacheReportsOutput < Struct.new(
4659
+ :cache_report_list,
4660
+ :marker)
4661
+ SENSITIVE = []
4662
+ include Aws::Structure
4663
+ end
4664
+
4423
4665
  # ListFileShareInput
4424
4666
  #
4425
4667
  # @!attribute [rw] gateway_arn
@@ -6088,6 +6330,93 @@ module Aws::StorageGateway
6088
6330
  include Aws::Structure
6089
6331
  end
6090
6332
 
6333
+ # @!attribute [rw] file_share_arn
6334
+ # The Amazon Resource Name (ARN) of the file share.
6335
+ # @return [String]
6336
+ #
6337
+ # @!attribute [rw] role
6338
+ # The ARN of the IAM role used when saving the cache report to Amazon
6339
+ # S3.
6340
+ # @return [String]
6341
+ #
6342
+ # @!attribute [rw] location_arn
6343
+ # The ARN of the Amazon S3 bucket where the cache report will be
6344
+ # saved.
6345
+ #
6346
+ # <note markdown="1"> We do not recommend saving the cache report to the same Amazon S3
6347
+ # bucket for which you are generating the report.
6348
+ #
6349
+ # This field does not accept access point ARNs.
6350
+ #
6351
+ # </note>
6352
+ # @return [String]
6353
+ #
6354
+ # @!attribute [rw] bucket_region
6355
+ # The Amazon Web Services Region of the Amazon S3 bucket associated
6356
+ # with the file share for which you want to generate the cache report.
6357
+ # @return [String]
6358
+ #
6359
+ # @!attribute [rw] vpc_endpoint_dns_name
6360
+ # The DNS name of the VPC endpoint associated with the Amazon S3 where
6361
+ # you want to save the cache report. Optional.
6362
+ # @return [String]
6363
+ #
6364
+ # @!attribute [rw] inclusion_filters
6365
+ # The list of filters and parameters that determine which files are
6366
+ # included in the report. You must specify at least one value for
6367
+ # `InclusionFilters` or `ExclusionFilters` in a `StartCacheReport`
6368
+ # request.
6369
+ # @return [Array<Types::CacheReportFilter>]
6370
+ #
6371
+ # @!attribute [rw] exclusion_filters
6372
+ # The list of filters and parameters that determine which files are
6373
+ # excluded from the report. You must specify at least one value for
6374
+ # `InclusionFilters` or `ExclusionFilters` in a `StartCacheReport`
6375
+ # request.
6376
+ # @return [Array<Types::CacheReportFilter>]
6377
+ #
6378
+ # @!attribute [rw] client_token
6379
+ # A unique identifier that you use to ensure idempotent report
6380
+ # generation if you need to retry an unsuccessful `StartCacheReport`
6381
+ # request. If you retry a request, use the same `ClientToken` you
6382
+ # specified in the initial request.
6383
+ # @return [String]
6384
+ #
6385
+ # @!attribute [rw] tags
6386
+ # A list of up to 50 key/value tags that you can assign to the cache
6387
+ # report. Using tags can help you categorize your reports and more
6388
+ # easily locate them in search results.
6389
+ # @return [Array<Types::Tag>]
6390
+ #
6391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartCacheReportInput AWS API Documentation
6392
+ #
6393
+ class StartCacheReportInput < Struct.new(
6394
+ :file_share_arn,
6395
+ :role,
6396
+ :location_arn,
6397
+ :bucket_region,
6398
+ :vpc_endpoint_dns_name,
6399
+ :inclusion_filters,
6400
+ :exclusion_filters,
6401
+ :client_token,
6402
+ :tags)
6403
+ SENSITIVE = []
6404
+ include Aws::Structure
6405
+ end
6406
+
6407
+ # @!attribute [rw] cache_report_arn
6408
+ # The Amazon Resource Name (ARN) of the cache report generated by the
6409
+ # `StartCacheReport` request.
6410
+ # @return [String]
6411
+ #
6412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartCacheReportOutput AWS API Documentation
6413
+ #
6414
+ class StartCacheReportOutput < Struct.new(
6415
+ :cache_report_arn)
6416
+ SENSITIVE = []
6417
+ include Aws::Structure
6418
+ end
6419
+
6091
6420
  # A JSON object containing the Amazon Resource Name (ARN) of the gateway
6092
6421
  # to start.
6093
6422
  #
@@ -54,7 +54,7 @@ module Aws::StorageGateway
54
54
  autoload :EndpointProvider, 'aws-sdk-storagegateway/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-storagegateway/endpoints'
56
56
 
57
- GEM_VERSION = '1.103.0'
57
+ GEM_VERSION = '1.104.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -214,6 +214,16 @@ module Aws
214
214
  ) -> _CancelArchivalResponseSuccess
215
215
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelArchivalResponseSuccess
216
216
 
217
+ interface _CancelCacheReportResponseSuccess
218
+ include ::Seahorse::Client::_ResponseSuccess[Types::CancelCacheReportOutput]
219
+ def cache_report_arn: () -> ::String
220
+ end
221
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/StorageGateway/Client.html#cancel_cache_report-instance_method
222
+ def cancel_cache_report: (
223
+ cache_report_arn: ::String
224
+ ) -> _CancelCacheReportResponseSuccess
225
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelCacheReportResponseSuccess
226
+
217
227
  interface _CancelRetrievalResponseSuccess
218
228
  include ::Seahorse::Client::_ResponseSuccess[Types::CancelRetrievalOutput]
219
229
  def tape_arn: () -> ::String
@@ -484,6 +494,16 @@ module Aws
484
494
  ) -> _DeleteBandwidthRateLimitResponseSuccess
485
495
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBandwidthRateLimitResponseSuccess
486
496
 
497
+ interface _DeleteCacheReportResponseSuccess
498
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteCacheReportOutput]
499
+ def cache_report_arn: () -> ::String
500
+ end
501
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/StorageGateway/Client.html#delete_cache_report-instance_method
502
+ def delete_cache_report: (
503
+ cache_report_arn: ::String
504
+ ) -> _DeleteCacheReportResponseSuccess
505
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteCacheReportResponseSuccess
506
+
487
507
  interface _DeleteChapCredentialsResponseSuccess
488
508
  include ::Seahorse::Client::_ResponseSuccess[Types::DeleteChapCredentialsOutput]
489
509
  def target_arn: () -> ::String
@@ -621,6 +641,16 @@ module Aws
621
641
  ) -> _DescribeCacheResponseSuccess
622
642
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCacheResponseSuccess
623
643
 
644
+ interface _DescribeCacheReportResponseSuccess
645
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeCacheReportOutput]
646
+ def cache_report_info: () -> Types::CacheReportInfo
647
+ end
648
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/StorageGateway/Client.html#describe_cache_report-instance_method
649
+ def describe_cache_report: (
650
+ cache_report_arn: ::String
651
+ ) -> _DescribeCacheReportResponseSuccess
652
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCacheReportResponseSuccess
653
+
624
654
  interface _DescribeCachediSCSIVolumesResponseSuccess
625
655
  include ::Seahorse::Client::_ResponseSuccess[Types::DescribeCachediSCSIVolumesOutput]
626
656
  def cached_iscsi_volumes: () -> ::Array[Types::CachediSCSIVolume]
@@ -900,6 +930,17 @@ module Aws
900
930
  ) -> _ListAutomaticTapeCreationPoliciesResponseSuccess
901
931
  | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAutomaticTapeCreationPoliciesResponseSuccess
902
932
 
933
+ interface _ListCacheReportsResponseSuccess
934
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListCacheReportsOutput]
935
+ def cache_report_list: () -> ::Array[Types::CacheReportInfo]
936
+ def marker: () -> ::String
937
+ end
938
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/StorageGateway/Client.html#list_cache_reports-instance_method
939
+ def list_cache_reports: (
940
+ ?marker: ::String
941
+ ) -> _ListCacheReportsResponseSuccess
942
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCacheReportsResponseSuccess
943
+
903
944
  interface _ListFileSharesResponseSuccess
904
945
  include ::Seahorse::Client::_ResponseSuccess[Types::ListFileSharesOutput]
905
946
  def marker: () -> ::String
@@ -1135,6 +1176,39 @@ module Aws
1135
1176
  ) -> _StartAvailabilityMonitorTestResponseSuccess
1136
1177
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartAvailabilityMonitorTestResponseSuccess
1137
1178
 
1179
+ interface _StartCacheReportResponseSuccess
1180
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartCacheReportOutput]
1181
+ def cache_report_arn: () -> ::String
1182
+ end
1183
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/StorageGateway/Client.html#start_cache_report-instance_method
1184
+ def start_cache_report: (
1185
+ file_share_arn: ::String,
1186
+ role: ::String,
1187
+ location_arn: ::String,
1188
+ bucket_region: ::String,
1189
+ ?vpc_endpoint_dns_name: ::String,
1190
+ ?inclusion_filters: Array[
1191
+ {
1192
+ name: ("UploadState" | "UploadFailureReason"),
1193
+ values: Array[::String]
1194
+ },
1195
+ ],
1196
+ ?exclusion_filters: Array[
1197
+ {
1198
+ name: ("UploadState" | "UploadFailureReason"),
1199
+ values: Array[::String]
1200
+ },
1201
+ ],
1202
+ client_token: ::String,
1203
+ ?tags: Array[
1204
+ {
1205
+ key: ::String,
1206
+ value: ::String
1207
+ },
1208
+ ]
1209
+ ) -> _StartCacheReportResponseSuccess
1210
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCacheReportResponseSuccess
1211
+
1138
1212
  interface _StartGatewayResponseSuccess
1139
1213
  include ::Seahorse::Client::_ResponseSuccess[Types::StartGatewayOutput]
1140
1214
  def gateway_arn: () -> ::String
data/sig/types.rbs CHANGED
@@ -145,6 +145,28 @@ module Aws::StorageGateway
145
145
  SENSITIVE: []
146
146
  end
147
147
 
148
+ class CacheReportFilter
149
+ attr_accessor name: ("UploadState" | "UploadFailureReason")
150
+ attr_accessor values: ::Array[::String]
151
+ SENSITIVE: []
152
+ end
153
+
154
+ class CacheReportInfo
155
+ attr_accessor cache_report_arn: ::String
156
+ attr_accessor cache_report_status: ("IN_PROGRESS" | "COMPLETED" | "CANCELED" | "FAILED" | "ERROR")
157
+ attr_accessor report_completion_percent: ::Integer
158
+ attr_accessor end_time: ::Time
159
+ attr_accessor role: ::String
160
+ attr_accessor file_share_arn: ::String
161
+ attr_accessor location_arn: ::String
162
+ attr_accessor start_time: ::Time
163
+ attr_accessor inclusion_filters: ::Array[Types::CacheReportFilter]
164
+ attr_accessor exclusion_filters: ::Array[Types::CacheReportFilter]
165
+ attr_accessor report_name: ::String
166
+ attr_accessor tags: ::Array[Types::Tag]
167
+ SENSITIVE: []
168
+ end
169
+
148
170
  class CachediSCSIVolume
149
171
  attr_accessor volume_arn: ::String
150
172
  attr_accessor volume_id: ::String
@@ -173,6 +195,16 @@ module Aws::StorageGateway
173
195
  SENSITIVE: []
174
196
  end
175
197
 
198
+ class CancelCacheReportInput
199
+ attr_accessor cache_report_arn: ::String
200
+ SENSITIVE: []
201
+ end
202
+
203
+ class CancelCacheReportOutput
204
+ attr_accessor cache_report_arn: ::String
205
+ SENSITIVE: []
206
+ end
207
+
176
208
  class CancelRetrievalInput
177
209
  attr_accessor gateway_arn: ::String
178
210
  attr_accessor tape_arn: ::String
@@ -397,6 +429,16 @@ module Aws::StorageGateway
397
429
  SENSITIVE: []
398
430
  end
399
431
 
432
+ class DeleteCacheReportInput
433
+ attr_accessor cache_report_arn: ::String
434
+ SENSITIVE: []
435
+ end
436
+
437
+ class DeleteCacheReportOutput
438
+ attr_accessor cache_report_arn: ::String
439
+ SENSITIVE: []
440
+ end
441
+
400
442
  class DeleteChapCredentialsInput
401
443
  attr_accessor target_arn: ::String
402
444
  attr_accessor initiator_name: ::String
@@ -534,6 +576,16 @@ module Aws::StorageGateway
534
576
  SENSITIVE: []
535
577
  end
536
578
 
579
+ class DescribeCacheReportInput
580
+ attr_accessor cache_report_arn: ::String
581
+ SENSITIVE: []
582
+ end
583
+
584
+ class DescribeCacheReportOutput
585
+ attr_accessor cache_report_info: Types::CacheReportInfo
586
+ SENSITIVE: []
587
+ end
588
+
537
589
  class DescribeCachediSCSIVolumesInput
538
590
  attr_accessor volume_arns: ::Array[::String]
539
591
  SENSITIVE: []
@@ -900,6 +952,17 @@ module Aws::StorageGateway
900
952
  SENSITIVE: []
901
953
  end
902
954
 
955
+ class ListCacheReportsInput
956
+ attr_accessor marker: ::String
957
+ SENSITIVE: []
958
+ end
959
+
960
+ class ListCacheReportsOutput
961
+ attr_accessor cache_report_list: ::Array[Types::CacheReportInfo]
962
+ attr_accessor marker: ::String
963
+ SENSITIVE: []
964
+ end
965
+
903
966
  class ListFileSharesInput
904
967
  attr_accessor gateway_arn: ::String
905
968
  attr_accessor limit: ::Integer
@@ -1239,6 +1302,24 @@ module Aws::StorageGateway
1239
1302
  SENSITIVE: []
1240
1303
  end
1241
1304
 
1305
+ class StartCacheReportInput
1306
+ attr_accessor file_share_arn: ::String
1307
+ attr_accessor role: ::String
1308
+ attr_accessor location_arn: ::String
1309
+ attr_accessor bucket_region: ::String
1310
+ attr_accessor vpc_endpoint_dns_name: ::String
1311
+ attr_accessor inclusion_filters: ::Array[Types::CacheReportFilter]
1312
+ attr_accessor exclusion_filters: ::Array[Types::CacheReportFilter]
1313
+ attr_accessor client_token: ::String
1314
+ attr_accessor tags: ::Array[Types::Tag]
1315
+ SENSITIVE: []
1316
+ end
1317
+
1318
+ class StartCacheReportOutput
1319
+ attr_accessor cache_report_arn: ::String
1320
+ SENSITIVE: []
1321
+ end
1322
+
1242
1323
  class StartGatewayInput
1243
1324
  attr_accessor gateway_arn: ::String
1244
1325
  SENSITIVE: []
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-storagegateway
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.103.0
4
+ version: 1.104.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-02-06 00:00:00.000000000 Z
11
+ date: 2025-02-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core