From 17be15546ab428da324517d247b64c97187a1481 Mon Sep 17 00:00:00 2001 From: awssdkgo Date: Fri, 12 Jun 2020 18:19:03 +0000 Subject: [PATCH] Release v1.32.1 (2020-06-12) === ### Service Client Updates * `service/apigateway`: Updates service documentation * Documentation updates for Amazon API Gateway * `service/cloudformation`: Updates service documentation * The following parameters now return the organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets: the OrganizationalUnitIds parameter on StackSet and the OrganizationalUnitId parameter on StackInstance, StackInstanceSummary, and StackSetOperationResultSummary * `service/glue`: Updates service API and documentation * You can now choose to crawl the entire table or just a sample of records in DynamoDB when using AWS Glue crawlers. Additionally, you can also specify a scanning rate for crawling DynamoDB tables. * `service/storagegateway`: Updates service API and documentation * Display EndpointType in DescribeGatewayInformation --- CHANGELOG.md | 13 + aws/version.go | 2 +- models/apis/apigateway/2015-07-09/docs-2.json | 12 +- .../cloudformation/2010-05-15/docs-2.json | 12 +- models/apis/glue/2017-03-31/api-2.json | 4 +- models/apis/glue/2017-03-31/docs-2.json | 32 +- .../apis/storagegateway/2013-06-30/api-2.json | 8 +- .../storagegateway/2013-06-30/docs-2.json | 354 ++++++----- service/apigateway/api.go | 35 +- service/cloudformation/api.go | 29 +- service/glue/api.go | 91 ++- service/storagegateway/api.go | 595 +++++++++++------- service/storagegateway/doc.go | 12 +- 13 files changed, 699 insertions(+), 500 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 96db4f877ef..c394b299c32 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +Release v1.32.1 (2020-06-12) +=== + +### Service Client Updates +* `service/apigateway`: Updates service documentation + * Documentation updates for Amazon API Gateway +* `service/cloudformation`: Updates service documentation + * The following parameters now return the organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets: the OrganizationalUnitIds parameter on StackSet and the OrganizationalUnitId parameter on StackInstance, StackInstanceSummary, and StackSetOperationResultSummary +* `service/glue`: Updates service API and documentation + * You can now choose to crawl the entire table or just a sample of records in DynamoDB when using AWS Glue crawlers. Additionally, you can also specify a scanning rate for crawling DynamoDB tables. +* `service/storagegateway`: Updates service API and documentation + * Display EndpointType in DescribeGatewayInformation + Release v1.32.0 (2020-06-11) === diff --git a/aws/version.go b/aws/version.go index de4208c3de6..c224e76922d 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.32.0" +const SDKVersion = "1.32.1" diff --git a/models/apis/apigateway/2015-07-09/docs-2.json b/models/apis/apigateway/2015-07-09/docs-2.json index 24229492bba..5f8557d0bc4 100644 --- a/models/apis/apigateway/2015-07-09/docs-2.json +++ b/models/apis/apigateway/2015-07-09/docs-2.json @@ -210,8 +210,8 @@ "ExportResponse$body": "

The binary blob response to GetExport, which contains the export.

", "ImportApiKeysRequest$body": "

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

", "ImportDocumentationPartsRequest$body": "

[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

", - "ImportRestApiRequest$body": "

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

", - "PutRestApiRequest$body": "

[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

", + "ImportRestApiRequest$body": "

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

", + "PutRestApiRequest$body": "

[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

", "SdkResponse$body": "

The binary blob response to GetSdk, which contains the generated SDK.

" } }, @@ -245,7 +245,7 @@ "SdkConfigurationProperty$required": "

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

", "Stage$cacheClusterEnabled": "

Specifies whether a cache cluster is enabled for the stage.

", "Stage$tracingEnabled": "

Specifies whether active tracing with X-ray is enabled for the Stage.

", - "TlsConfig$insecureSkipVerification": "

Specifies whether API Gateway skips trust chain validation of the server certificate during the TLS handshake. Supported only for HTTP and HTTP_PROXY integrations. By default, API Gateway validates that certificates for integration endpoints are issued by a supported Certificate Authority. If enabled, API Gateway skips trust chain validation of the server certificate. This is not recommended, but it enables you to use certificates that are signed by private Certificate Authorities, or certificates that are self-signed.

" + "TlsConfig$insecureSkipVerification": "

Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations.

" } }, "CacheClusterSize": { @@ -1083,7 +1083,7 @@ "Integration$cacheKeyParameters": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

", "MapOfStringToList$value": null, "Method$authorizationScopes": "

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", - "PutIntegrationRequest$cacheKeyParameters": "

An API-specific tag group of related cached parameters.

", + "PutIntegrationRequest$cacheKeyParameters": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

", "PutMethodRequest$authorizationScopes": "

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", "RestApi$warnings": "

The warning messages reported when failonwarnings is turned on during API import.

", "RestApi$binaryMediaTypes": "

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

", @@ -1758,7 +1758,7 @@ "Integration$connectionId": "

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

", "Integration$credentials": "

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\\*:user/\\*. To use resource-based permissions on supported AWS services, specify null.

", "Integration$passthroughBehavior": "

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

", - "Integration$cacheNamespace": "

An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

", + "Integration$cacheNamespace": "

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

", "IntegrationResponse$selectionPattern": "

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

", "LimitExceededException$retryAfterSeconds": null, "LimitExceededException$message": null, @@ -1801,7 +1801,7 @@ "PutIntegrationRequest$connectionId": "

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

", "PutIntegrationRequest$credentials": "

Specifies whether credentials are required for a put integration.

", "PutIntegrationRequest$passthroughBehavior": "

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

", - "PutIntegrationRequest$cacheNamespace": "

A list of request parameters whose values are to be cached.

", + "PutIntegrationRequest$cacheNamespace": "

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

", "PutIntegrationResponseRequest$restApiId": "

[Required] The string identifier of the associated RestApi.

", "PutIntegrationResponseRequest$resourceId": "

[Required] Specifies a put integration response request's resource identifier.

", "PutIntegrationResponseRequest$httpMethod": "

[Required] Specifies a put integration response request's HTTP method.

", diff --git a/models/apis/cloudformation/2010-05-15/docs-2.json b/models/apis/cloudformation/2010-05-15/docs-2.json index 2650ec7883b..44a802e3452 100644 --- a/models/apis/cloudformation/2010-05-15/docs-2.json +++ b/models/apis/cloudformation/2010-05-15/docs-2.json @@ -1048,7 +1048,7 @@ "MaxConcurrentCount": { "base": null, "refs": { - "StackSetOperationPreferences$MaxConcurrentCount": "

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount .

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

" + "StackSetOperationPreferences$MaxConcurrentCount": "

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

" } }, "MaxConcurrentPercentage": { @@ -1193,16 +1193,16 @@ "base": null, "refs": { "OrganizationalUnitIdList$member": null, - "StackInstance$OrganizationalUnitId": "

Reserved for internal use. No data returned.

", - "StackInstanceSummary$OrganizationalUnitId": "

Reserved for internal use. No data returned.

", - "StackSetOperationResultSummary$OrganizationalUnitId": "

Reserved for internal use. No data returned.

" + "StackInstance$OrganizationalUnitId": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

", + "StackInstanceSummary$OrganizationalUnitId": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

", + "StackSetOperationResultSummary$OrganizationalUnitId": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" } }, "OrganizationalUnitIdList": { "base": null, "refs": { "DeploymentTargets$OrganizationalUnitIds": "

The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

", - "StackSet$OrganizationalUnitIds": "

Reserved for internal use. No data returned.

" + "StackSet$OrganizationalUnitIds": "

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" } }, "Output": { @@ -1682,7 +1682,7 @@ "refs": { "DescribeTypeOutput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.

", "LoggingConfig$LogRoleArn": "

The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

", - "RegisterTypeInput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.

" + "RegisterTypeInput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource provider handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource provider handler, thereby supplying your resource provider with the appropriate credentials.

" } }, "RollbackConfiguration": { diff --git a/models/apis/glue/2017-03-31/api-2.json b/models/apis/glue/2017-03-31/api-2.json index 7803c407f82..36ed4f716c0 100644 --- a/models/apis/glue/2017-03-31/api-2.json +++ b/models/apis/glue/2017-03-31/api-2.json @@ -3430,7 +3430,9 @@ "DynamoDBTarget":{ "type":"structure", "members":{ - "Path":{"shape":"Path"} + "Path":{"shape":"Path"}, + "scanAll":{"shape":"NullableBoolean"}, + "scanRate":{"shape":"NullableDouble"} } }, "DynamoDBTargetList":{ diff --git a/models/apis/glue/2017-03-31/docs-2.json b/models/apis/glue/2017-03-31/docs-2.json index 0ff5521b480..e6dbc0e92db 100644 --- a/models/apis/glue/2017-03-31/docs-2.json +++ b/models/apis/glue/2017-03-31/docs-2.json @@ -742,9 +742,9 @@ "CrawlerConfiguration": { "base": null, "refs": { - "Crawler$Configuration": "

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

", - "CreateCrawlerRequest$Configuration": "

The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

", - "UpdateCrawlerRequest$Configuration": "

The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

" + "Crawler$Configuration": "

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

", + "CreateCrawlerRequest$Configuration": "

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

", + "UpdateCrawlerRequest$Configuration": "

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

" } }, "CrawlerList": { @@ -985,10 +985,10 @@ "CronExpression": { "base": null, "refs": { - "CreateCrawlerRequest$Schedule": "

A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

", - "Schedule$ScheduleExpression": "

A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

", - "UpdateCrawlerRequest$Schedule": "

A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

", - "UpdateCrawlerScheduleRequest$Schedule": "

The updated cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

" + "CreateCrawlerRequest$Schedule": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

", + "Schedule$ScheduleExpression": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

", + "UpdateCrawlerRequest$Schedule": "

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

", + "UpdateCrawlerScheduleRequest$Schedule": "

The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

" } }, "CsvClassifier": { @@ -1033,7 +1033,7 @@ "base": null, "refs": { "CreateGrokClassifierRequest$CustomPatterns": "

Optional custom grok patterns used by this classifier.

", - "GrokClassifier$CustomPatterns": "

Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.

", + "GrokClassifier$CustomPatterns": "

Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.

", "UpdateGrokClassifierRequest$CustomPatterns": "

Optional custom grok patterns used by this classifier.

" } }, @@ -2062,7 +2062,7 @@ "base": null, "refs": { "CreateGrokClassifierRequest$GrokPattern": "

The grok pattern used by this classifier.

", - "GrokClassifier$GrokPattern": "

The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.

", + "GrokClassifier$GrokPattern": "

The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.

", "UpdateGrokClassifierRequest$GrokPattern": "

The grok pattern used by this classifier.

" } }, @@ -2311,9 +2311,9 @@ "JsonPath": { "base": null, "refs": { - "CreateJsonClassifierRequest$JsonPath": "

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

", - "JsonClassifier$JsonPath": "

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

", - "UpdateJsonClassifierRequest$JsonPath": "

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" + "CreateJsonClassifierRequest$JsonPath": "

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

", + "JsonClassifier$JsonPath": "

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

", + "UpdateJsonClassifierRequest$JsonPath": "

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" } }, "JsonValue": { @@ -2849,6 +2849,7 @@ "CreateCsvClassifierRequest$AllowSingleColumn": "

Enables the processing of files that contain only one column.

", "CsvClassifier$DisableValueTrimming": "

Specifies not to trim values before identifying the type of column values. The default value is true.

", "CsvClassifier$AllowSingleColumn": "

Enables the processing of files that contain only one column.

", + "DynamoDBTarget$scanAll": "

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

", "FindMatchesParameters$EnforceProvidedLabels": "

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.

Note that setting this value to true may increase the conflation execution time.

", "GetWorkflowRequest$IncludeGraph": "

Specifies whether to include a graph when returning the workflow resource metadata.

", "GetWorkflowRunRequest$IncludeGraph": "

Specifies whether to include the workflow graph in response or not.

", @@ -2862,6 +2863,7 @@ "refs": { "CreateJobRequest$MaxCapacity": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

", "CreateMLTransformRequest$MaxCapacity": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

", + "DynamoDBTarget$scanRate": "

The percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

", "GetMLTransformResponse$MaxCapacity": "

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

", "Job$MaxCapacity": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

", "JobRun$MaxCapacity": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

", @@ -3035,8 +3037,8 @@ "PathList": { "base": null, "refs": { - "JdbcTarget$Exclusions": "

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

", - "S3Target$Exclusions": "

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

" + "JdbcTarget$Exclusions": "

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

", + "S3Target$Exclusions": "

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

" } }, "Permission": { @@ -3689,7 +3691,7 @@ "TagsMap": { "base": null, "refs": { - "CreateCrawlerRequest$Tags": "

The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.

", + "CreateCrawlerRequest$Tags": "

The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

", "CreateDevEndpointRequest$Tags": "

The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

", "CreateJobRequest$Tags": "

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

", "CreateMLTransformRequest$Tags": "

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

", diff --git a/models/apis/storagegateway/2013-06-30/api-2.json b/models/apis/storagegateway/2013-06-30/api-2.json index a14da5ec0ae..6bb35a76e53 100644 --- a/models/apis/storagegateway/2013-06-30/api-2.json +++ b/models/apis/storagegateway/2013-06-30/api-2.json @@ -1781,7 +1781,8 @@ "Tags":{"shape":"Tags"}, "VPCEndpoint":{"shape":"string"}, "CloudWatchLogGroupARN":{"shape":"CloudWatchLogGroupARN"}, - "HostEnvironment":{"shape":"HostEnvironment"} + "HostEnvironment":{"shape":"HostEnvironment"}, + "EndpointType":{"shape":"EndpointType"} } }, "DescribeMaintenanceStartTimeInput":{ @@ -2085,6 +2086,11 @@ "DoubleObject":{"type":"double"}, "Ec2InstanceId":{"type":"string"}, "Ec2InstanceRegion":{"type":"string"}, + "EndpointType":{ + "type":"string", + "max":8, + "min":4 + }, "ErrorCode":{ "type":"string", "enum":[ diff --git a/models/apis/storagegateway/2013-06-30/docs-2.json b/models/apis/storagegateway/2013-06-30/docs-2.json index fd8c47b1638..6d8684370d9 100644 --- a/models/apis/storagegateway/2013-06-30/docs-2.json +++ b/models/apis/storagegateway/2013-06-30/docs-2.json @@ -1,35 +1,35 @@ { "version": "2.0", - "service": "AWS Storage Gateway Service

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS Cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the AWS Storage Gateway Service API Reference:

AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

", + "service": "AWS Storage Gateway Service

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS Cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the AWS Storage Gateway Service API Reference:

AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS resource IDs.

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

", "operations": { - "ActivateGateway": "

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

You must turn on the gateway VM before you can activate your gateway.

", - "AddCache": "

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts).

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

", + "ActivateGateway": "

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.

You must turn on the gateway VM before you can activate your gateway.

", + "AddCache": "

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape, and file gateway type (see How AWS Storage Gateway works (architecture).

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

", "AddTagsToResource": "

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

", "AddUploadBuffer": "

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

", "AddWorkingStorage": "

Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

", - "AssignTapePool": "

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", + "AssignTapePool": "

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

", "AttachVolume": "

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

", "CancelArchival": "

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.

", "CancelRetrieval": "

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

", - "CreateCachediSCSIVolume": "

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

", - "CreateNFSFileShare": "

Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for file gateways.

File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateway does not support creating hard or symbolic links on a file share.

", - "CreateSMBFileShare": "

Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using an SMB interface. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

", - "CreateSnapshot": "

Initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage Service (Amazon S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take an ad hoc snapshot. For more information, see Editing a Snapshot Schedule.

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

", - "CreateSnapshotFromVolumeRecoveryPoint": "

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

", + "CreateCachediSCSIVolume": "

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

", + "CreateNFSFileShare": "

Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for file gateways.

File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateway does not support creating hard or symbolic links on a file share.

", + "CreateSMBFileShare": "

Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using an SMB interface. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

", + "CreateSnapshot": "

Initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a snapshot schedule.

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

", + "CreateSnapshotFromVolumeRecoveryPoint": "

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

", "CreateStorediSCSIVolume": "

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

", - "CreateTapeWithBarcode": "

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

", - "CreateTapes": "

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

", - "DeleteAutomaticTapeCreationPolicy": "

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

", + "CreateTapeWithBarcode": "

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

", + "CreateTapes": "

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

", + "DeleteAutomaticTapeCreationPolicy": "

Deletes the automatic tape creation policy of a gateway. If you delete this policy, new virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway in your request to remove the policy.

", "DeleteBandwidthRateLimit": "

Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported for the stored volume, cached volume and tape gateway types.

", "DeleteChapCredentials": "

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.

", "DeleteFileShare": "

Deletes a file share from a file gateway. This operation is only supported for file gateways.

", - "DeleteGateway": "

Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.

", - "DeleteSnapshotSchedule": "

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

", + "DeleteGateway": "

Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway detail page.

", + "DeleteSnapshotSchedule": "

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

", "DeleteTape": "

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

", "DeleteTapeArchive": "

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

", - "DeleteVolume": "

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

", + "DeleteVolume": "

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

", "DescribeAvailabilityMonitorTest": "

Returns information about the most recent High Availability monitoring test that was performed on the host in a cluster. If a test isn't performed, the status and start time in the response would be null.

", - "DescribeBandwidthRateLimit": "

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume and tape gateway types.'

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

", + "DescribeBandwidthRateLimit": "

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported for the stored volume, cached volume and tape gateway types.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

", "DescribeCache": "

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

", "DescribeCachediSCSIVolumes": "

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

The list of gateway volumes in the request must be from one gateway. In the response, AWS Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

", "DescribeChapCredentials": "

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway types.

", @@ -39,17 +39,17 @@ "DescribeSMBFileShares": "

Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.

", "DescribeSMBSettings": "

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

", "DescribeSnapshotSchedule": "

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

", - "DescribeStorediSCSIVolumes": "

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

", + "DescribeStorediSCSIVolumes": "

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, AWS Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

", "DescribeTapeArchives": "

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

", "DescribeTapeRecoveryPoints": "

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.

", "DescribeTapes": "

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

", - "DescribeUploadBuffer": "

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

", + "DescribeUploadBuffer": "

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

", "DescribeVTLDevices": "

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway type.

", "DescribeWorkingStorage": "

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

", "DetachVolume": "

Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.

", "DisableGateway": "

Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

After a gateway is disabled, it cannot be enabled.

", "JoinDomain": "

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

", - "ListAutomaticTapeCreationPolicies": "

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

This operation is only supported for tape gateways.

", + "ListAutomaticTapeCreationPolicies": "

Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.

This operation is only supported for tape gateways.

", "ListFileShares": "

Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.

", "ListGateways": "

Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

", "ListLocalDisks": "

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

", @@ -58,32 +58,32 @@ "ListVolumeInitiators": "

Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

", "ListVolumeRecoveryPoints": "

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

", "ListVolumes": "

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

", - "NotifyWhenUploaded": "

Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways.

For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).

", - "RefreshCache": "

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations.

When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes.

Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting Notified About File Operations.

If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

For more information, see \"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\".

", + "NotifyWhenUploaded": "

Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways.

For more information, see Getting file upload notification in the AWS Storage Gateway User Guide.

", + "RefreshCache": "

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes.

Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

", "RemoveTagsFromResource": "

Removes one or more tags from the specified resource. This operation is supported in storage gateways of all types.

", "ResetCache": "

Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

", "RetrieveTapeArchive": "

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

", "RetrieveTapeRecoveryPoint": "

Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.

", "SetLocalConsolePassword": "

Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

", "SetSMBGuestPassword": "

Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.

", - "ShutdownGateway": "

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

", - "StartAvailabilityMonitorTest": "

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

Starting this test will cause your gateway to go offline for a brief period.

", + "ShutdownGateway": "

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

", + "StartAvailabilityMonitorTest": "

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

Starting this test will cause your gateway to go offline for a brief period.

", "StartGateway": "

Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

", "UpdateAutomaticTapeCreationPolicy": "

Updates the automatic tape creation policy of a gateway. Use this to update the policy with a new set of automatic tape creation rules. This is only supported for tape gateways.

By default, there is no automatic tape creation policy.

A gateway can have only one automatic tape creation policy.

", - "UpdateBandwidthRateLimit": "

Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported for the stored volume, cached volume and tape gateway types.'

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

", + "UpdateBandwidthRateLimit": "

Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported for the stored volume, cached volume, and tape gateway types.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

", "UpdateChapCredentials": "

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is supported in the volume and tape gateway types.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

", "UpdateGatewayInformation": "

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

", - "UpdateGatewaySoftwareNow": "

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.

", + "UpdateGatewaySoftwareNow": "

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.

", "UpdateMaintenanceStartTime": "

Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

", "UpdateNFSFileShare": "

Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.

To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share setting:

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.

", - "UpdateSMBFileShare": "

Updates a Server Message Block (SMB) file share.

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

", + "UpdateSMBFileShare": "

Updates a Server Message Block (SMB) file share.

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

", "UpdateSMBSecurityStrategy": "

Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

This API is called Security level in the User Guide.

A higher security level can affect performance of the gateway.

", "UpdateSnapshotSchedule": "

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

", "UpdateVTLDeviceType": "

Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.

" }, "shapes": { "ActivateGatewayInput": { - "base": "

A JSON object containing one or more of the following fields:

", + "base": "

A JSON object containing one or more of the following fields:

", "refs": { } }, @@ -95,14 +95,14 @@ "ActivationKey": { "base": null, "refs": { - "ActivateGatewayInput$ActivationKey": "

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.

" + "ActivateGatewayInput$ActivationKey": "

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the AWS Storage Gateway User Guide.

" } }, "ActiveDirectoryStatus": { "base": null, "refs": { - "DescribeSMBSettingsOutput$ActiveDirectoryStatus": "

Indicates the status of a gateway that is a member of the Active Directory domain.

", - "JoinDomainOutput$ActiveDirectoryStatus": "

Indicates the status of the gateway as a member of the Active Directory domain.

" + "DescribeSMBSettingsOutput$ActiveDirectoryStatus": "

Indicates the status of a gateway that is a member of the Active Directory domain.

", + "JoinDomainOutput$ActiveDirectoryStatus": "

Indicates the status of the gateway as a member of the Active Directory domain.

" } }, "AddCacheInput": { @@ -174,9 +174,9 @@ } }, "Authentication": { - "base": "

The authentication method of the file share.

Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

", + "base": "

The authentication method of the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

", "refs": { - "CreateSMBFileShareInput$Authentication": "

The authentication method that users use to access the file share.

Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

", + "CreateSMBFileShareInput$Authentication": "

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

", "SMBFileShareInfo$Authentication": null } }, @@ -202,7 +202,7 @@ "base": null, "refs": { "AutomaticTapeCreationPolicyInfo$AutomaticTapeCreationRules": "

An automatic tape creation policy consists of a list of automatic tape creation rules. This returns the rules that determine when and how to automatically create new tapes.

", - "UpdateAutomaticTapeCreationPolicyInput$AutomaticTapeCreationRules": "

An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.

" + "UpdateAutomaticTapeCreationPolicyInput$AutomaticTapeCreationRules": "

An automatic tape creation policy consists of a list of automatic tape creation rules. The rules determine when and how to automatically create new tapes.

" } }, "AvailabilityMonitorTestStatus": { @@ -221,7 +221,7 @@ "BandwidthType": { "base": null, "refs": { - "DeleteBandwidthRateLimitInput$BandwidthType": "

One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

Valid Values: Upload, Download, All.

" + "DeleteBandwidthRateLimitInput$BandwidthType": "

One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

Valid Values: Upload | Download | All

" } }, "BandwidthUploadRateLimit": { @@ -234,38 +234,38 @@ "Boolean": { "base": null, "refs": { - "CreateCachediSCSIVolumeInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "CreateNFSFileShareInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "CreateNFSFileShareInput$ReadOnly": "

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

", - "CreateNFSFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

", - "CreateNFSFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

", - "CreateSMBFileShareInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "CreateSMBFileShareInput$ReadOnly": "

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

", - "CreateSMBFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

", - "CreateSMBFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

", - "CreateSMBFileShareInput$SMBACLEnabled": "

Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.

", - "CreateStorediSCSIVolumeInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "CreateTapeWithBarcodeInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "CreateTapesInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "DescribeSMBSettingsOutput$SMBGuestPasswordSet": "

This value is true if a password for the guest user “smbguest” is set, and otherwise false.

", - "DetachVolumeInput$ForceDetach": "

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

", - "NFSFileShareInfo$ReadOnly": "

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

", - "NFSFileShareInfo$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

", - "NFSFileShareInfo$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

", - "RefreshCacheInput$Recursive": "

A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to \"true\", each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is \"true\".

", - "SMBFileShareInfo$ReadOnly": "

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

", - "SMBFileShareInfo$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

", - "SMBFileShareInfo$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

", - "SMBFileShareInfo$SMBACLEnabled": "

If this value is set to \"true\", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to \"false\", it indicates that file and directory permissions are mapped to the POSIX permission.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.

", - "UpdateNFSFileShareInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "UpdateNFSFileShareInput$ReadOnly": "

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

", - "UpdateNFSFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

", - "UpdateNFSFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

", - "UpdateSMBFileShareInput$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "UpdateSMBFileShareInput$ReadOnly": "

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

", - "UpdateSMBFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

", - "UpdateSMBFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

", - "UpdateSMBFileShareInput$SMBACLEnabled": "

Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.

" + "CreateCachediSCSIVolumeInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "CreateNFSFileShareInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "CreateNFSFileShareInput$ReadOnly": "

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

", + "CreateNFSFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

", + "CreateNFSFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

", + "CreateSMBFileShareInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "CreateSMBFileShareInput$ReadOnly": "

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

", + "CreateSMBFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

", + "CreateSMBFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

", + "CreateSMBFileShareInput$SMBACLEnabled": "

Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide.

Valid Values: true | false

", + "CreateStorediSCSIVolumeInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "CreateTapeWithBarcodeInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "CreateTapesInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "DescribeSMBSettingsOutput$SMBGuestPasswordSet": "

This value is true if a password for the guest user smbguest is set, otherwise false.

Valid Values: true | false

", + "DetachVolumeInput$ForceDetach": "

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

", + "NFSFileShareInfo$ReadOnly": "

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

", + "NFSFileShareInfo$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

", + "NFSFileShareInfo$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

", + "RefreshCacheInput$Recursive": "

A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.

Valid Values: true | false

", + "SMBFileShareInfo$ReadOnly": "

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

", + "SMBFileShareInfo$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

", + "SMBFileShareInfo$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

", + "SMBFileShareInfo$SMBACLEnabled": "

If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide.

", + "UpdateNFSFileShareInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "UpdateNFSFileShareInput$ReadOnly": "

A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

Valid Values: true | false

", + "UpdateNFSFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

", + "UpdateNFSFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

", + "UpdateSMBFileShareInput$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "UpdateSMBFileShareInput$ReadOnly": "

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

", + "UpdateSMBFileShareInput$GuessMIMETypeEnabled": "

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

", + "UpdateSMBFileShareInput$RequesterPays": "

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

", + "UpdateSMBFileShareInput$SMBACLEnabled": "

Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide.

Valid Values: true | false

" } }, "CachediSCSIVolume": { @@ -334,7 +334,7 @@ "base": null, "refs": { "DescribeGatewayInformationOutput$CloudWatchLogGroupARN": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Log Group that is used to monitor events in the gateway.

", - "UpdateGatewayInformationInput$CloudWatchLogGroupARN": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

For more information, see What Is Amazon CloudWatch Logs?.

" + "UpdateGatewayInformationInput$CloudWatchLogGroupARN": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

For more information, see What is Amazon CloudWatch logs?.

" } }, "CreateCachediSCSIVolumeInput": { @@ -427,8 +427,8 @@ "DayOfMonth": { "base": null, "refs": { - "DescribeMaintenanceStartTimeOutput$DayOfMonth": "

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

This value is only available for tape and volume gateways.

", - "UpdateMaintenanceStartTimeInput$DayOfMonth": "

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

This value is only available for tape and volume gateways.

" + "DescribeMaintenanceStartTimeOutput$DayOfMonth": "

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

", + "UpdateMaintenanceStartTimeInput$DayOfMonth": "

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

" } }, "DayOfWeek": { @@ -524,7 +524,7 @@ } }, "DeleteVolumeOutput": { - "base": "

A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted

", + "base": "

A JSON object containing the Amazon Resource Name (ARN) of the storage volume that was deleted.

", "refs": { } }, @@ -574,7 +574,7 @@ } }, "DescribeChapCredentialsOutput": { - "base": "

A JSON object containing a .

", + "base": "

A JSON object containing the following fields:

", "refs": { } }, @@ -728,7 +728,7 @@ "DeviceType": { "base": null, "refs": { - "UpdateVTLDeviceTypeInput$DeviceType": "

The type of medium changer you want to select.

Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"

" + "UpdateVTLDeviceTypeInput$DeviceType": "

The type of medium changer you want to select.

Valid Values: STK-L700 | AWS-Gateway-VTL

" } }, "DeviceiSCSIAttributes": { @@ -754,7 +754,7 @@ } }, "DiskAllocationType": { - "base": "

One of the DiskAllocationType enumeration values that identifies how a local disk is used. Valid values: UPLOAD_BUFFER, CACHE_STORAGE

", + "base": "

One of the DiskAllocationType enumeration values that identifies how a local disk is used.

Valid Values: UPLOAD_BUFFER | CACHE_STORAGE

", "refs": { "Disk$DiskAllocationType": null } @@ -839,6 +839,12 @@ "GatewayInfo$Ec2InstanceRegion": "

The AWS Region where the Amazon EC2 instance is located.

" } }, + "EndpointType": { + "base": null, + "refs": { + "DescribeGatewayInformationOutput$EndpointType": "

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

" + } + }, "ErrorCode": { "base": null, "refs": { @@ -846,12 +852,12 @@ } }, "FileShareARN": { - "base": "

The Amazon Resource Name (ARN) of the file share.

", + "base": "

The Amazon Resource Name (ARN) of the file share.

", "refs": { - "CreateNFSFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the newly created file share.

", - "CreateSMBFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the newly created file share.

", - "DeleteFileShareInput$FileShareARN": "

The Amazon Resource Name (ARN) of the file share to be deleted.

", - "DeleteFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the deleted file share.

", + "CreateNFSFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the newly created file share.

", + "CreateSMBFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the newly created file share.

", + "DeleteFileShareInput$FileShareARN": "

The Amazon Resource Name (ARN) of the file share to be deleted.

", + "DeleteFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the deleted file share.

", "FileShareARNList$member": null, "FileShareInfo$FileShareARN": null, "NFSFileShareInfo$FileShareARN": null, @@ -860,29 +866,29 @@ "RefreshCacheInput$FileShareARN": "

The Amazon Resource Name (ARN) of the file share you want to refresh.

", "RefreshCacheOutput$FileShareARN": null, "SMBFileShareInfo$FileShareARN": null, - "UpdateNFSFileShareInput$FileShareARN": "

The Amazon Resource Name (ARN) of the file share to be updated.

", - "UpdateNFSFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the updated file share.

", + "UpdateNFSFileShareInput$FileShareARN": "

The Amazon Resource Name (ARN) of the file share to be updated.

", + "UpdateNFSFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the updated file share.

", "UpdateSMBFileShareInput$FileShareARN": "

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

", - "UpdateSMBFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the updated SMB file share.

" + "UpdateSMBFileShareOutput$FileShareARN": "

The Amazon Resource Name (ARN) of the updated SMB file share.

" } }, "FileShareARNList": { "base": null, "refs": { - "DescribeNFSFileSharesInput$FileShareARNList": "

An array containing the Amazon Resource Name (ARN) of each file share to be described.

", - "DescribeSMBFileSharesInput$FileShareARNList": "

An array containing the Amazon Resource Name (ARN) of each file share to be described.

" + "DescribeNFSFileSharesInput$FileShareARNList": "

An array containing the Amazon Resource Name (ARN) of each file share to be described.

", + "DescribeSMBFileSharesInput$FileShareARNList": "

An array containing the Amazon Resource Name (ARN) of each file share to be described.

" } }, "FileShareClientList": { - "base": "

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

", + "base": "

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

", "refs": { - "CreateNFSFileShareInput$ClientList": "

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

", + "CreateNFSFileShareInput$ClientList": "

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

", "NFSFileShareInfo$ClientList": null, "UpdateNFSFileShareInput$ClientList": "

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

" } }, "FileShareId": { - "base": "

The ID of the file share.

", + "base": "

The ID of the file share.

", "refs": { "FileShareInfo$FileShareId": null, "NFSFileShareInfo$FileShareId": null, @@ -898,11 +904,11 @@ "FileShareInfoList": { "base": null, "refs": { - "ListFileSharesOutput$FileShareInfoList": "

An array of information about the file gateway's file shares.

" + "ListFileSharesOutput$FileShareInfoList": "

An array of information about the file gateway's file shares.

" } }, "FileShareStatus": { - "base": "

The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

", + "base": "

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

", "refs": { "FileShareInfo$FileShareStatus": null, "NFSFileShareInfo$FileShareStatus": null, @@ -924,14 +930,14 @@ "FileShareUserList": { "base": null, "refs": { - "CreateSMBFileShareInput$AdminUserList": "

A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

", - "CreateSMBFileShareInput$ValidUserList": "

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

", + "CreateSMBFileShareInput$AdminUserList": "

A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

", + "CreateSMBFileShareInput$ValidUserList": "

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

", "CreateSMBFileShareInput$InvalidUserList": "

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

", "SMBFileShareInfo$AdminUserList": "

A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

", - "SMBFileShareInfo$ValidUserList": "

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

", + "SMBFileShareInfo$ValidUserList": "

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

", "SMBFileShareInfo$InvalidUserList": "

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

", - "UpdateSMBFileShareInput$AdminUserList": "

A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

", - "UpdateSMBFileShareInput$ValidUserList": "

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

", + "UpdateSMBFileShareInput$AdminUserList": "

A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

", + "UpdateSMBFileShareInput$ValidUserList": "

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

", "UpdateSMBFileShareInput$InvalidUserList": "

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

" } }, @@ -944,7 +950,7 @@ "FolderList": { "base": null, "refs": { - "RefreshCacheInput$FolderList": "

A comma-separated list of the paths of folders to refresh in the cache. The default is [\"/\"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to \"true\", the entire S3 bucket that the file share has access to is refreshed.

" + "RefreshCacheInput$FolderList": "

A comma-separated list of the paths of folders to refresh in the cache. The default is [\"/\"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.

" } }, "GatewayARN": { @@ -1047,7 +1053,7 @@ "refs": { "DescribeGatewayInformationOutput$GatewayId": "

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

", "GatewayInfo$GatewayId": "

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

", - "VolumeInfo$GatewayId": "

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" + "VolumeInfo$GatewayId": "

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" } }, "GatewayInfo": { @@ -1072,7 +1078,7 @@ "GatewayOperationalState": { "base": null, "refs": { - "GatewayInfo$GatewayOperationalState": "

The state of the gateway.

Valid Values: DISABLED or ACTIVE

" + "GatewayInfo$GatewayOperationalState": "

The state of the gateway.

Valid Values: DISABLED | ACTIVE

" } }, "GatewayState": { @@ -1094,7 +1100,7 @@ "GatewayType": { "base": null, "refs": { - "ActivateGatewayInput$GatewayType": "

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: \"STORED\", \"CACHED\", \"VTL\", \"FILE_S3\"

", + "ActivateGatewayInput$GatewayType": "

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3

", "DescribeGatewayInformationOutput$GatewayType": "

The type of the gateway.

", "GatewayInfo$GatewayType": "

The type of the gateway.

" } @@ -1181,22 +1187,22 @@ } }, "KMSKey": { - "base": "

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", + "base": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", "refs": { "CachediSCSIVolume$KMSKey": null, - "CreateCachediSCSIVolumeInput$KMSKey": "

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", - "CreateNFSFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", - "CreateSMBFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", - "CreateStorediSCSIVolumeInput$KMSKey": "

The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", - "CreateTapeWithBarcodeInput$KMSKey": "

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", - "CreateTapesInput$KMSKey": "

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", + "CreateCachediSCSIVolumeInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", + "CreateNFSFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", + "CreateSMBFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", + "CreateStorediSCSIVolumeInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", + "CreateTapeWithBarcodeInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", + "CreateTapesInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", "NFSFileShareInfo$KMSKey": null, "SMBFileShareInfo$KMSKey": null, "StorediSCSIVolume$KMSKey": null, "Tape$KMSKey": null, "TapeArchive$KMSKey": null, - "UpdateNFSFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

", - "UpdateSMBFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side encryption. This value can only be set when KMSEncrypted is true. Optional.

" + "UpdateNFSFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", + "UpdateSMBFileShareInput$KMSKey": "

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

" } }, "LastSoftwareUpdate": { @@ -1302,10 +1308,10 @@ } }, "LocationARN": { - "base": "

The ARN of the backend storage used for storing file data.

", + "base": "

The ARN of the backend storage used for storing file data.

", "refs": { - "CreateNFSFileShareInput$LocationARN": "

The ARN of the backed storage used for storing file data.

", - "CreateSMBFileShareInput$LocationARN": "

The ARN of the backed storage used for storing file data.

", + "CreateNFSFileShareInput$LocationARN": "

The ARN of the backed storage used for storing file data.

", + "CreateSMBFileShareInput$LocationARN": "

The ARN of the backed storage used for storing file data.

", "NFSFileShareInfo$LocationARN": null, "SMBFileShareInfo$LocationARN": null } @@ -1317,13 +1323,13 @@ "DescribeTapeArchivesOutput$Marker": "

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

", "DescribeTapeRecoveryPointsInput$Marker": "

An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

", "DescribeTapeRecoveryPointsOutput$Marker": "

An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

", - "DescribeTapesInput$Marker": "

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

", + "DescribeTapesInput$Marker": "

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

", "DescribeTapesOutput$Marker": "

An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

If a response does not contain a marker, then there are no more results to be retrieved.

", "DescribeVTLDevicesInput$Marker": "

An opaque string that indicates the position at which to begin describing the VTL devices.

", "DescribeVTLDevicesOutput$Marker": "

An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

", "ListFileSharesInput$Marker": "

Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.

", - "ListFileSharesOutput$Marker": "

If the request includes Marker, the response returns that value in this field.

", - "ListFileSharesOutput$NextMarker": "

If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

", + "ListFileSharesOutput$Marker": "

If the request includes Marker, the response returns that value in this field.

", + "ListFileSharesOutput$NextMarker": "

If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

", "ListGatewaysInput$Marker": "

An opaque string that indicates the position at which to begin the returned list of gateways.

", "ListGatewaysOutput$Marker": "

Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.

", "ListTagsForResourceInput$Marker": "

An opaque string that indicates the position at which to begin returning the list of tags.

", @@ -1337,7 +1343,7 @@ "MediumChangerType": { "base": null, "refs": { - "ActivateGatewayInput$MediumChangerType": "

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"

" + "ActivateGatewayInput$MediumChangerType": "

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL

" } }, "MinimumNumTapes": { @@ -1370,7 +1376,7 @@ "NFSFileShareInfoList": { "base": null, "refs": { - "DescribeNFSFileSharesOutput$NFSFileShareInfoList": "

An array containing a description for each requested file share.

" + "DescribeNFSFileSharesOutput$NFSFileShareInfoList": "

An array containing a description for each requested file share.

" } }, "NetworkInterface": { @@ -1382,9 +1388,9 @@ "NetworkInterfaceId": { "base": null, "refs": { - "AttachVolumeInput$NetworkInterfaceId": "

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

", - "CreateCachediSCSIVolumeInput$NetworkInterfaceId": "

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

", - "CreateStorediSCSIVolumeInput$NetworkInterfaceId": "

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

", + "AttachVolumeInput$NetworkInterfaceId": "

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

", + "CreateCachediSCSIVolumeInput$NetworkInterfaceId": "

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

", + "CreateStorediSCSIVolumeInput$NetworkInterfaceId": "

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

", "DeviceiSCSIAttributes$NetworkInterfaceId": "

The network interface identifier of the VTL device.

", "VolumeiSCSIAttributes$NetworkInterfaceId": "

The network interface identifier.

" } @@ -1419,14 +1425,14 @@ } }, "ObjectACL": { - "base": "

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

", + "base": "

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

", "refs": { - "CreateNFSFileShareInput$ObjectACL": "

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

", - "CreateSMBFileShareInput$ObjectACL": "

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

", + "CreateNFSFileShareInput$ObjectACL": "

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

", + "CreateSMBFileShareInput$ObjectACL": "

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

", "NFSFileShareInfo$ObjectACL": null, "SMBFileShareInfo$ObjectACL": null, - "UpdateNFSFileShareInput$ObjectACL": "

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

", - "UpdateSMBFileShareInput$ObjectACL": "

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

" + "UpdateNFSFileShareInput$ObjectACL": "

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

", + "UpdateSMBFileShareInput$ObjectACL": "

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

" } }, "OrganizationalUnit": { @@ -1436,7 +1442,7 @@ } }, "Path": { - "base": "

The file share path used by the NFS client to identify the mount point.

", + "base": "

The file share path used by the NFS client to identify the mount point.

", "refs": { "NFSFileShareInfo$Path": null, "SMBFileShareInfo$Path": "

The file share path used by the SMB client to identify the mount point.

" @@ -1445,27 +1451,27 @@ "PermissionId": { "base": null, "refs": { - "NFSFileShareDefaults$GroupId": "

The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

", - "NFSFileShareDefaults$OwnerId": "

The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

" + "NFSFileShareDefaults$GroupId": "

The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

", + "NFSFileShareDefaults$OwnerId": "

The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

" } }, "PermissionMode": { "base": null, "refs": { - "NFSFileShareDefaults$FileMode": "

The Unix file mode in the form \"nnnn\". For example, \"0666\" represents the default file mode inside the file share. The default value is 0666.

", - "NFSFileShareDefaults$DirectoryMode": "

The Unix directory mode in the form \"nnnn\". For example, \"0666\" represents the default access mode for all directories inside the file share. The default value is 0777.

" + "NFSFileShareDefaults$FileMode": "

The Unix file mode in the form \"nnnn\". For example, 0666 represents the default file mode inside the file share. The default value is 0666.

", + "NFSFileShareDefaults$DirectoryMode": "

The Unix directory mode in the form \"nnnn\". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777.

" } }, "PoolId": { "base": null, "refs": { - "AssignTapePoolInput$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", - "AutomaticTapeCreationRule$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", - "CreateTapeWithBarcodeInput$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", - "CreateTapesInput$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", - "Tape$PoolId": "

The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S# Glacier Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", - "TapeArchive$PoolId": "

The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", - "TapeInfo$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

" + "AssignTapePoolInput$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

", + "AutomaticTapeCreationRule$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the Amazon S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

", + "CreateTapeWithBarcodeInput$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

", + "CreateTapesInput$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

", + "Tape$PoolId": "

The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

", + "TapeArchive$PoolId": "

The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

", + "TapeInfo$PoolId": "

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

Valid Values: GLACIER | DEEP_ARCHIVE

" } }, "PositiveIntObject": { @@ -1503,7 +1509,7 @@ "RegionId": { "base": null, "refs": { - "ActivateGatewayInput$GatewayRegion": "

A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your Host header in the request. For more information about available AWS Regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

Valid Values: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference.

" + "ActivateGatewayInput$GatewayRegion": "

A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your Host header in the request. For more information about available AWS Regions and endpoints for AWS Storage Gateway, see AWS Storage Gateway endpoints and quotas in the AWS General Reference.

Valid Values: See AWS Storage Gateway endpoints and quotas in the AWS General Reference.

" } }, "RemoveTagsFromResourceInput": { @@ -1558,10 +1564,10 @@ } }, "Role": { - "base": "

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

", + "base": "

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

", "refs": { - "CreateNFSFileShareInput$Role": "

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

", - "CreateSMBFileShareInput$Role": "

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

", + "CreateNFSFileShareInput$Role": "

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

", + "CreateSMBFileShareInput$Role": "

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

", "NFSFileShareInfo$Role": null, "SMBFileShareInfo$Role": null } @@ -1575,20 +1581,20 @@ "SMBFileShareInfoList": { "base": null, "refs": { - "DescribeSMBFileSharesOutput$SMBFileShareInfoList": "

An array containing a description for each requested file share.

" + "DescribeSMBFileSharesOutput$SMBFileShareInfoList": "

An array containing a description for each requested file share.

" } }, "SMBGuestPassword": { "base": null, "refs": { - "SetSMBGuestPasswordInput$Password": "

The password that you want to set for your SMB Server.

" + "SetSMBGuestPasswordInput$Password": "

The password that you want to set for your SMB server.

" } }, "SMBSecurityStrategy": { "base": null, "refs": { - "DescribeSMBSettingsOutput$SMBSecurityStrategy": "

The type of security strategy that was specified for file gateway.

ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment.

MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

", - "UpdateSMBSecurityStrategyInput$SMBSecurityStrategy": "

Specifies the type of security strategy.

ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment.

MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

" + "DescribeSMBSettingsOutput$SMBSecurityStrategy": "

The type of security strategy that was specified for file gateway.

", + "UpdateSMBSecurityStrategyInput$SMBSecurityStrategy": "

Specifies the type of security strategy.

ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment.

MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

" } }, "ServiceUnavailableError": { @@ -1629,27 +1635,27 @@ "SnapshotDescription": { "base": null, "refs": { - "CreateSnapshotFromVolumeRecoveryPointInput$SnapshotDescription": "

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

", - "CreateSnapshotInput$SnapshotDescription": "

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

" + "CreateSnapshotFromVolumeRecoveryPointInput$SnapshotDescription": "

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

", + "CreateSnapshotInput$SnapshotDescription": "

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

" } }, "SnapshotId": { "base": null, "refs": { "CachediSCSIVolume$SourceSnapshotId": "

If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

", - "CreateCachediSCSIVolumeInput$SnapshotId": "

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

", + "CreateCachediSCSIVolumeInput$SnapshotId": "

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

", "CreateSnapshotFromVolumeRecoveryPointOutput$SnapshotId": "

The ID of the snapshot.

", "CreateSnapshotOutput$SnapshotId": "

The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).

", - "CreateStorediSCSIVolumeInput$SnapshotId": "

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

", + "CreateStorediSCSIVolumeInput$SnapshotId": "

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

", "StorediSCSIVolume$SourceSnapshotId": "

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

" } }, "Squash": { - "base": "

The user mapped to anonymous user. Valid options are the following:

", + "base": "

The user mapped to anonymous user. Valid options are the following:

", "refs": { - "CreateNFSFileShareInput$Squash": "

A value that maps a user to anonymous user. Valid options are the following:

", + "CreateNFSFileShareInput$Squash": "

A value that maps a user to anonymous user.

Valid values are the following:

", "NFSFileShareInfo$Squash": null, - "UpdateNFSFileShareInput$Squash": "

The user mapped to anonymous user. Valid options are the following:

" + "UpdateNFSFileShareInput$Squash": "

The user mapped to anonymous user.

Valid values are the following:

" } }, "StartAvailabilityMonitorTestInput": { @@ -1675,12 +1681,12 @@ "StorageClass": { "base": "

", "refs": { - "CreateNFSFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

", - "CreateSMBFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

", - "NFSFileShareInfo$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

", - "SMBFileShareInfo$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

", - "UpdateNFSFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

", - "UpdateSMBFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

" + "CreateNFSFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

", + "CreateSMBFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

", + "NFSFileShareInfo$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

", + "SMBFileShareInfo$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

", + "UpdateNFSFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

", + "UpdateSMBFileShareInput$DefaultStorageClass": "

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

" } }, "StorageGatewayError": { @@ -1700,11 +1706,11 @@ "StorediSCSIVolumes": { "base": null, "refs": { - "DescribeStorediSCSIVolumesOutput$StorediSCSIVolumes": "

Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

" + "DescribeStorediSCSIVolumesOutput$StorediSCSIVolumes": "

Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

" } }, "Tag": { - "base": "

A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /

", + "base": "

A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

", "refs": { "Tags$member": null } @@ -1712,7 +1718,7 @@ "TagKey": { "base": null, "refs": { - "Tag$Key": "

Tag key (String). The key can't start with aws:.

", + "Tag$Key": "

Tag key. The key can't start with aws:.

", "TagKeys$member": null } }, @@ -1804,7 +1810,7 @@ "TapeArchives": { "base": null, "refs": { - "DescribeTapeArchivesOutput$TapeArchives": "

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

" + "DescribeTapeArchivesOutput$TapeArchives": "

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.

" } }, "TapeBarcode": { @@ -1826,7 +1832,7 @@ "TapeDriveType": { "base": null, "refs": { - "ActivateGatewayInput$TapeDriveType": "

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: \"IBM-ULT3580-TD5\"

" + "ActivateGatewayInput$TapeDriveType": "

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

" } }, "TapeInfo": { @@ -1895,7 +1901,7 @@ "base": null, "refs": { "AttachVolumeOutput$TargetARN": "

The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.

", - "ChapInfo$TargetARN": "

The Amazon Resource Name (ARN) of the volume.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

", + "ChapInfo$TargetARN": "

The Amazon Resource Name (ARN) of the volume.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

", "CreateCachediSCSIVolumeOutput$TargetARN": "

The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

", "CreateStorediSCSIVolumeOutput$TargetARN": "

The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

", "DeleteChapCredentialsInput$TargetARN": "

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

", @@ -1969,7 +1975,7 @@ } }, "UpdateGatewayInformationOutput": { - "base": "

A JSON object containing the ARN of the gateway that was updated.

", + "base": "

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.

", "refs": { } }, @@ -2115,7 +2121,7 @@ "UpdateSnapshotScheduleInput$VolumeARN": "

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

", "UpdateSnapshotScheduleOutput$VolumeARN": "

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

", "VolumeARNs$member": null, - "VolumeInfo$VolumeARN": "

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

", + "VolumeInfo$VolumeARN": "

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

", "VolumeRecoveryPointInfo$VolumeARN": "

The Amazon Resource Name (ARN) of the volume target.

" } }, @@ -2129,9 +2135,9 @@ "VolumeAttachmentStatus": { "base": null, "refs": { - "CachediSCSIVolume$VolumeAttachmentStatus": "

A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving Your Volumes to a Different Gateway.

", - "StorediSCSIVolume$VolumeAttachmentStatus": "

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving Your Volumes to a Different Gateway.

", - "VolumeInfo$VolumeAttachmentStatus": "

One of the VolumeStatus values that indicates the state of the storage volume.

" + "CachediSCSIVolume$VolumeAttachmentStatus": "

A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving your volumes to a different gateway.

", + "StorediSCSIVolume$VolumeAttachmentStatus": "

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

", + "VolumeInfo$VolumeAttachmentStatus": "

One of the VolumeStatus values that indicates the state of the storage volume.

" } }, "VolumeId": { @@ -2139,7 +2145,7 @@ "refs": { "CachediSCSIVolume$VolumeId": "

The unique identifier of the volume, e.g. vol-AE4B946D.

", "StorediSCSIVolume$VolumeId": "

The unique identifier of the volume, e.g. vol-AE4B946D.

", - "VolumeInfo$VolumeId": "

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" + "VolumeInfo$VolumeId": "

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" } }, "VolumeInfo": { @@ -2198,12 +2204,12 @@ "boolean": { "base": null, "refs": { - "CreateStorediSCSIVolumeInput$PreserveExistingData": "

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

Valid Values: true, false

", - "DeleteFileShareInput$ForceDelete": "

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

", + "CreateStorediSCSIVolumeInput$PreserveExistingData": "

Set to true true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

", + "DeleteFileShareInput$ForceDelete": "

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Valid Values: true | false

", "DeviceiSCSIAttributes$ChapEnabled": "

Indicates whether mutual CHAP is enabled for the iSCSI target.

", - "NFSFileShareInfo$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "SMBFileShareInfo$KMSEncrypted": "

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

", - "StorediSCSIVolume$PreservedExistingData": "

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true, false

", + "NFSFileShareInfo$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "SMBFileShareInfo$KMSEncrypted": "

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

", + "StorediSCSIVolume$PreservedExistingData": "

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

", "VolumeiSCSIAttributes$ChapEnabled": "

Indicates whether mutual CHAP is enabled for the iSCSI target.

" } }, @@ -2252,11 +2258,11 @@ "refs": { "CreateSnapshotFromVolumeRecoveryPointOutput$VolumeRecoveryPointTime": "

The time the volume was created from the recovery point.

", "DescribeGatewayInformationOutput$GatewayName": "

The name you configured for your gateway.

", - "DescribeGatewayInformationOutput$VPCEndpoint": "

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

", + "DescribeGatewayInformationOutput$VPCEndpoint": "

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

", "Disk$DiskPath": "

The path of a local disk in the gateway virtual machine (VM).

", "Disk$DiskNode": "

The device node of a local disk as assigned by the virtualization environment.

", "Disk$DiskStatus": "

A value that represents the status of a local disk.

", - "Disk$DiskAllocationResource": "

The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

", + "Disk$DiskAllocationResource": "

The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

", "GatewayInfo$GatewayName": "

The name of the gateway.

", "InternalServerError$message": "

A human-readable message describing the error that occurred.

", "InvalidGatewayRequestException$message": "

A human-readable message describing the error that occurred.

", diff --git a/service/apigateway/api.go b/service/apigateway/api.go index f8c99673177..751c10ab453 100644 --- a/service/apigateway/api.go +++ b/service/apigateway/api.go @@ -19847,7 +19847,7 @@ type ImportRestApiInput struct { // [Required] The POST request body containing external API definitions. Currently, // only OpenAPI definition JSON/YAML files are supported. The maximum size of - // the API definition file is 2MB. + // the API definition file is 6MB. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` @@ -19936,9 +19936,10 @@ type Integration struct { // Method requestParameters. CacheKeyParameters []*string `locationName:"cacheKeyParameters" type:"list"` - // An API-specific tag group of related cached parameters. To be valid values - // for cacheKeyParameters, these parameters must also be specified for Method - // requestParameters. + // Specifies a group of related cached parameters. By default, API Gateway uses + // the resource ID as the cacheNamespace. You can specify the same cacheNamespace + // across resources to return the same cached data for requests to different + // resources. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) @@ -21201,10 +21202,15 @@ func (s *PutGatewayResponseInput) SetStatusCode(v string) *PutGatewayResponseInp type PutIntegrationInput struct { _ struct{} `type:"structure"` - // An API-specific tag group of related cached parameters. + // A list of request parameters whose values API Gateway caches. To be valid + // values for cacheKeyParameters, these parameters must also be specified for + // Method requestParameters. CacheKeyParameters []*string `locationName:"cacheKeyParameters" type:"list"` - // A list of request parameters whose values are to be cached. + // Specifies a group of related cached parameters. By default, API Gateway uses + // the resource ID as the cacheNamespace. You can specify the same cacheNamespace + // across resources to return the same cached data for requests to different + // resources. CacheNamespace *string `locationName:"cacheNamespace" type:"string"` // The (id (https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id)) @@ -21917,7 +21923,7 @@ type PutRestApiInput struct { // [Required] The PUT request body containing external API definitions. Currently, // only OpenAPI definition JSON/YAML files are supported. The maximum size of - // the API definition file is 2MB. + // the API definition file is 6MB. // // Body is a required field Body []byte `locationName:"body" type:"blob" required:"true"` @@ -23198,13 +23204,14 @@ func (s *ThrottleSettings) SetRateLimit(v float64) *ThrottleSettings { type TlsConfig struct { _ struct{} `type:"structure"` - // Specifies whether API Gateway skips trust chain validation of the server - // certificate during the TLS handshake. Supported only for HTTP and HTTP_PROXY - // integrations. By default, API Gateway validates that certificates for integration - // endpoints are issued by a supported Certificate Authority (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html). - // If enabled, API Gateway skips trust chain validation of the server certificate. - // This is not recommended, but it enables you to use certificates that are - // signed by private Certificate Authorities, or certificates that are self-signed. + // Specifies whether or not API Gateway skips verification that the certificate + // for an integration endpoint is issued by a supported certificate authority + // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html). + // This isn’t recommended, but it enables you to use certificates that are + // signed by private certificate authorities, or certificates that are self-signed. + // If enabled, API Gateway still performs basic certificate validation, which + // includes checking the certificate's expiration date, hostname, and presence + // of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations. InsecureSkipVerification *bool `locationName:"insecureSkipVerification" type:"boolean"` } diff --git a/service/cloudformation/api.go b/service/cloudformation/api.go index a5761751c29..9e3d7de99c9 100644 --- a/service/cloudformation/api.go +++ b/service/cloudformation/api.go @@ -12155,12 +12155,15 @@ type RegisterTypeInput struct { // if the request is submitted multiple times. ClientRequestToken *string `min:"1" type:"string"` - // The Amazon Resource Name (ARN) of the IAM execution role to use to register - // the type. If your resource type calls AWS APIs in any of its handlers, you - // must create an IAM execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) + // The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume + // when invoking the resource provider. If your resource type calls AWS APIs + // in any of its handlers, you must create an IAM execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) // that includes the necessary permissions to call those AWS APIs, and provision - // that execution role in your account. CloudFormation then assumes that execution - // role to provide your resource type with the appropriate credentials. + // that execution role in your account. When CloudFormation needs to invoke + // the resource provider handler, CloudFormation assumes this execution role + // to create a temporary session token, which it then passes to the resource + // provider handler, thereby supplying your resource provider with the appropriate + // credentials. ExecutionRoleArn *string `min:"1" type:"string"` // Specifies logging configuration information for a type. @@ -13633,7 +13636,8 @@ type StackInstance struct { // which drift detection has not yet been performed. LastDriftCheckTimestamp *time.Time `type:"timestamp"` - // Reserved for internal use. No data returned. + // [Service-managed permissions] The organization root ID or organizational + // unit (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). OrganizationalUnitId *string `type:"string"` // A list of parameters from the stack set template whose values have been overridden @@ -13772,7 +13776,8 @@ type StackInstanceSummary struct { // which drift detection has not yet been performed. LastDriftCheckTimestamp *time.Time `type:"timestamp"` - // Reserved for internal use. No data returned. + // [Service-managed permissions] The organization root ID or organizational + // unit (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). OrganizationalUnitId *string `type:"string"` // The name of the AWS Region that the stack instance is associated with. @@ -14505,7 +14510,8 @@ type StackSet struct { // groups can include in their stack sets. ExecutionRoleName *string `min:"1" type:"string"` - // Reserved for internal use. No data returned. + // [Service-managed permissions] The organization root ID or organizational + // unit (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). OrganizationalUnitIds []*string `type:"list"` // A list of input parameters for a stack set. @@ -14995,8 +15001,8 @@ type StackSetOperationPreferences struct { FailureTolerancePercentage *int64 `type:"integer"` // The maximum number of accounts in which to perform this operation at one - // time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount - // is at most one more than the FailureToleranceCount . + // time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount + // is at most one more than the FailureToleranceCount. // // Note that this setting lets you specify the maximum for operations. For large // deployments, under certain circumstances the actual number of accounts acted @@ -15095,7 +15101,8 @@ type StackSetOperationResultSummary struct { // before proceeding with stack set operations in an account AccountGateResult *AccountGateResult `type:"structure"` - // Reserved for internal use. No data returned. + // [Service-managed permissions] The organization root ID or organizational + // unit (OU) IDs that you specified for DeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). OrganizationalUnitId *string `type:"string"` // The name of the AWS Region for this operation result. diff --git a/service/glue/api.go b/service/glue/api.go index 3b645e18131..d0b610e1f93 100644 --- a/service/glue/api.go +++ b/service/glue/api.go @@ -15560,7 +15560,7 @@ type Crawler struct { // Crawler configuration information. This versioned JSON string allows users // to specify aspects of a crawler's behavior. For more information, see Configuring - // a Crawler (http://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). + // a Crawler (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). Configuration *string `type:"string"` // If the crawler is running, contains the total time elapsed since the last @@ -16250,9 +16250,9 @@ type CreateCrawlerInput struct { // always override the default classifiers for a given classification. Classifiers []*string `type:"list"` - // The crawler configuration information. This versioned JSON string allows - // users to specify aspects of a crawler's behavior. For more information, see - // Configuring a Crawler (http://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). + // Crawler configuration information. This versioned JSON string allows users + // to specify aspects of a crawler's behavior. For more information, see Configuring + // a Crawler (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). Configuration *string `type:"string"` // The name of the SecurityConfiguration structure to be used by this crawler. @@ -16275,10 +16275,10 @@ type CreateCrawlerInput struct { // Role is a required field Role *string `type:"string" required:"true"` - // A cron expression used to specify the schedule. For more information, see - // Time-Based Schedules for Jobs and Crawlers (http://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, specify cron(15 12 - // * * ? *). + // A cron expression used to specify the schedule (see Time-Based Schedules + // for Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). + // For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *). Schedule *string `type:"string"` // The policy for the crawler's update and deletion behavior. @@ -16287,8 +16287,10 @@ type CreateCrawlerInput struct { // The table prefix used for catalog tables that are created. TablePrefix *string `type:"string"` - // The tags to use with this crawler request. You can use tags to limit access - // to the crawler. For more information, see AWS Tags in AWS Glue (http://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html). + // The tags to use with this crawler request. You may use tags to limit access + // to the crawler. For more information about tags in AWS Glue, see AWS Tags + // in AWS Glue (https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) + // in the developer guide. Tags map[string]*string `type:"map"` // A list of collection of targets to crawl. @@ -20311,6 +20313,25 @@ type DynamoDBTarget struct { // The name of the DynamoDB table to crawl. Path *string `type:"string"` + + // Indicates whether to scan all the records, or to sample rows from the table. + // Scanning all the records can take a long time when the table is not a high + // throughput table. + // + // A value of true means to scan all records, while a value of false means to + // sample the records. If no value is specified, the value defaults to true. + ScanAll *bool `locationName:"scanAll" type:"boolean"` + + // The percentage of the configured read capacity units to use by the AWS Glue + // crawler. Read capacity units is a term defined by DynamoDB, and is a numeric + // value that acts as rate limiter for the number of reads that can be performed + // on that table per second. + // + // The valid values are null or a value between 0.1 to 1.5. A null value is + // used when user does not provide a value, and defaults to 0.5 of the configured + // Read Capacity Unit (for provisioned tables), or 0.25 of the max configured + // Read Capacity Unit (for tables using on-demand mode). + ScanRate *float64 `locationName:"scanRate" type:"double"` } // String returns the string representation @@ -20329,6 +20350,18 @@ func (s *DynamoDBTarget) SetPath(v string) *DynamoDBTarget { return s } +// SetScanAll sets the ScanAll field's value. +func (s *DynamoDBTarget) SetScanAll(v bool) *DynamoDBTarget { + s.ScanAll = &v + return s +} + +// SetScanRate sets the ScanRate field's value. +func (s *DynamoDBTarget) SetScanRate(v float64) *DynamoDBTarget { + s.ScanRate = &v + return s +} + // An edge represents a directed connection between two AWS Glue components // which are part of the workflow the edge belongs to. type Edge struct { @@ -25060,11 +25093,11 @@ type GrokClassifier struct { CreationTime *time.Time `type:"timestamp"` // Optional custom grok patterns defined by this classifier. For more information, - // see custom patterns in Writing Custom Classifiers (http://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html). + // see custom patterns in Writing Custom Classifiers (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html). CustomPatterns *string `type:"string"` // The grok pattern applied to a data store by this classifier. For more information, - // see built-in patterns in Writing Custom Classifiers (http://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html). + // see built-in patterns in Writing Custom Classifiers (https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html). // // GrokPattern is a required field GrokPattern *string `min:"1" type:"string" required:"true"` @@ -25454,7 +25487,7 @@ type JdbcTarget struct { ConnectionName *string `type:"string"` // A list of glob patterns used to exclude from the crawl. For more information, - // see Catalog Tables with a Crawler (http://docs.aws.amazon.com/glue/latest/dg/add-crawler.html). + // see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html). Exclusions []*string `type:"list"` // The path of the JDBC target. @@ -28849,7 +28882,7 @@ type S3Target struct { _ struct{} `type:"structure"` // A list of glob patterns used to exclude from the crawl. For more information, - // see Catalog Tables with a Crawler (http://docs.aws.amazon.com/glue/latest/dg/add-crawler.html). + // see Catalog Tables with a Crawler (https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html). Exclusions []*string `type:"list"` // The path to the Amazon S3 target. @@ -28882,10 +28915,10 @@ func (s *S3Target) SetPath(v string) *S3Target { type Schedule struct { _ struct{} `type:"structure"` - // A cron expression used to specify the schedule. For more information, see - // Time-Based Schedules for Jobs and Crawlers (http://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, specify cron(15 12 - // * * ? *). + // A cron expression used to specify the schedule (see Time-Based Schedules + // for Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). + // For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *). ScheduleExpression *string `type:"string"` // The state of the schedule. @@ -32293,9 +32326,9 @@ type UpdateCrawlerInput struct { // always override the default classifiers for a given classification. Classifiers []*string `type:"list"` - // The crawler configuration information. This versioned JSON string allows - // users to specify aspects of a crawler's behavior. For more information, see - // Configuring a Crawler (http://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). + // Crawler configuration information. This versioned JSON string allows users + // to specify aspects of a crawler's behavior. For more information, see Configuring + // a Crawler (https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html). Configuration *string `type:"string"` // The name of the SecurityConfiguration structure to be used by this crawler. @@ -32316,10 +32349,10 @@ type UpdateCrawlerInput struct { // the new crawler to access customer resources. Role *string `type:"string"` - // A cron expression used to specify the schedule. For more information, see - // Time-Based Schedules for Jobs and Crawlers (http://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, specify cron(15 12 - // * * ? *). + // A cron expression used to specify the schedule (see Time-Based Schedules + // for Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). + // For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *). Schedule *string `type:"string"` // The policy for the crawler's update and deletion behavior. @@ -32451,10 +32484,10 @@ type UpdateCrawlerScheduleInput struct { // CrawlerName is a required field CrawlerName *string `min:"1" type:"string" required:"true"` - // The updated cron expression used to specify the schedule. For more information, - // see Time-Based Schedules for Jobs and Crawlers (http://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). - // For example, to run something every day at 12:15 UTC, specify cron(15 12 - // * * ? *). + // The updated cron expression used to specify the schedule (see Time-Based + // Schedules for Jobs and Crawlers (https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html). + // For example, to run something every day at 12:15 UTC, you would specify: + // cron(15 12 * * ? *). Schedule *string `type:"string"` } diff --git a/service/storagegateway/api.go b/service/storagegateway/api.go index b05c45073b4..f75ac135fe0 100644 --- a/service/storagegateway/api.go +++ b/service/storagegateway/api.go @@ -60,8 +60,8 @@ func (c *StorageGateway) ActivateGatewayRequest(input *ActivateGatewayInput) (re // process, you specify information such as the AWS Region that you want to // use for storing snapshots or tapes, the time zone for scheduled snapshots // the gateway snapshot schedule window, an activation key, and a name for your -// gateway. The activation process also associates your gateway with your account; -// for more information, see UpdateGatewayInformation. +// gateway. The activation process also associates your gateway with your account. +// For more information, see UpdateGatewayInformation. // // You must turn on the gateway VM before you can activate your gateway. // @@ -148,8 +148,8 @@ func (c *StorageGateway) AddCacheRequest(input *AddCacheInput) (req *request.Req // AddCache API operation for AWS Storage Gateway. // // Configures one or more gateway local disks as cache for a gateway. This operation -// is only supported in the cached volume, tape and file gateway type (see Storage -// Gateway Concepts (https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html)). +// is only supported in the cached volume, tape, and file gateway type (see +// How AWS Storage Gateway works (architecture) (https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html). // // In the request, you specify the gateway Amazon Resource Name (ARN) to which // you want to add cache, and one or more disk IDs that you want to configure @@ -526,7 +526,7 @@ func (c *StorageGateway) AssignTapePoolRequest(input *AssignTapePoolInput) (req // into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds // to the pool. // -// Valid values: "GLACIER", "DEEP_ARCHIVE" +// Valid Values: GLACIER | DEEP_ARCHIVE // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -979,8 +979,8 @@ func (c *StorageGateway) CreateNFSFileShareRequest(input *CreateNFSFileShareInpu // to enable you to create a file share. Make sure AWS STS is activated in the // AWS Region you are creating your file gateway in. If AWS STS is not activated // in the AWS Region, activate it. For information about how to activate AWS -// STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS -// Identity and Access Management User Guide. +// STS, see Activating and deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// in the AWS Identity and Access Management User Guide. // // File gateway does not support creating hard or symbolic links on a file share. // @@ -1075,7 +1075,7 @@ func (c *StorageGateway) CreateSMBFileShareRequest(input *CreateSMBFileShareInpu // to enable you to create a file share. Make sure that AWS STS is activated // in the AWS Region you are creating your file gateway in. If AWS STS is not // activated in this AWS Region, activate it. For information about how to activate -// AWS STS, see Activating and Deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// AWS STS, see Activating and deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the AWS Identity and Access Management User Guide. // // File gateways don't support creating hard or symbolic links on a file share. @@ -1165,12 +1165,11 @@ func (c *StorageGateway) CreateSnapshotRequest(input *CreateSnapshotInput) (req // Initiates a snapshot of a volume. // // AWS Storage Gateway provides the ability to back up point-in-time snapshots -// of your data to Amazon Simple Storage Service (Amazon S3) for durable off-site -// recovery, as well as import the data to an Amazon Elastic Block Store (EBS) -// volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your -// gateway volume on a scheduled or ad hoc basis. This API enables you to take -// an ad hoc snapshot. For more information, see Editing a Snapshot Schedule -// (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot). +// of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, +// as well as import the data to an Amazon Elastic Block Store (EBS) volume +// in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway +// volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc +// snapshot. For more information, see Editing a snapshot schedule (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot). // // In the CreateSnapshot request you identify the volume by providing its Amazon // Resource Name (ARN). You must also provide description for the snapshot. @@ -1182,7 +1181,9 @@ func (c *StorageGateway) CreateSnapshotRequest(input *CreateSnapshotInput) (req // cached volume gateway type. // // To list or delete a snapshot, you must use the Amazon EC2 API. For more information, -// see DescribeSnapshots or DeleteSnapshot in the EC2 API reference (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html). +// see DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) +// or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) +// in the Amazon Elastic Compute Cloud API Reference. // // Volume and snapshot IDs are changing to a longer length ID format. For more // information, see the important note on the Welcome (https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html) @@ -1290,7 +1291,9 @@ func (c *StorageGateway) CreateSnapshotFromVolumeRecoveryPointRequest(input *Cre // a volume from a snapshot. // // To list or delete a snapshot, you must use the Amazon EC2 API. For more information, -// in Amazon Elastic Compute Cloud API Reference. +// see DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) +// or DeleteSnapshot (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html) +// in the Amazon Elastic Compute Cloud API Reference. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1475,7 +1478,7 @@ func (c *StorageGateway) CreateTapeWithBarcodeRequest(input *CreateTapeWithBarco // CreateTapeWithBarcode API operation for AWS Storage Gateway. // // Creates a virtual tape by using your own barcode. You write data to the virtual -// tape and then archive the tape. A barcode is unique and cannot be reused +// tape and then archive the tape. A barcode is unique and can not be reused // if it has already been used on a tape. This applies to barcodes used on deleted // tapes. This operation is only supported in the tape gateway type. // @@ -2014,7 +2017,7 @@ func (c *StorageGateway) DeleteGatewayRequest(input *DeleteGatewayInput) (req *r // for these snapshots. You can choose to remove all remaining Amazon EBS snapshots // by canceling your Amazon EC2 subscription. If you prefer not to cancel your // Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 -// console. For more information, see the AWS Storage Gateway Detail Page (http://aws.amazon.com/storagegateway). +// console. For more information, see the AWS Storage Gateway detail page (http://aws.amazon.com/storagegateway). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2102,7 +2105,7 @@ func (c *StorageGateway) DeleteSnapshotScheduleRequest(input *DeleteSnapshotSche // // You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. // This API action enables you to delete a snapshot schedule for a volume. For -// more information, see Working with Snapshots (https://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html). +// more information, see Backing up your volumes (https://docs.aws.amazon.com/storagegatewaylatest/userguide/backing-up-volumes.html). // In the DeleteSnapshotSchedule request, you identify the volume by providing // its Amazon Resource Name (ARN). This operation is only supported in stored // and cached volume gateway types. @@ -2549,7 +2552,7 @@ func (c *StorageGateway) DescribeBandwidthRateLimitRequest(input *DescribeBandwi // // Returns the bandwidth rate limits of a gateway. By default, these limits // are not set, which means no bandwidth rate limiting is in effect. This operation -// is supported for the stored volume, cached volume and tape gateway types.' +// is supported for the stored volume, cached volume and tape gateway types. // // This operation only returns a value for a bandwidth rate limit only if the // limit is set. If no limits are set for the gateway, then this operation returns @@ -3417,7 +3420,7 @@ func (c *StorageGateway) DescribeStorediSCSIVolumesRequest(input *DescribeStored // // Returns the description of the gateway volumes specified in the request. // The list of gateway volumes in the request must be from one gateway. In the -// response AWS Storage Gateway returns volume information sorted by volume +// response, AWS Storage Gateway returns volume information sorted by volume // ARNs. This operation is only supported in stored volume gateway type. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -3942,7 +3945,7 @@ func (c *StorageGateway) DescribeUploadBufferRequest(input *DescribeUploadBuffer // DescribeUploadBuffer API operation for AWS Storage Gateway. // // Returns information about the upload buffer of a gateway. This operation -// is supported for the stored volume, cached volume and tape gateway types. +// is supported for the stored volume, cached volume, and tape gateway types. // // The response includes disk IDs that are configured as upload buffer space, // and it includes the amount of upload buffer space allocated and used. @@ -5644,8 +5647,8 @@ func (c *StorageGateway) NotifyWhenUploadedRequest(input *NotifyWhenUploadedInpu // event targets such as Amazon SNS or AWS Lambda function. This operation is // only supported for file gateways. // -// For more information, see Getting File Upload Notification in the Storage -// Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification). +// For more information, see Getting file upload notification (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification) +// in the AWS Storage Gateway User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5734,7 +5737,8 @@ func (c *StorageGateway) RefreshCacheRequest(input *RefreshCacheInput) (req *req // last listed the bucket's contents and cached the results. This operation // is only supported in the file gateway type. You can subscribe to be notified // through an Amazon CloudWatch event when your RefreshCache operation completes. -// For more information, see Getting Notified About File Operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification). +// For more information, see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) +// in the AWS Storage Gateway User Guide. // // When this API is called, it only initiates the refresh operation. When the // API call completes and returns a success code, it doesn't necessarily mean @@ -5746,13 +5750,15 @@ func (c *StorageGateway) RefreshCacheRequest(input *RefreshCacheInput) (req *req // Throttle limit: This API is asynchronous so the gateway will accept no more // than two refreshes at any time. We recommend using the refresh-complete CloudWatch // event notification before issuing additional requests. For more information, -// see Getting Notified About File Operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification). +// see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) +// in the AWS Storage Gateway User Guide. // // If you invoke the RefreshCache API when two requests are already being processed, // any new request will cause an InvalidGatewayRequestException error because // too many requests were sent to the server. // -// For more information, see "https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification". +// For more information, see Getting notified about file operations (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification) +// in the AWS Storage Gateway User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6384,7 +6390,7 @@ func (c *StorageGateway) ShutdownGatewayRequest(input *ShutdownGatewayInput) (re // the gateway component in the VM to avoid unpredictable conditions. // // After the gateway is shutdown, you cannot call any other API except StartGateway, -// DescribeGatewayInformation and ListGateways. For more information, see ActivateGateway. +// DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. // Your applications cannot read from or write to the gateway's storage volumes, // and there are no snapshots taken. // @@ -6756,7 +6762,7 @@ func (c *StorageGateway) UpdateBandwidthRateLimitRequest(input *UpdateBandwidthR // Updates the bandwidth rate limits of a gateway. You can update both the upload // and download bandwidth rate limit or specify only one of the two. If you // don't set a bandwidth rate limit, the existing rate limit remains. This operation -// is supported for the stored volume, cached volume and tape gateway types.' +// is supported for the stored volume, cached volume, and tape gateway types. // // By default, a gateway's bandwidth rate limits are not set. If you don't set // any limit, the gateway does not have any limitations on its bandwidth usage @@ -7038,9 +7044,9 @@ func (c *StorageGateway) UpdateGatewaySoftwareNowRequest(input *UpdateGatewaySof // A software update forces a system restart of your gateway. You can minimize // the chance of any disruption to your applications by increasing your iSCSI // Initiators' timeouts. For more information about increasing iSCSI Initiator -// timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings +// timeouts for Windows and Linux, see Customizing your Windows iSCSI settings // (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings) -// and Customizing Your Linux iSCSI Settings (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings), +// and Customizing your Linux iSCSI settings (https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings), // respectively. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -7323,7 +7329,7 @@ func (c *StorageGateway) UpdateSMBFileShareRequest(input *UpdateSMBFileShareInpu // to enable you to create a file share. Make sure that AWS STS is activated // in the AWS Region you are creating your file gateway in. If AWS STS is not // activated in this AWS Region, activate it. For information about how to activate -// AWS STS, see Activating and Deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) +// AWS STS, see Activating and deactivating AWS STS in an AWS Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the AWS Identity and Access Management User Guide. // // File gateways don't support creating hard or symbolic links on a file share. @@ -7648,9 +7654,9 @@ func (c *StorageGateway) UpdateVTLDeviceTypeWithContext(ctx aws.Context, input * // // * ActivateGatewayInput$GatewayType // -// * ActivateGatewayInput$TapeDriveType -// // * ActivateGatewayInput$MediumChangerType +// +// * ActivateGatewayInput$TapeDriveType type ActivateGatewayInput struct { _ struct{} `type:"structure"` @@ -7662,8 +7668,8 @@ type ActivateGatewayInput struct { // defaults -- the arguments you pass to the ActivateGateway API call determine // the actual configuration of your gateway. // - // For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html - // in the Storage Gateway User Guide. + // For more information, see Getting activation key (https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html) + // in the AWS Storage Gateway User Guide. // // ActivationKey is a required field ActivationKey *string `min:"1" type:"string" required:"true"` @@ -7676,11 +7682,11 @@ type ActivateGatewayInput struct { // A value that indicates the AWS Region where you want to store your data. // The gateway AWS Region specified must be the same AWS Region as the AWS Region // in your Host header in the request. For more information about available - // AWS Regions and endpoints for AWS Storage Gateway, see Regions and Endpoints - // (https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region) in the - // Amazon Web Services Glossary. + // AWS Regions and endpoints for AWS Storage Gateway, see AWS Storage Gateway + // endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) + // in the AWS General Reference. // - // Valid Values: See AWS Storage Gateway Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region) + // Valid Values: See AWS Storage Gateway endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) // in the AWS General Reference. // // GatewayRegion is a required field @@ -7699,13 +7705,13 @@ type ActivateGatewayInput struct { // is critical to all later functions of the gateway and cannot be changed after // activation. The default value is CACHED. // - // Valid Values: "STORED", "CACHED", "VTL", "FILE_S3" + // Valid Values: STORED | CACHED | VTL | FILE_S3 GatewayType *string `min:"2" type:"string"` // The value that indicates the type of medium changer to use for tape gateway. // This field is optional. // - // Valid Values: "STK-L700", "AWS-Gateway-VTL" + // Valid Values: STK-L700 | AWS-Gateway-VTL MediumChangerType *string `min:"2" type:"string"` // A list of up to 50 tags that you can assign to the gateway. Each tag is a @@ -7720,7 +7726,7 @@ type ActivateGatewayInput struct { // The value that indicates the type of tape drive to use for tape gateway. // This field is optional. // - // Valid Values: "IBM-ULT3580-TD5" + // Valid Values: IBM-ULT3580-TD5 TapeDriveType *string `min:"2" type:"string"` } @@ -8223,7 +8229,7 @@ type AssignTapePoolInput struct { // is archived directly into the storage class (S3 Glacier or S3 Glacier Deep // Archive) that corresponds to the pool. // - // Valid values: "GLACIER", "DEEP_ARCHIVE" + // Valid Values: GLACIER | DEEP_ARCHIVE // // PoolId is a required field PoolId *string `min:"1" type:"string" required:"true"` @@ -8503,7 +8509,7 @@ type AutomaticTapeCreationRule struct { // tape is archived directly into the storage class (S3 Glacier or S3 Glacier // Deep Archive) that corresponds to the pool. // - // Valid values: "GLACIER", "DEEP_ARCHIVE" + // Valid Values: GLACIER | DEEP_ARCHIVE // // PoolId is a required field PoolId *string `min:"1" type:"string" required:"true"` @@ -8596,8 +8602,9 @@ type CachediSCSIVolume struct { // don’t have this time stamp. CreatedDate *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // If the cached volume was created from a snapshot, this field contains the @@ -8617,8 +8624,8 @@ type CachediSCSIVolume struct { VolumeARN *string `min:"50" type:"string"` // A value that indicates whether a storage volume is attached to or detached - // from a gateway. For more information, see Moving Your Volumes to a Different - // Gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). + // from a gateway. For more information, see Moving your volumes to a different + // gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). VolumeAttachmentStatus *string `min:"3" type:"string"` // The unique identifier of the volume, e.g. vol-AE4B946D. @@ -8986,12 +8993,15 @@ type CreateCachediSCSIVolumeInput struct { // GatewayARN is a required field GatewayARN *string `min:"50" type:"string" required:"true"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The network interface of the gateway on which to expose the iSCSI target. @@ -9005,7 +9015,7 @@ type CreateCachediSCSIVolumeInput struct { // The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the // new cached volume. Specify this field if you want to create the iSCSI storage - // volume from a snapshot otherwise do not include this field. To list snapshots + // volume from a snapshot; otherwise, do not include this field. To list snapshots // for your account use DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string `type:"string"` @@ -9210,8 +9220,9 @@ type CreateNFSFileShareInput struct { ClientToken *string `min:"5" type:"string" required:"true"` // The default storage class for objects put into an Amazon S3 bucket by the - // file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. - // If this field is not populated, the default value S3_STANDARD is used. Optional. + // file gateway. The default value is S3_INTELLIGENT_TIERING. Optional. + // + // Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string `min:"5" type:"string"` // The Amazon Resource Name (ARN) of the file gateway on which you want to create @@ -9222,15 +9233,20 @@ type CreateNFSFileShareInput struct { // A value that enables guessing of the MIME type for uploaded objects based // on file extensions. Set this value to true to enable MIME type guessing, - // and otherwise to false. The default value is true. + // otherwise set to false. The default value is true. + // + // Valid Values: true | false GuessMIMETypeEnabled *bool `type:"boolean"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The ARN of the backed storage used for storing file data. @@ -9241,22 +9257,27 @@ type CreateNFSFileShareInput struct { // File share default values. Optional. NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"` - // A value that sets the access control list permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is "private". + // A value that sets the access control list (ACL) permission for objects in + // the S3 bucket that a file gateway puts objects into. The default value is + // private. ObjectACL *string `type:"string" enum:"ObjectACL"` - // A value that sets the write status of a file share. This value is true if - // the write status is read-only, and otherwise false. + // A value that sets the write status of a file share. Set this value to true + // to set the write status to read-only, otherwise set to false. + // + // Valid Values: true | false ReadOnly *bool `type:"boolean"` // A value that sets who pays the cost of the request and the cost associated // with data download from the S3 bucket. If this value is set to true, the - // requester pays the costs. Otherwise the S3 bucket owner pays. However, the + // requester pays the costs; otherwise, the S3 bucket owner pays. However, the // S3 bucket owner always pays the cost of storing data. // // RequesterPays is a configuration for the S3 bucket that backs the file share, // so make sure that the configuration on the file share is the same as the // S3 bucket configuration. + // + // Valid Values: true | false RequesterPays *bool `type:"boolean"` // The ARN of the AWS Identity and Access Management (IAM) role that a file @@ -9265,13 +9286,15 @@ type CreateNFSFileShareInput struct { // Role is a required field Role *string `min:"20" type:"string" required:"true"` - // A value that maps a user to anonymous user. Valid options are the following: + // A value that maps a user to anonymous user. + // + // Valid values are the following: // - // * RootSquash - Only root is mapped to anonymous user. + // * RootSquash: Only root is mapped to anonymous user. // - // * NoSquash - No one is mapped to anonymous user + // * NoSquash: No one is mapped to anonymous user. // - // * AllSquash - Everyone is mapped to anonymous user. + // * AllSquash: Everyone is mapped to anonymous user. Squash *string `min:"5" type:"string"` // A list of up to 50 tags that can be assigned to the NFS file share. Each @@ -9484,9 +9507,10 @@ type CreateSMBFileShareInput struct { // The Amazon Resource Name (ARN) of the storage used for the audit logs. AuditDestinationARN *string `type:"string"` - // The authentication method that users use to access the file share. + // The authentication method that users use to access the file share. The default + // is ActiveDirectory. // - // Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory. + // Valid Values: ActiveDirectory | GuestAccess Authentication *string `min:"5" type:"string"` // A unique string value that you supply that is used by file gateway to ensure @@ -9496,8 +9520,9 @@ type CreateSMBFileShareInput struct { ClientToken *string `min:"5" type:"string" required:"true"` // The default storage class for objects put into an Amazon S3 bucket by the - // file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. - // If this field is not populated, the default value S3_STANDARD is used. Optional. + // file gateway. The default value is S3_INTELLIGENT_TIERING. Optional. + // + // Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string `min:"5" type:"string"` // The ARN of the file gateway on which you want to create a file share. @@ -9507,7 +9532,9 @@ type CreateSMBFileShareInput struct { // A value that enables guessing of the MIME type for uploaded objects based // on file extensions. Set this value to true to enable MIME type guessing, - // and otherwise to false. The default value is true. + // otherwise set to false. The default value is true. + // + // Valid Values: true | false GuessMIMETypeEnabled *bool `type:"boolean"` // A list of users or groups in the Active Directory that are not allowed to @@ -9515,12 +9542,15 @@ type CreateSMBFileShareInput struct { // example, @group1. Can only be set if Authentication is set to ActiveDirectory. InvalidUserList []*string `type:"list"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The ARN of the backed storage used for storing file data. @@ -9528,22 +9558,27 @@ type CreateSMBFileShareInput struct { // LocationARN is a required field LocationARN *string `min:"16" type:"string" required:"true"` - // A value that sets the access control list permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is "private". + // A value that sets the access control list (ACL) permission for objects in + // the S3 bucket that a file gateway puts objects into. The default value is + // private. ObjectACL *string `type:"string" enum:"ObjectACL"` - // A value that sets the write status of a file share. This value is true if - // the write status is read-only, and otherwise false. + // A value that sets the write status of a file share. Set this value to true + // to set the write status to read-only, otherwise set to false. + // + // Valid Values: true | false ReadOnly *bool `type:"boolean"` // A value that sets who pays the cost of the request and the cost associated // with data download from the S3 bucket. If this value is set to true, the - // requester pays the costs. Otherwise the S3 bucket owner pays. However, the + // requester pays the costs; otherwise, the S3 bucket owner pays. However, the // S3 bucket owner always pays the cost of storing data. // // RequesterPays is a configuration for the S3 bucket that backs the file share, // so make sure that the configuration on the file share is the same as the // S3 bucket configuration. + // + // Valid Values: true | false RequesterPays *bool `type:"boolean"` // The ARN of the AWS Identity and Access Management (IAM) role that a file @@ -9552,12 +9587,15 @@ type CreateSMBFileShareInput struct { // Role is a required field Role *string `min:"20" type:"string" required:"true"` - // Set this value to "true to enable ACL (access control list) on the SMB file - // share. Set it to "false" to map file and directory permissions to the POSIX + // Set this value to true to enable access control list (ACL) on the SMB file + // share. Set it to false to map file and directory permissions to the POSIX // permissions. // - // For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html - // in the Storage Gateway User Guide. + // For more information, see Using Microsoft Windows ACLs to control access + // to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) + // in the AWS Storage Gateway User Guide. + // + // Valid Values: true | false SMBACLEnabled *bool `type:"boolean"` // A list of up to 50 tags that can be assigned to the NFS file share. Each @@ -9570,7 +9608,7 @@ type CreateSMBFileShareInput struct { Tags []*Tag `type:"list"` // A list of users or groups in the Active Directory that are allowed to access - // the file share. A group must be prefixed with the @ character. For example + // the file share. A group must be prefixed with the @ character. For example, // @group1. Can only be set if Authentication is set to ActiveDirectory. ValidUserList []*string `type:"list"` } @@ -9775,7 +9813,7 @@ type CreateSnapshotFromVolumeRecoveryPointInput struct { // Textual description of the snapshot that appears in the Amazon EC2 console, // Elastic Block Store snapshots panel in the Description field, and in the - // AWS Storage Gateway snapshot Details pane, Description field + // AWS Storage Gateway snapshot Details pane, Description field. // // SnapshotDescription is a required field SnapshotDescription *string `min:"1" type:"string" required:"true"` @@ -9908,7 +9946,7 @@ type CreateSnapshotInput struct { // Textual description of the snapshot that appears in the Amazon EC2 console, // Elastic Block Store snapshots panel in the Description field, and in the - // AWS Storage Gateway snapshot Details pane, Description field + // AWS Storage Gateway snapshot Details pane, Description field. // // SnapshotDescription is a required field SnapshotDescription *string `min:"1" type:"string" required:"true"` @@ -10051,12 +10089,15 @@ type CreateStorediSCSIVolumeInput struct { // GatewayARN is a required field GatewayARN *string `min:"50" type:"string" required:"true"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The network interface of the gateway on which to expose the iSCSI target. @@ -10068,17 +10109,17 @@ type CreateStorediSCSIVolumeInput struct { // NetworkInterfaceId is a required field NetworkInterfaceId *string `type:"string" required:"true"` - // Specify this field as true if you want to preserve the data on the local - // disk. Otherwise, specifying this field as false creates an empty volume. + // Set to true true if you want to preserve the data on the local disk. Otherwise, + // set to false to create an empty volume. // - // Valid Values: true, false + // Valid Values: true | false // // PreserveExistingData is a required field PreserveExistingData *bool `type:"boolean" required:"true"` // The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the // new stored volume. Specify this field if you want to create the iSCSI storage - // volume from a snapshot otherwise do not include this field. To list snapshots + // volume from a snapshot; otherwise, do not include this field. To list snapshots // for your account use DescribeSnapshots (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) // in the Amazon Elastic Compute Cloud API Reference. SnapshotId *string `type:"string"` @@ -10269,21 +10310,24 @@ type CreateTapeWithBarcodeInput struct { // GatewayARN is a required field GatewayARN *string `min:"50" type:"string" required:"true"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The ID of the pool that you want to add your tape to for archiving. The tape // in this pool is archived in the S3 storage class that is associated with // the pool. When you use your backup application to eject the tape, the tape - // is archived directly into the storage class (S3 Glacier or S3 Glacier Deep - // Archive) that corresponds to the pool. + // is archived directly into the storage class (S3 Glacier or S3 Deep Archive) + // that corresponds to the pool. // - // Valid values: "GLACIER", "DEEP_ARCHIVE" + // Valid Values: GLACIER | DEEP_ARCHIVE PoolId *string `min:"1" type:"string"` // A list of up to 50 tags that can be assigned to a virtual tape that has a @@ -10448,12 +10492,15 @@ type CreateTapesInput struct { // GatewayARN is a required field GatewayARN *string `min:"50" type:"string" required:"true"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The number of virtual tapes that you want to create. @@ -10467,7 +10514,7 @@ type CreateTapesInput struct { // is archived directly into the storage class (S3 Glacier or S3 Glacier Deep // Archive) that corresponds to the pool. // - // Valid values: "GLACIER", "DEEP_ARCHIVE" + // Valid Values: GLACIER | DEEP_ARCHIVE PoolId *string `min:"1" type:"string"` // A list of up to 50 tags that can be assigned to a virtual tape. Each tag @@ -10713,7 +10760,7 @@ type DeleteBandwidthRateLimitInput struct { // One of the BandwidthType values that indicates the gateway bandwidth rate // limit to delete. // - // Valid Values: Upload, Download, All. + // Valid Values: Upload | Download | All // // BandwidthType is a required field BandwidthType *string `min:"3" type:"string" required:"true"` @@ -10905,6 +10952,8 @@ type DeleteFileShareInput struct { // and aborts all data uploads to AWS. Otherwise, the file share is not deleted // until all data is uploaded to AWS. This process aborts the data upload process, // and the file share enters the FORCE_DELETING status. + // + // Valid Values: true | false ForceDelete *bool `type:"boolean"` } @@ -11299,7 +11348,7 @@ func (s *DeleteVolumeInput) SetVolumeARN(v string) *DeleteVolumeInput { } // A JSON object containing the Amazon Resource Name (ARN) of the storage volume -// that was deleted +// that was deleted. type DeleteVolumeOutput struct { _ struct{} `type:"structure"` @@ -11735,7 +11784,7 @@ func (s *DescribeChapCredentialsInput) SetTargetARN(v string) *DescribeChapCrede return s } -// A JSON object containing a . +// A JSON object containing the following fields: type DescribeChapCredentialsOutput struct { _ struct{} `type:"structure"` @@ -11830,6 +11879,11 @@ type DescribeGatewayInformationOutput struct { // The AWS Region where the Amazon EC2 instance is located. Ec2InstanceRegion *string `type:"string"` + // The type of endpoint for your gateway. + // + // Valid Values: STANDARD | FIPS + EndpointType *string `min:"4" type:"string"` + // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation // to return a list of gateways for your account and AWS Region. GatewayARN *string `min:"50" type:"string"` @@ -11906,6 +11960,12 @@ func (s *DescribeGatewayInformationOutput) SetEc2InstanceRegion(v string) *Descr return s } +// SetEndpointType sets the EndpointType field's value. +func (s *DescribeGatewayInformationOutput) SetEndpointType(v string) *DescribeGatewayInformationOutput { + s.EndpointType = &v + return s +} + // SetGatewayARN sets the GatewayARN field's value. func (s *DescribeGatewayInformationOutput) SetGatewayARN(v string) *DescribeGatewayInformationOutput { s.GatewayARN = &v @@ -12038,8 +12098,6 @@ type DescribeMaintenanceStartTimeOutput struct { // The day of the month component of the maintenance start time represented // as an ordinal number from 1 to 28, where 1 represents the first day of the // month and 28 represents the last day of the month. - // - // This value is only available for tape and volume gateways. DayOfMonth *int64 `min:"1" type:"integer"` // An ordinal number between 0 and 6 that represents the day of the week, where @@ -12320,24 +12378,27 @@ type DescribeSMBSettingsOutput struct { // to return a list of gateways for your account and AWS Region. GatewayARN *string `min:"50" type:"string"` - // This value is true if a password for the guest user “smbguest” is set, - // and otherwise false. + // This value is true if a password for the guest user smbguest is set, otherwise + // false. + // + // Valid Values: true | false SMBGuestPasswordSet *bool `type:"boolean"` // The type of security strategy that was specified for file gateway. // - // ClientSpecified: if you use this option, requests are established based on - // what is negotiated by the client. This option is recommended when you want - // to maximize compatibility across different clients in your environment. + // * ClientSpecified: If you use this option, requests are established based + // on what is negotiated by the client. This option is recommended when you + // want to maximize compatibility across different clients in your environment. // - // MandatorySigning: if you use this option, file gateway only allows connections - // from SMBv2 or SMBv3 clients that have signing enabled. This option works - // with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. + // * MandatorySigning: If you use this option, file gateway only allows connections + // from SMBv2 or SMBv3 clients that have signing enabled. This option works + // with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. // - // MandatoryEncryption: if you use this option, file gateway only allows connections - // from SMBv3 clients that have encryption enabled. This option is highly recommended - // for environments that handle sensitive data. This option works with SMB clients - // on Microsoft Windows 8, Windows Server 2012 or newer. + // * MandatoryEncryption: If you use this option, file gateway only allows + // connections from SMBv3 clients that have encryption enabled. This option + // is highly recommended for environments that handle sensitive data. This + // option works with SMB clients on Microsoft Windows 8, Windows Server 2012 + // or newer. SMBSecurityStrategy *string `type:"string" enum:"SMBSecurityStrategy"` } @@ -12554,7 +12615,7 @@ type DescribeStorediSCSIVolumesOutput struct { // // * NetworkInterfacePort: The port used to communicate with iSCSI targets. // - // * PreservedExistingData: Indicates if when the stored volume was created, + // * PreservedExistingData: Indicates when the stored volume was created, // existing data on the underlying local disk was preserved. // // * SourceSnapshotId: If the stored volume was created from a snapshot, @@ -12587,7 +12648,7 @@ type DescribeStorediSCSIVolumesOutput struct { // of the volume. // // * VolumeType: One of the enumeration values describing the type of the - // volume. Currently, on STORED volumes are supported. + // volume. Currently, only STORED volumes are supported. StorediSCSIVolumes []*StorediSCSIVolume `type:"list"` } @@ -12682,7 +12743,7 @@ type DescribeTapeArchivesOutput struct { // An array of virtual tape objects in the virtual tape shelf (VTS). The description // includes of the Amazon Resource Name (ARN) of the virtual tapes. The information // returned includes the Amazon Resource Names (ARNs) of the tapes, size of - // the tapes, status of the tapes, progress of the description and tape barcode. + // the tapes, status of the tapes, progress of the description, and tape barcode. TapeArchives []*TapeArchive `type:"list"` } @@ -13280,6 +13341,8 @@ type DetachVolumeInput struct { // Set to true to forcibly remove the iSCSI connection of the target volume // and detach the volume. The default is false. If this value is set to false, // you must manually disconnect the iSCSI connection from the target volume. + // + // Valid Values: true | false ForceDetach *bool `type:"boolean"` // The Amazon Resource Name (ARN) of the volume to detach from the gateway. @@ -13479,7 +13542,9 @@ type Disk struct { DiskAllocationResource *string `type:"string"` // One of the DiskAllocationType enumeration values that identifies how a local - // disk is used. Valid values: UPLOAD_BUFFER, CACHE_STORAGE + // disk is used. + // + // Valid Values: UPLOAD_BUFFER | CACHE_STORAGE DiskAllocationType *string `min:"3" type:"string"` // A list of values that represents attributes of a local disk. @@ -13605,8 +13670,9 @@ type FileShareInfo struct { // The ID of the file share. FileShareId *string `min:"12" type:"string"` - // The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE - // and DELETING. + // The status of the file share. + // + // Valid Values: CREATING | UPDATING | AVAILABLE | DELETING FileShareStatus *string `min:"3" type:"string"` // The type of the file share. @@ -13681,7 +13747,7 @@ type GatewayInfo struct { // The state of the gateway. // - // Valid Values: DISABLED or ACTIVE + // Valid Values: DISABLED | ACTIVE GatewayOperationalState *string `min:"2" type:"string"` // The type of the gateway. @@ -14880,13 +14946,13 @@ func (s *ListVolumesOutput) SetVolumeInfos(v []*VolumeInfo) *ListVolumesOutput { type NFSFileShareDefaults struct { _ struct{} `type:"structure"` - // The Unix directory mode in the form "nnnn". For example, "0666" represents + // The Unix directory mode in the form "nnnn". For example, 0666 represents // the default access mode for all directories inside the file share. The default // value is 0777. DirectoryMode *string `min:"1" type:"string"` - // The Unix file mode in the form "nnnn". For example, "0666" represents the - // default file mode inside the file share. The default value is 0666. + // The Unix file mode in the form "nnnn". For example, 0666 represents the default + // file mode inside the file share. The default value is 0666. FileMode *string `min:"1" type:"string"` // The default group ID for the file share (unless the files have another group @@ -14959,8 +15025,9 @@ type NFSFileShareInfo struct { ClientList []*string `min:"1" type:"list"` // The default storage class for objects put into an Amazon S3 bucket by the - // file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. - // If this field is not populated, the default value S3_STANDARD is used. Optional. + // file gateway. The default value is S3_INTELLIGENT_TIERING. Optional. + // + // Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string `min:"5" type:"string"` // The Amazon Resource Name (ARN) of the file share. @@ -14969,8 +15036,9 @@ type NFSFileShareInfo struct { // The ID of the file share. FileShareId *string `min:"12" type:"string"` - // The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE - // and DELETING. + // The status of the file share. + // + // Valid Values: CREATING | UPDATING | AVAILABLE | DELETING FileShareStatus *string `min:"3" type:"string"` // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation @@ -14979,15 +15047,20 @@ type NFSFileShareInfo struct { // A value that enables guessing of the MIME type for uploaded objects based // on file extensions. Set this value to true to enable MIME type guessing, - // and otherwise to false. The default value is true. + // otherwise set to false. The default value is true. + // + // Valid Values: true | false GuessMIMETypeEnabled *bool `type:"boolean"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The ARN of the backend storage used for storing file data. @@ -15001,25 +15074,30 @@ type NFSFileShareInfo struct { // gateways. NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"` - // A value that sets the access control list permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is "private". + // A value that sets the access control list (ACL) permission for objects in + // the S3 bucket that a file gateway puts objects into. The default value is + // private. ObjectACL *string `type:"string" enum:"ObjectACL"` // The file share path used by the NFS client to identify the mount point. Path *string `type:"string"` - // A value that sets the write status of a file share. This value is true if - // the write status is read-only, and otherwise false. + // A value that sets the write status of a file share. Set this value to true + // to set the write status to read-only, otherwise set to false. + // + // Valid Values: true | false ReadOnly *bool `type:"boolean"` // A value that sets who pays the cost of the request and the cost associated // with data download from the S3 bucket. If this value is set to true, the - // requester pays the costs. Otherwise the S3 bucket owner pays. However, the + // requester pays the costs; otherwise, the S3 bucket owner pays. However, the // S3 bucket owner always pays the cost of storing data. // // RequesterPays is a configuration for the S3 bucket that backs the file share, // so make sure that the configuration on the file share is the same as the // S3 bucket configuration. + // + // Valid Values: true | false RequesterPays *bool `type:"boolean"` // The ARN of the IAM role that file gateway assumes when it accesses the underlying @@ -15028,11 +15106,11 @@ type NFSFileShareInfo struct { // The user mapped to anonymous user. Valid options are the following: // - // * RootSquash - Only root is mapped to anonymous user. + // * RootSquash: Only root is mapped to anonymous user. // - // * NoSquash - No one is mapped to anonymous user + // * NoSquash: No one is mapped to anonymous user. // - // * AllSquash - Everyone is mapped to anonymous user. + // * AllSquash: Everyone is mapped to anonymous user. Squash *string `min:"5" type:"string"` // A list of up to 50 tags assigned to the NFS file share, sorted alphabetically @@ -15289,17 +15367,19 @@ type RefreshCacheInput struct { // A comma-separated list of the paths of folders to refresh in the cache. The // default is ["/"]. The default refreshes objects and folders at the root of - // the Amazon S3 bucket. If Recursive is set to "true", the entire S3 bucket - // that the file share has access to is refreshed. + // the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that + // the file share has access to is refreshed. FolderList []*string `min:"1" type:"list"` // A value that specifies whether to recursively refresh folders in the cache. // The refresh includes folders that were in the cache the last time the gateway - // listed the folder's contents. If this value set to "true", each folder that + // listed the folder's contents. If this value set to true, each folder that // is listed in FolderList is recursively updated. Otherwise, subfolders listed // in FolderList are not refreshed. Only objects that are in folders listed // directly under FolderList are found and used for the update. The default - // is "true". + // is true. + // + // Valid Values: true | false Recursive *bool `type:"boolean"` } @@ -15722,14 +15802,15 @@ type SMBFileShareInfo struct { // The Amazon Resource Name (ARN) of the storage used for the audit logs. AuditDestinationARN *string `type:"string"` - // The authentication method of the file share. + // The authentication method of the file share. The default is ActiveDirectory. // - // Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory. + // Valid Values: ActiveDirectory | GuestAccess Authentication *string `min:"5" type:"string"` // The default storage class for objects put into an Amazon S3 bucket by the - // file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. - // If this field is not populated, the default value S3_STANDARD is used. Optional. + // file gateway. The default value is S3_INTELLIGENT_TIERING. Optional. + // + // Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string `min:"5" type:"string"` // The Amazon Resource Name (ARN) of the file share. @@ -15738,8 +15819,9 @@ type SMBFileShareInfo struct { // The ID of the file share. FileShareId *string `min:"12" type:"string"` - // The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE - // and DELETING. + // The status of the file share. + // + // Valid Values: CREATING | UPDATING | AVAILABLE | DELETING FileShareStatus *string `min:"3" type:"string"` // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation @@ -15748,7 +15830,9 @@ type SMBFileShareInfo struct { // A value that enables guessing of the MIME type for uploaded objects based // on file extensions. Set this value to true to enable MIME type guessing, - // and otherwise to false. The default value is true. + // otherwise set to false. The default value is true. + // + // Valid Values: true | false GuessMIMETypeEnabled *bool `type:"boolean"` // A list of users or groups in the Active Directory that are not allowed to @@ -15756,48 +15840,57 @@ type SMBFileShareInfo struct { // example @group1. Can only be set if Authentication is set to ActiveDirectory. InvalidUserList []*string `type:"list"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The ARN of the backend storage used for storing file data. LocationARN *string `min:"16" type:"string"` - // A value that sets the access control list permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is "private". + // A value that sets the access control list (ACL) permission for objects in + // the S3 bucket that a file gateway puts objects into. The default value is + // private. ObjectACL *string `type:"string" enum:"ObjectACL"` // The file share path used by the SMB client to identify the mount point. Path *string `type:"string"` - // A value that sets the write status of a file share. This value is true if - // the write status is read-only, and otherwise false. + // A value that sets the write status of a file share. Set this value to true + // to set the write status to read-only, otherwise set to false. + // + // Valid Values: true | false ReadOnly *bool `type:"boolean"` // A value that sets who pays the cost of the request and the cost associated // with data download from the S3 bucket. If this value is set to true, the - // requester pays the costs. Otherwise the S3 bucket owner pays. However, the + // requester pays the costs; otherwise, the S3 bucket owner pays. However, the // S3 bucket owner always pays the cost of storing data. // // RequesterPays is a configuration for the S3 bucket that backs the file share, // so make sure that the configuration on the file share is the same as the // S3 bucket configuration. + // + // Valid Values: true | false RequesterPays *bool `type:"boolean"` // The ARN of the IAM role that file gateway assumes when it accesses the underlying // storage. Role *string `min:"20" type:"string"` - // If this value is set to "true", indicates that ACL (access control list) - // is enabled on the SMB file share. If it is set to "false", it indicates that + // If this value is set to true, it indicates that access control list (ACL) + // is enabled on the SMB file share. If it is set to false, it indicates that // file and directory permissions are mapped to the POSIX permission. // - // For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html - // in the Storage Gateway User Guide. + // For more information, see Using Microsoft Windows ACLs to control access + // to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) + // in the AWS Storage Gateway User Guide. SMBACLEnabled *bool `type:"boolean"` // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically @@ -15806,7 +15899,7 @@ type SMBFileShareInfo struct { Tags []*Tag `type:"list"` // A list of users or groups in the Active Directory that are allowed to access - // the file share. A group must be prefixed with the @ character. For example + // the file share. A group must be prefixed with the @ character. For example, // @group1. Can only be set if Authentication is set to ActiveDirectory. ValidUserList []*string `type:"list"` } @@ -16103,7 +16196,7 @@ type SetSMBGuestPasswordInput struct { // GatewayARN is a required field GatewayARN *string `min:"50" type:"string" required:"true"` - // The password that you want to set for your SMB Server. + // The password that you want to set for your SMB server. // // Password is a required field Password *string `min:"6" type:"string" required:"true" sensitive:"true"` @@ -16391,14 +16484,15 @@ type StorediSCSIVolume struct { // don’t have this time stamp. CreatedDate *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // Indicates if when the stored volume was created, existing data on the underlying // local disk was preserved. // - // Valid Values: true, false + // Valid Values: true | false PreservedExistingData *bool `type:"boolean"` // If the stored volume was created from a snapshot, this field contains the @@ -16419,7 +16513,7 @@ type StorediSCSIVolume struct { // A value that indicates whether a storage volume is attached to, detached // from, or is in the process of detaching from a gateway. For more information, - // see Moving Your Volumes to a Different Gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). + // see Moving your volumes to a different gateway (https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume). VolumeAttachmentStatus *string `min:"3" type:"string"` // The ID of the local disk that was specified in the CreateStorediSCSIVolume @@ -16561,11 +16655,11 @@ func (s *StorediSCSIVolume) SetVolumeiSCSIAttributes(v *VolumeiSCSIAttributes) * // A key-value pair that helps you manage, filter, and search for your resource. // Allowed characters: letters, white space, and numbers, representable in UTF-8, -// and the following characters: + - = . _ : / +// and the following characters: + - = . _ : /. type Tag struct { _ struct{} `type:"structure"` - // Tag key (String). The key can't start with aws:. + // Tag key. The key can't start with aws:. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` @@ -16621,17 +16715,18 @@ func (s *Tag) SetValue(v string) *Tag { type Tape struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The ID of the pool that contains tapes that will be archived. The tapes in // this pool are archived in the S3 storage class that is associated with the // pool. When you use your backup application to eject the tape, the tape is - // archived directly into the storage class (S3 Glacier or S# Glacier Deep Archive) + // archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) // that corresponds to the pool. // - // Valid values: "GLACIER", "DEEP_ARCHIVE" + // Valid Values: GLACIER | DEEP_ARCHIVE PoolId *string `min:"1" type:"string"` // For archiving virtual tapes, indicates how much data remains to be uploaded @@ -16745,14 +16840,15 @@ type TapeArchive struct { // format. CompletionTime *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The ID of the pool that was used to archive the tape. The tapes in this pool // are archived in the S3 storage class that is associated with the pool. // - // Valid values: "GLACIER", "DEEP_ARCHIVE" + // Valid Values: GLACIER | DEEP_ARCHIVE PoolId *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the tape gateway that the virtual tape @@ -16866,7 +16962,7 @@ type TapeInfo struct { // is archived directly into the storage class (S3 Glacier or S3 Glacier Deep // Archive) that corresponds to the pool. // - // Valid values: "GLACIER", "DEEP_ARCHIVE" + // Valid Values: GLACIER | DEEP_ARCHIVE PoolId *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of a virtual tape. @@ -17320,7 +17416,7 @@ type UpdateGatewayInformationInput struct { // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you // want to use to monitor and log events in the gateway. // - // For more information, see What Is Amazon CloudWatch Logs? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html). + // For more information, see What is Amazon CloudWatch logs? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html). CloudWatchLogGroupARN *string `type:"string"` // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation @@ -17392,7 +17488,8 @@ func (s *UpdateGatewayInformationInput) SetGatewayTimezone(v string) *UpdateGate return s } -// A JSON object containing the ARN of the gateway that was updated. +// A JSON object containing the Amazon Resource Name (ARN) of the gateway that +// was updated. type UpdateGatewayInformationOutput struct { _ struct{} `type:"structure"` @@ -17511,8 +17608,6 @@ type UpdateMaintenanceStartTimeInput struct { // The day of the month component of the maintenance start time represented // as an ordinal number from 1 to 28, where 1 represents the first day of the // month and 28 represents the last day of the month. - // - // This value is only available for tape and volume gateways. DayOfMonth *int64 `min:"1" type:"integer"` // The day of the week component of the maintenance start time week represented @@ -17640,8 +17735,9 @@ type UpdateNFSFileShareInput struct { ClientList []*string `min:"1" type:"list"` // The default storage class for objects put into an Amazon S3 bucket by the - // file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. - // If this field is not populated, the default value S3_STANDARD is used. Optional. + // file gateway. The default value is S3_INTELLIGENT_TIERING. Optional. + // + // Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string `min:"5" type:"string"` // The Amazon Resource Name (ARN) of the file share to be updated. @@ -17651,45 +17747,57 @@ type UpdateNFSFileShareInput struct { // A value that enables guessing of the MIME type for uploaded objects based // on file extensions. Set this value to true to enable MIME type guessing, - // and otherwise to false. The default value is true. + // otherwise set to false. The default value is true. + // + // Valid Values: true | false GuessMIMETypeEnabled *bool `type:"boolean"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` // The default values for the file share. Optional. NFSFileShareDefaults *NFSFileShareDefaults `type:"structure"` - // A value that sets the access control list permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is "private". + // A value that sets the access control list (ACL) permission for objects in + // the S3 bucket that a file gateway puts objects into. The default value is + // private. ObjectACL *string `type:"string" enum:"ObjectACL"` - // A value that sets the write status of a file share. This value is true if - // the write status is read-only, and otherwise false. + // A value that sets the write status of a file share. Set this value to true + // to set the write status to read-only, otherwise set to false. + // + // Valid Values: true | false ReadOnly *bool `type:"boolean"` // A value that sets who pays the cost of the request and the cost associated // with data download from the S3 bucket. If this value is set to true, the - // requester pays the costs. Otherwise the S3 bucket owner pays. However, the + // requester pays the costs; otherwise, the S3 bucket owner pays. However, the // S3 bucket owner always pays the cost of storing data. // // RequesterPays is a configuration for the S3 bucket that backs the file share, // so make sure that the configuration on the file share is the same as the // S3 bucket configuration. + // + // Valid Values: true | false RequesterPays *bool `type:"boolean"` - // The user mapped to anonymous user. Valid options are the following: + // The user mapped to anonymous user. // - // * RootSquash - Only root is mapped to anonymous user. + // Valid values are the following: // - // * NoSquash - No one is mapped to anonymous user + // * RootSquash: Only root is mapped to anonymous user. // - // * AllSquash - Everyone is mapped to anonymous user. + // * NoSquash: No one is mapped to anonymous user. + // + // * AllSquash: Everyone is mapped to anonymous user. Squash *string `min:"5" type:"string"` } @@ -17831,7 +17939,7 @@ type UpdateSMBFileShareInput struct { _ struct{} `type:"structure"` // A list of users in the Active Directory that have administrator rights to - // the file share. A group must be prefixed with the @ character. For example + // the file share. A group must be prefixed with the @ character. For example, // @group1. Can only be set if Authentication is set to ActiveDirectory. AdminUserList []*string `type:"list"` @@ -17839,8 +17947,9 @@ type UpdateSMBFileShareInput struct { AuditDestinationARN *string `type:"string"` // The default storage class for objects put into an Amazon S3 bucket by the - // file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. - // If this field is not populated, the default value S3_STANDARD is used. Optional. + // file gateway. The default value is S3_INTELLIGENT_TIERING. Optional. + // + // Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA DefaultStorageClass *string `min:"5" type:"string"` // The Amazon Resource Name (ARN) of the SMB file share that you want to update. @@ -17850,7 +17959,9 @@ type UpdateSMBFileShareInput struct { // A value that enables guessing of the MIME type for uploaded objects based // on file extensions. Set this value to true to enable MIME type guessing, - // and otherwise to false. The default value is true. + // otherwise set to false. The default value is true. + // + // Valid Values: true | false GuessMIMETypeEnabled *bool `type:"boolean"` // A list of users or groups in the Active Directory that are not allowed to @@ -17858,42 +17969,53 @@ type UpdateSMBFileShareInput struct { // example @group1. Can only be set if Authentication is set to ActiveDirectory. InvalidUserList []*string `type:"list"` - // True to use Amazon S3 server-side encryption with your own AWS KMS key, or - // false to use a key managed by Amazon S3. Optional. + // Set to true to use Amazon S3 server-side encryption with your own AWS KMS + // key, or false to use a key managed by Amazon S3. Optional. + // + // Valid Values: true | false KMSEncrypted *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server-side - // encryption. This value can only be set when KMSEncrypted is true. Optional. + // The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used + // for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric + // CMKs. This value can only be set when KMSEncrypted is true. Optional. KMSKey *string `min:"7" type:"string"` - // A value that sets the access control list permission for objects in the S3 - // bucket that a file gateway puts objects into. The default value is "private". + // A value that sets the access control list (ACL) permission for objects in + // the S3 bucket that a file gateway puts objects into. The default value is + // private. ObjectACL *string `type:"string" enum:"ObjectACL"` - // A value that sets the write status of a file share. This value is true if - // the write status is read-only, and otherwise false. + // A value that sets the write status of a file share. Set this value to true + // to set write status to read-only, otherwise set to false. + // + // Valid Values: true | false ReadOnly *bool `type:"boolean"` // A value that sets who pays the cost of the request and the cost associated // with data download from the S3 bucket. If this value is set to true, the - // requester pays the costs. Otherwise the S3 bucket owner pays. However, the + // requester pays the costs; otherwise, the S3 bucket owner pays. However, the // S3 bucket owner always pays the cost of storing data. // // RequesterPays is a configuration for the S3 bucket that backs the file share, // so make sure that the configuration on the file share is the same as the // S3 bucket configuration. + // + // Valid Values: true | false RequesterPays *bool `type:"boolean"` - // Set this value to "true to enable ACL (access control list) on the SMB file - // share. Set it to "false" to map file and directory permissions to the POSIX + // Set this value to true to enable access control list (ACL) on the SMB file + // share. Set it to false to map file and directory permissions to the POSIX // permissions. // - // For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin - // the Storage Gateway User Guide. + // For more information, see Using Microsoft Windows ACLs to control access + // to an SMB file share (https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html) + // in the AWS Storage Gateway User Guide. + // + // Valid Values: true | false SMBACLEnabled *bool `type:"boolean"` // A list of users or groups in the Active Directory that are allowed to access - // the file share. A group must be prefixed with the @ character. For example + // the file share. A group must be prefixed with the @ character. For example, // @group1. Can only be set if Authentication is set to ActiveDirectory. ValidUserList []*string `type:"list"` } @@ -18277,7 +18399,7 @@ type UpdateVTLDeviceTypeInput struct { // The type of medium changer you want to select. // - // Valid Values: "STK-L700", "AWS-Gateway-VTL" + // Valid Values: STK-L700 | AWS-Gateway-VTL // // DeviceType is a required field DeviceType *string `min:"2" type:"string" required:"true"` @@ -18876,8 +18998,9 @@ const ( HostEnvironmentOther = "OTHER" ) -// A value that sets the access control list permission for objects in the S3 -// bucket that a file gateway puts objects into. The default value is "private". +// A value that sets the access control list (ACL) permission for objects in +// the S3 bucket that a file gateway puts objects into. The default value is +// private. const ( // ObjectACLPrivate is a ObjectACL enum value ObjectACLPrivate = "private" diff --git a/service/storagegateway/doc.go b/service/storagegateway/doc.go index 61d492bc29b..773ea9ee1c5 100644 --- a/service/storagegateway/doc.go +++ b/service/storagegateway/doc.go @@ -12,15 +12,15 @@ // Use the following links to get started using the AWS Storage Gateway Service // API Reference: // -// * AWS Storage Gateway Required Request Headers (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders): +// * AWS Storage Gateway required request headers (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders): // Describes the required headers that you must send with every POST request // to AWS Storage Gateway. // -// * Signing Requests (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests): +// * Signing requests (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests): // AWS Storage Gateway requires that you authenticate every request you send; // this topic describes how sign such a request. // -// * Error Responses (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses): +// * Error responses (https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses): // Provides reference information about AWS Storage Gateway errors. // // * Operations in AWS Storage Gateway (https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html): @@ -28,7 +28,7 @@ // their request parameters, response elements, possible errors, and examples // of requests and responses. // -// * AWS Storage Gateway Regions and Endpoints: (http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region) +// * AWS Storage Gateway endpoints and quotas: (https://docs.aws.amazon.com/general/latest/gr/sg.html) // Provides a list of each AWS Region and the endpoints available for use // with AWS Storage Gateway. // @@ -44,7 +44,7 @@ // volumes and snapshots will be created with a 17-character string. Starting // in April 2016, you will be able to use these longer IDs so you can test your // systems with the new format. For more information, see Longer EC2 and EBS -// Resource IDs (https://aws.amazon.com/ec2/faqs/#longer-ids). +// resource IDs (http://aws.amazon.com/ec2/faqs/#longer-ids). // // For example, a volume Amazon Resource Name (ARN) with the longer volume ID // format looks like the following: @@ -54,7 +54,7 @@ // A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee. // // For more information, see Announcement: Heads-up – Longer AWS Storage Gateway -// volume and snapshot IDs coming in 2016 (https://forums.aws.amazon.com/ann.jspa?annID=3557). +// volume and snapshot IDs coming in 2016 (http://forums.aws.amazon.com/ann.jspa?annID=3557). // // See https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30 for more information on this service. //