diff --git a/apis/apprunner/2020-05-15/api-2.json b/apis/apprunner/2020-05-15/api-2.json index be3531787d4..d74179b9621 100644 --- a/apis/apprunner/2020-05-15/api-2.json +++ b/apis/apprunner/2020-05-15/api-2.json @@ -69,6 +69,20 @@ {"shape":"ServiceQuotaExceededException"} ] }, + "CreateVpcConnector":{ + "name":"CreateVpcConnector", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcConnectorRequest"}, + "output":{"shape":"CreateVpcConnectorResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ServiceQuotaExceededException"} + ] + }, "DeleteAutoScalingConfiguration":{ "name":"DeleteAutoScalingConfiguration", "http":{ @@ -112,6 +126,20 @@ {"shape":"InternalServiceErrorException"} ] }, + "DeleteVpcConnector":{ + "name":"DeleteVpcConnector", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcConnectorRequest"}, + "output":{"shape":"DeleteVpcConnectorResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "DescribeAutoScalingConfiguration":{ "name":"DescribeAutoScalingConfiguration", "http":{ @@ -154,6 +182,20 @@ {"shape":"InternalServiceErrorException"} ] }, + "DescribeVpcConnector":{ + "name":"DescribeVpcConnector", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcConnectorRequest"}, + "output":{"shape":"DescribeVpcConnectorResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "DisassociateCustomDomain":{ "name":"DisassociateCustomDomain", "http":{ @@ -237,6 +279,19 @@ {"shape":"InvalidStateException"} ] }, + "ListVpcConnectors":{ + "name":"ListVpcConnectors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVpcConnectorsRequest"}, + "output":{"shape":"ListVpcConnectorsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"} + ] + }, "PauseService":{ "name":"PauseService", "http":{ @@ -424,6 +479,7 @@ "Boolean":{"type":"boolean"}, "BuildCommand":{ "type":"string", + "pattern":"[^\\x0a\\x0d]+", "sensitive":true }, "CertificateValidationRecord":{ @@ -580,7 +636,8 @@ "Tags":{"shape":"TagList"}, "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, "HealthCheckConfiguration":{"shape":"HealthCheckConfiguration"}, - "AutoScalingConfigurationArn":{"shape":"AppRunnerResourceArn"} + "AutoScalingConfigurationArn":{"shape":"AppRunnerResourceArn"}, + "NetworkConfiguration":{"shape":"NetworkConfiguration"} } }, "CreateServiceResponse":{ @@ -594,6 +651,26 @@ "OperationId":{"shape":"UUID"} } }, + "CreateVpcConnectorRequest":{ + "type":"structure", + "required":[ + "VpcConnectorName", + "Subnets" + ], + "members":{ + "VpcConnectorName":{"shape":"VpcConnectorName"}, + "Subnets":{"shape":"StringList"}, + "SecurityGroups":{"shape":"StringList"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateVpcConnectorResponse":{ + "type":"structure", + "required":["VpcConnector"], + "members":{ + "VpcConnector":{"shape":"VpcConnector"} + } + }, "CustomDomain":{ "type":"structure", "required":[ @@ -669,6 +746,20 @@ "OperationId":{"shape":"UUID"} } }, + "DeleteVpcConnectorRequest":{ + "type":"structure", + "required":["VpcConnectorArn"], + "members":{ + "VpcConnectorArn":{"shape":"AppRunnerResourceArn"} + } + }, + "DeleteVpcConnectorResponse":{ + "type":"structure", + "required":["VpcConnector"], + "members":{ + "VpcConnector":{"shape":"VpcConnector"} + } + }, "DescribeAutoScalingConfigurationRequest":{ "type":"structure", "required":["AutoScalingConfigurationArn"], @@ -725,6 +816,20 @@ "Service":{"shape":"Service"} } }, + "DescribeVpcConnectorRequest":{ + "type":"structure", + "required":["VpcConnectorArn"], + "members":{ + "VpcConnectorArn":{"shape":"AppRunnerResourceArn"} + } + }, + "DescribeVpcConnectorResponse":{ + "type":"structure", + "required":["VpcConnector"], + "members":{ + "VpcConnector":{"shape":"VpcConnector"} + } + }, "DisassociateCustomDomainRequest":{ "type":"structure", "required":[ @@ -752,7 +857,22 @@ "DomainName":{ "type":"string", "max":255, - "min":1 + "min":1, + "pattern":"[A-Za-z0-9*.-]{1,255}" + }, + "EgressConfiguration":{ + "type":"structure", + "members":{ + "EgressType":{"shape":"EgressType"}, + "VpcConnectorArn":{"shape":"AppRunnerResourceArn"} + } + }, + "EgressType":{ + "type":"string", + "enum":[ + "DEFAULT", + "VPC" + ] }, "EncryptionConfiguration":{ "type":"structure", @@ -811,7 +931,7 @@ "type":"structure", "members":{ "RuntimeEnvironmentVariables":{"shape":"RuntimeEnvironmentVariables"}, - "StartCommand":{"shape":"String"}, + "StartCommand":{"shape":"StartCommand"}, "Port":{"shape":"String"} } }, @@ -959,6 +1079,21 @@ "Tags":{"shape":"TagList"} } }, + "ListVpcConnectorsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListVpcConnectorsResponse":{ + "type":"structure", + "required":["VpcConnectors"], + "members":{ + "VpcConnectors":{"shape":"VpcConnectors"}, + "NextToken":{"shape":"NextToken"} + } + }, "MaxResults":{ "type":"integer", "max":100, @@ -970,6 +1105,12 @@ "min":4, "pattern":"2048|3072|4096|(2|3|4) GB" }, + "NetworkConfiguration":{ + "type":"structure", + "members":{ + "EgressConfiguration":{"shape":"EgressConfiguration"} + } + }, "NextToken":{ "type":"string", "max":1024, @@ -1076,10 +1217,16 @@ }, "RuntimeEnvironmentVariablesKey":{ "type":"string", + "max":51200, + "min":1, + "pattern":".*", "sensitive":true }, "RuntimeEnvironmentVariablesValue":{ "type":"string", + "max":51200, + "min":0, + "pattern":".*", "sensitive":true }, "Service":{ @@ -1094,7 +1241,8 @@ "Status", "SourceConfiguration", "InstanceConfiguration", - "AutoScalingConfigurationSummary" + "AutoScalingConfigurationSummary", + "NetworkConfiguration" ], "members":{ "ServiceName":{"shape":"ServiceName"}, @@ -1109,7 +1257,8 @@ "InstanceConfiguration":{"shape":"InstanceConfiguration"}, "EncryptionConfiguration":{"shape":"EncryptionConfiguration"}, "HealthCheckConfiguration":{"shape":"HealthCheckConfiguration"}, - "AutoScalingConfigurationSummary":{"shape":"AutoScalingConfigurationSummary"} + "AutoScalingConfigurationSummary":{"shape":"AutoScalingConfigurationSummary"}, + "NetworkConfiguration":{"shape":"NetworkConfiguration"} } }, "ServiceId":{ @@ -1189,6 +1338,7 @@ }, "StartCommand":{ "type":"string", + "pattern":"[^\\x0a\\x0d]+", "sensitive":true }, "StartDeploymentRequest":{ @@ -1211,6 +1361,10 @@ "min":0, "pattern":".*" }, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, "Tag":{ "type":"structure", "members":{ @@ -1285,7 +1439,8 @@ "SourceConfiguration":{"shape":"SourceConfiguration"}, "InstanceConfiguration":{"shape":"InstanceConfiguration"}, "AutoScalingConfigurationArn":{"shape":"AppRunnerResourceArn"}, - "HealthCheckConfiguration":{"shape":"HealthCheckConfiguration"} + "HealthCheckConfiguration":{"shape":"HealthCheckConfiguration"}, + "NetworkConfiguration":{"shape":"NetworkConfiguration"} } }, "UpdateServiceResponse":{ @@ -1298,6 +1453,36 @@ "Service":{"shape":"Service"}, "OperationId":{"shape":"UUID"} } + }, + "VpcConnector":{ + "type":"structure", + "members":{ + "VpcConnectorName":{"shape":"VpcConnectorName"}, + "VpcConnectorArn":{"shape":"AppRunnerResourceArn"}, + "VpcConnectorRevision":{"shape":"Integer"}, + "Subnets":{"shape":"StringList"}, + "SecurityGroups":{"shape":"StringList"}, + "Status":{"shape":"VpcConnectorStatus"}, + "CreatedAt":{"shape":"Timestamp"}, + "DeletedAt":{"shape":"Timestamp"} + } + }, + "VpcConnectorName":{ + "type":"string", + "max":40, + "min":4, + "pattern":"[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}" + }, + "VpcConnectorStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "VpcConnectors":{ + "type":"list", + "member":{"shape":"VpcConnector"} } } } diff --git a/apis/apprunner/2020-05-15/docs-2.json b/apis/apprunner/2020-05-15/docs-2.json index 7b9f05c450b..bc3df76fb43 100644 --- a/apis/apprunner/2020-05-15/docs-2.json +++ b/apis/apprunner/2020-05-15/docs-2.json @@ -3,21 +3,25 @@ "service": "App Runner

App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure Amazon Web Services resources.

App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security.

For more information about App Runner, see the App Runner Developer Guide. For release information, see the App Runner Release Notes.

To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services.

Endpoints

For a list of Region-specific endpoints that App Runner supports, see App Runner endpoints and quotas in the Amazon Web Services General Reference.

", "operations": { "AssociateCustomDomain": "

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).

", - "CreateAutoScalingConfiguration": "

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

Create multiple revisions of a configuration by using the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values. When you create a service, you can set it to use the latest active revision of an auto scaling configuration or a specific revision.

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

", + "CreateAutoScalingConfiguration": "

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call returns incremental AutoScalingConfigurationRevision values. When you create a service, you can set it to use the latest active revision of an auto scaling configuration or a specific revision.

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

", "CreateConnection": "

Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services.

A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.

", "CreateService": "

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

", + "CreateVpcConnector": "

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

", "DeleteAutoScalingConfiguration": "

Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.

", "DeleteConnection": "

Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.

", "DeleteService": "

Delete an App Runner service.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

", + "DeleteVpcConnector": "

Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

", "DescribeAutoScalingConfiguration": "

Return a full description of an App Runner automatic scaling configuration resource.

", "DescribeCustomDomains": "

Return a description of custom domain names that are associated with an App Runner service.

", "DescribeService": "

Return a full description of an App Runner service.

", + "DescribeVpcConnector": "

Return a description of an App Runner VPC connector resource.

", "DisassociateCustomDomain": "

Disassociate a custom domain name from an App Runner service.

Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.

", "ListAutoScalingConfigurations": "

Returns a list of App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all configurations in your account. You can optionally query only the latest revision of each requested name.

", "ListConnections": "

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

", "ListOperations": "

Return a list of operations that occurred on an App Runner service.

The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.

", "ListServices": "

Returns a list of running App Runner services in your Amazon Web Services account.

", "ListTagsForResource": "

List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

", + "ListVpcConnectors": "

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

", "PauseService": "

Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed).

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

", "ResumeService": "

Resume an active App Runner service. App Runner provisions compute capacity for the service.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

", "StartDeployment": "

Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.

For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

", @@ -54,16 +58,19 @@ "AutoScalingConfigurationSummary$AutoScalingConfigurationArn": "

The Amazon Resource Name (ARN) of this auto scaling configuration.

", "Connection$ConnectionArn": "

The Amazon Resource Name (ARN) of this connection.

", "ConnectionSummary$ConnectionArn": "

The Amazon Resource Name (ARN) of this connection.

", - "CreateServiceRequest$AutoScalingConfigurationArn": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

", + "CreateServiceRequest$AutoScalingConfigurationArn": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

", "DeleteAutoScalingConfigurationRequest$AutoScalingConfigurationArn": "

The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.

", "DeleteConnectionRequest$ConnectionArn": "

The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

", "DeleteServiceRequest$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service that you want to delete.

", + "DeleteVpcConnectorRequest$VpcConnectorArn": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.

The ARN must be a full VPC connector ARN.

", "DescribeAutoScalingConfigurationRequest$AutoScalingConfigurationArn": "

The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is described.

", "DescribeCustomDomainsRequest$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

", "DescribeCustomDomainsResponse$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

", "DescribeServiceRequest$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

", + "DescribeVpcConnectorRequest$VpcConnectorArn": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.

The ARN must be a full VPC connector ARN.

", "DisassociateCustomDomainRequest$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

", "DisassociateCustomDomainResponse$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.

", + "EgressConfiguration$VpcConnectorArn": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.

", "ListOperationsRequest$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.

", "ListTagsForResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource that a tag list is requested for.

It must be the ARN of an App Runner resource.

", "OperationSummary$TargetArn": "

The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).

", @@ -75,7 +82,8 @@ "TagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource that you want to update tags for.

It must be the ARN of an App Runner resource.

", "UntagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

It must be the ARN of an App Runner resource.

", "UpdateServiceRequest$ServiceArn": "

The Amazon Resource Name (ARN) of the App Runner service that you want to update.

", - "UpdateServiceRequest$AutoScalingConfigurationArn": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.

" + "UpdateServiceRequest$AutoScalingConfigurationArn": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.

", + "VpcConnector$VpcConnectorArn": "

The Amazon Resource Name (ARN) of this VPC connector.

" } }, "AssociateCustomDomainRequest": { @@ -95,7 +103,7 @@ } }, "AutoScalingConfiguration": { - "base": "

Describes an App Runner automatic scaling configuration resource. Multiple revisions of a configuration have the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values.

A higher MinSize increases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

A lower MaxSize controls your cost. The tradeoff is lower responsiveness during peak demand.

", + "base": "

Describes an App Runner automatic scaling configuration resource.

A higher MinSize increases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.

A lower MaxSize controls your cost. The tradeoff is lower responsiveness during peak demand.

Multiple revisions of a configuration might have the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values.

", "refs": { "CreateAutoScalingConfigurationResponse$AutoScalingConfiguration": "

A description of the App Runner auto scaling configuration that's created by this request.

", "DeleteAutoScalingConfigurationResponse$AutoScalingConfiguration": "

A description of the App Runner auto scaling configuration that this request just deleted.

", @@ -107,7 +115,7 @@ "refs": { "AutoScalingConfiguration$AutoScalingConfigurationName": "

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

", "AutoScalingConfigurationSummary$AutoScalingConfigurationName": "

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

", - "CreateAutoScalingConfigurationRequest$AutoScalingConfigurationName": "

A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

", + "CreateAutoScalingConfigurationRequest$AutoScalingConfigurationName": "

A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

The name DefaultConfiguration is reserved (it's the configuration that App Runner uses if you don't provide a custome one). You can't use it to create a new auto scaling configuration, and you can't create a revision of it.

When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.

", "ListAutoScalingConfigurationsRequest$AutoScalingConfigurationName": "

The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all configurations.

" } }, @@ -256,6 +264,16 @@ "refs": { } }, + "CreateVpcConnectorRequest": { + "base": null, + "refs": { + } + }, + "CreateVpcConnectorResponse": { + "base": null, + "refs": { + } + }, "CustomDomain": { "base": "

Describes a custom domain that's associated with an App Runner service.

", "refs": { @@ -306,6 +324,16 @@ "refs": { } }, + "DeleteVpcConnectorRequest": { + "base": null, + "refs": { + } + }, + "DeleteVpcConnectorResponse": { + "base": null, + "refs": { + } + }, "DescribeAutoScalingConfigurationRequest": { "base": null, "refs": { @@ -342,6 +370,16 @@ "refs": { } }, + "DescribeVpcConnectorRequest": { + "base": null, + "refs": { + } + }, + "DescribeVpcConnectorResponse": { + "base": null, + "refs": { + } + }, "DisassociateCustomDomainRequest": { "base": null, "refs": { @@ -360,11 +398,23 @@ "DisassociateCustomDomainRequest$DomainName": "

The domain name that you want to disassociate from the App Runner service.

" } }, + "EgressConfiguration": { + "base": "

Describes configuration settings related to outbound network traffic of an App Runner service.

", + "refs": { + "NetworkConfiguration$EgressConfiguration": "

Network configuration settings for outbound message traffic.

" + } + }, + "EgressType": { + "base": null, + "refs": { + "EgressConfiguration$EgressType": "

The type of egress configuration.

Set to DEFAULT for access to resources hosted on public networks.

Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

" + } + }, "EncryptionConfiguration": { "base": "

Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs.

", "refs": { - "CreateServiceRequest$EncryptionConfiguration": "

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed CMK.

", - "Service$EncryptionConfiguration": "

The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an Amazon Web Services managed CMK.

" + "CreateServiceRequest$EncryptionConfiguration": "

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.

", + "Service$EncryptionConfiguration": "

The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an Amazon Web Services managed key.

" } }, "ErrorMessage": { @@ -380,9 +430,9 @@ "HealthCheckConfiguration": { "base": "

Describes the settings for the health check that App Runner performs to monitor the health of a service.

", "refs": { - "CreateServiceRequest$HealthCheckConfiguration": "

The settings for the health check that App Runner performs to monitor the health of your service.

", + "CreateServiceRequest$HealthCheckConfiguration": "

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

", "Service$HealthCheckConfiguration": "

The settings for the health check that App Runner performs to monitor the health of this service.

", - "UpdateServiceRequest$HealthCheckConfiguration": "

The settings for the health check that App Runner performs to monitor the health of your service.

" + "UpdateServiceRequest$HealthCheckConfiguration": "

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

" } }, "HealthCheckHealthyThreshold": { @@ -460,7 +510,8 @@ "AutoScalingConfiguration$MaxConcurrency": "

The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.

", "AutoScalingConfiguration$MinSize": "

The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

", "AutoScalingConfiguration$MaxSize": "

The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.

", - "AutoScalingConfigurationSummary$AutoScalingConfigurationRevision": "

The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") with the same AutoScalingConfigurationName.

" + "AutoScalingConfigurationSummary$AutoScalingConfigurationRevision": "

The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") with the same AutoScalingConfigurationName.

", + "VpcConnector$VpcConnectorRevision": "

The revision of this VPC connector. It's unique among all the active connectors (\"Status\": \"ACTIVE\") that share the same Name.

At this time, App Runner supports only one revision per name.

" } }, "InternalServiceErrorException": { @@ -540,11 +591,22 @@ "refs": { } }, + "ListVpcConnectorsRequest": { + "base": null, + "refs": { + } + }, + "ListVpcConnectorsResponse": { + "base": null, + "refs": { + } + }, "MaxResults": { "base": null, "refs": { "ListAutoScalingConfigurationsRequest$MaxResults": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

", - "ListConnectionsRequest$MaxResults": "

The maximum number of results to include in each response (result page). Used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

" + "ListConnectionsRequest$MaxResults": "

The maximum number of results to include in each response (result page). Used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

", + "ListVpcConnectorsRequest$MaxResults": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

" } }, "Memory": { @@ -553,13 +615,23 @@ "InstanceConfiguration$Memory": "

The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

Default: 2 GB

" } }, + "NetworkConfiguration": { + "base": "

Describes configuration settings related to network traffic of an App Runner service. Consists of embedded objects for each configurable network feature.

", + "refs": { + "CreateServiceRequest$NetworkConfiguration": "

Configuration settings related to network traffic of the web application that the App Runner service runs.

", + "Service$NetworkConfiguration": "

Configuration settings related to network traffic of the web application that this service runs.

", + "UpdateServiceRequest$NetworkConfiguration": "

Configuration settings related to network traffic of the web application that the App Runner service runs.

" + } + }, "NextToken": { "base": null, "refs": { "ListAutoScalingConfigurationsRequest$NextToken": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

", "ListAutoScalingConfigurationsResponse$NextToken": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

", "ListConnectionsRequest$NextToken": "

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

", - "ListConnectionsResponse$NextToken": "

The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.

" + "ListConnectionsResponse$NextToken": "

The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.

", + "ListVpcConnectorsRequest$NextToken": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

", + "ListVpcConnectorsResponse$NextToken": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" } }, "NullableBoolean": { @@ -686,7 +758,7 @@ "ServiceName": { "base": null, "refs": { - "CreateServiceRequest$ServiceName": "

A name for the new service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

", + "CreateServiceRequest$ServiceName": "

A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

", "Service$ServiceName": "

The customer-provided service name.

", "ServiceSummary$ServiceName": "

The customer-provided service name.

" } @@ -738,7 +810,8 @@ "StartCommand": { "base": null, "refs": { - "CodeConfigurationValues$StartCommand": "

The command App Runner runs to start your application.

" + "CodeConfigurationValues$StartCommand": "

The command App Runner runs to start your application.

", + "ImageConfiguration$StartCommand": "

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

" } }, "StartDeploymentRequest": { @@ -764,7 +837,6 @@ "DescribeCustomDomainsResponse$DNSTarget": "

The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

", "DescribeCustomDomainsResponse$NextToken": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

", "DisassociateCustomDomainResponse$DNSTarget": "

The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.

", - "ImageConfiguration$StartCommand": "

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

", "ImageConfiguration$Port": "

The port that your application listens to in the container.

Default: 8080

", "ListOperationsRequest$NextToken": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

", "ListOperationsResponse$NextToken": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

", @@ -772,7 +844,17 @@ "ListServicesResponse$NextToken": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

", "Service$ServiceUrl": "

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

", "ServiceSummary$ServiceUrl": "

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

", - "SourceCodeVersion$Value": "

A source code version.

For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

" + "SourceCodeVersion$Value": "

A source code version.

For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

", + "StringList$member": null + } + }, + "StringList": { + "base": null, + "refs": { + "CreateVpcConnectorRequest$Subnets": "

A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

", + "CreateVpcConnectorRequest$SecurityGroups": "

A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

", + "VpcConnector$Subnets": "

A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

", + "VpcConnector$SecurityGroups": "

A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

" } }, "Tag": { @@ -799,7 +881,8 @@ "refs": { "CreateAutoScalingConfigurationRequest$Tags": "

A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

", "CreateConnectionRequest$Tags": "

A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

", - "CreateServiceRequest$Tags": "

An optional list of metadata items that you can associate with your service resource. A tag is a key-value pair.

", + "CreateServiceRequest$Tags": "

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

", + "CreateVpcConnectorRequest$Tags": "

A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

", "ListTagsForResourceResponse$Tags": "

A list of the tag key-value pairs that are associated with the resource.

", "TagResourceRequest$Tags": "

A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already associated with the resource, the value of the tag is updated.

" } @@ -834,7 +917,9 @@ "Service$UpdatedAt": "

The time when the App Runner service was last updated at. It's in the Unix time stamp format.

", "Service$DeletedAt": "

The time when the App Runner service was deleted. It's in the Unix time stamp format.

", "ServiceSummary$CreatedAt": "

The time when the App Runner service was created. It's in the Unix time stamp format.

", - "ServiceSummary$UpdatedAt": "

The time when the App Runner service was last updated. It's in theUnix time stamp format.

" + "ServiceSummary$UpdatedAt": "

The time when the App Runner service was last updated. It's in theUnix time stamp format.

", + "VpcConnector$CreatedAt": "

The time when the VPC connector was created. It's in Unix time stamp format.

", + "VpcConnector$DeletedAt": "

The time when the VPC connector was deleted. It's in Unix time stamp format.

" } }, "UUID": { @@ -868,6 +953,34 @@ "base": null, "refs": { } + }, + "VpcConnector": { + "base": "

Describes an App Runner VPC connector resource. A VPC connector describes the Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is associated with, and the subnets and security group that are used.

Multiple revisions of a connector might have the same Name and different Revision values.

At this time, App Runner supports only one revision per name.

", + "refs": { + "CreateVpcConnectorResponse$VpcConnector": "

A description of the App Runner VPC connector that's created by this request.

", + "DeleteVpcConnectorResponse$VpcConnector": "

A description of the App Runner VPC connector that this request just deleted.

", + "DescribeVpcConnectorResponse$VpcConnector": "

A description of the App Runner VPC connector that you specified in this request.

", + "VpcConnectors$member": null + } + }, + "VpcConnectorName": { + "base": null, + "refs": { + "CreateVpcConnectorRequest$VpcConnectorName": "

A name for the VPC connector.

", + "VpcConnector$VpcConnectorName": "

The customer-provided VPC connector name.

" + } + }, + "VpcConnectorStatus": { + "base": null, + "refs": { + "VpcConnector$Status": "

The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

" + } + }, + "VpcConnectors": { + "base": null, + "refs": { + "ListVpcConnectorsResponse$VpcConnectors": "

A list of information records for VPC connectors. In a paginated request, the request returns up to MaxResults records for each call.

" + } } } } diff --git a/apis/apprunner/2020-05-15/paginators-1.json b/apis/apprunner/2020-05-15/paginators-1.json index 698ccc695c0..bd38c8a6d74 100644 --- a/apis/apprunner/2020-05-15/paginators-1.json +++ b/apis/apprunner/2020-05-15/paginators-1.json @@ -24,6 +24,11 @@ "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults" + }, + "ListVpcConnectors": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" } } } diff --git a/apis/kendra/2019-02-03/api-2.json b/apis/kendra/2019-02-03/api-2.json index 70383e08326..4421169884c 100644 --- a/apis/kendra/2019-02-03/api-2.json +++ b/apis/kendra/2019-02-03/api-2.json @@ -1663,7 +1663,8 @@ "ConfluenceConfiguration":{"shape":"ConfluenceConfiguration"}, "GoogleDriveConfiguration":{"shape":"GoogleDriveConfiguration"}, "WebCrawlerConfiguration":{"shape":"WebCrawlerConfiguration"}, - "WorkDocsConfiguration":{"shape":"WorkDocsConfiguration"} + "WorkDocsConfiguration":{"shape":"WorkDocsConfiguration"}, + "FsxConfiguration":{"shape":"FsxConfiguration"} } }, "DataSourceDateFieldFormat":{ @@ -1834,7 +1835,8 @@ "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", - "WORKDOCS" + "WORKDOCS", + "FSX" ] }, "DataSourceVpcConfiguration":{ @@ -2701,6 +2703,33 @@ "min":1, "pattern":"^\\P{C}*.\\P{C}*$" }, + "FileSystemId":{ + "type":"string", + "max":21, + "min":11, + "pattern":"^(fs-[0-9a-f]{8,})$" + }, + "FsxConfiguration":{ + "type":"structure", + "required":[ + "FileSystemId", + "FileSystemType", + "VpcConfiguration" + ], + "members":{ + "FileSystemId":{"shape":"FileSystemId"}, + "FileSystemType":{"shape":"FsxFileSystemType"}, + "VpcConfiguration":{"shape":"DataSourceVpcConfiguration"}, + "SecretArn":{"shape":"SecretArn"}, + "InclusionPatterns":{"shape":"DataSourceInclusionsExclusionsStrings"}, + "ExclusionPatterns":{"shape":"DataSourceInclusionsExclusionsStrings"}, + "FieldMappings":{"shape":"DataSourceToIndexFieldMappingList"} + } + }, + "FsxFileSystemType":{ + "type":"string", + "enum":["WINDOWS"] + }, "GetQuerySuggestionsRequest":{ "type":"structure", "required":[ diff --git a/apis/kendra/2019-02-03/docs-2.json b/apis/kendra/2019-02-03/docs-2.json index 1c1ac1e4d07..274b4ad37dd 100644 --- a/apis/kendra/2019-02-03/docs-2.json +++ b/apis/kendra/2019-02-03/docs-2.json @@ -4,24 +4,24 @@ "operations": { "AssociateEntitiesToExperience": "

Grants users or groups in your Amazon Web Services SSO identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "AssociatePersonasToEntities": "

Defines the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", - "BatchDeleteDocument": "

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

", - "BatchGetDocumentStatus": "

Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

", - "BatchPutDocument": "

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.

", + "BatchDeleteDocument": "

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

", + "BatchGetDocumentStatus": "

Returns the indexing status for one or more documents submitted with the BatchPutDocument API.

When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

", + "BatchPutDocument": "

Adds one or more documents to an index.

The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.

", "ClearQuerySuggestions": "

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "CreateDataSource": "

Creates a data source that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.

", "CreateExperience": "

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "CreateFaq": "

Creates an new set of frequently asked question (FAQ) questions and answers.

Adding FAQs to an index is an asynchronous operation.

", - "CreateIndex": "

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.

", + "CreateIndex": "

Creates a new Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.

", "CreateQuerySuggestionsBlockList": "

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "CreateThesaurus": "

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

", - "DeleteDataSource": "

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources.

", + "DeleteDataSource": "

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.

", "DeleteExperience": "

Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "DeleteFaq": "

Removes an FAQ from an index.

", - "DeleteIndex": "

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.

", + "DeleteIndex": "

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.

", "DeletePrincipalMapping": "

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "DeleteQuerySuggestionsBlockList": "

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "DeleteThesaurus": "

Deletes an existing Amazon Kendra thesaurus.

", - "DescribeDataSource": "

Gets information about a Amazon Kendra data source.

", + "DescribeDataSource": "

Gets information about an Amazon Kendra data source.

", "DescribeExperience": "

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

", "DescribeFaq": "

Gets information about an FAQ list.

", "DescribeIndex": "

Describes an existing Amazon Kendra index

", @@ -45,9 +45,9 @@ "ListTagsForResource": "

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

", "ListThesauri": "

Lists the Amazon Kendra thesauri associated with an index.

", "PutPrincipalMapping": "

Maps users to their groups so that you only need to provide the user ID when you issue the query.

You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.

You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

PutPrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", - "Query": "

Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

Each query returns the 100 most relevant results.

", + "Query": "

Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

Each query returns the 100 most relevant results.

", "StartDataSourceSyncJob": "

Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

", - "StopDataSourceSyncJob": "

Stops a running synchronization job. You can't stop a scheduled synchronization job.

", + "StopDataSourceSyncJob": "

Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.

", "SubmitFeedback": "

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.

", "TagResource": "

Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.

", "UntagResource": "

Removes a tag from an index, FAQ, or a data source.

", @@ -184,7 +184,7 @@ } }, "BatchDeleteDocumentResponseFailedDocument": { - "base": "

Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.

", + "base": "

Provides information about documents that could not be removed from an index by the BatchDeleteDocument API.

", "refs": { "BatchDeleteDocumentResponseFailedDocuments$member": null } @@ -242,7 +242,7 @@ "Blob": { "base": null, "refs": { - "Document$Blob": "

The contents of the document.

Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

" + "Document$Blob": "

The contents of the document.

Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

" } }, "Boolean": { @@ -251,7 +251,7 @@ "ConfluenceAttachmentConfiguration$CrawlAttachments": "

Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

", "ConfluenceSpaceConfiguration$CrawlPersonalSpaces": "

Specifies whether Amazon Kendra should index personal spaces. Users can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.

", "ConfluenceSpaceConfiguration$CrawlArchivedSpaces": "

Specifies whether Amazon Kendra should index archived spaces.

", - "ContentSourceConfiguration$DirectPutContent": "

TRUE to use documents you indexed directly using the BatchPutDocument operation.

", + "ContentSourceConfiguration$DirectPutContent": "

TRUE to use documents you indexed directly using the BatchPutDocument API.

", "DocumentAttributeTarget$TargetDocumentAttributeValueDeletion": "

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.

", "Highlight$TopAnswer": "

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

", "InlineCustomDocumentEnrichmentConfiguration$DocumentContentDeletion": "

TRUE to delete content if the condition used for the target attribute is met.

", @@ -295,7 +295,7 @@ } }, "ClickFeedback": { - "base": "

Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information.

", + "base": "

Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback API to provide click information.

", "refs": { "ClickFeedbackList$member": null } @@ -309,12 +309,12 @@ "ClientTokenName": { "base": null, "refs": { - "CreateDataSourceRequest$ClientToken": "

A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource operation with the same client token will create only one data source.

", - "CreateExperienceRequest$ClientToken": "

A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience operation with the same client token creates only one Amazon Kendra experience.

", - "CreateFaqRequest$ClientToken": "

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest operation with the same client token will create only one FAQ.

", - "CreateIndexRequest$ClientToken": "

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.

", + "CreateDataSourceRequest$ClientToken": "

A token that you provide to identify the request to create a data source. Multiple calls to the CreateDataSource API with the same client token will create only one data source.

", + "CreateExperienceRequest$ClientToken": "

A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.

", + "CreateFaqRequest$ClientToken": "

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

", + "CreateIndexRequest$ClientToken": "

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

", "CreateQuerySuggestionsBlockListRequest$ClientToken": "

A token that you provide to identify the request to create a query suggestions block list.

", - "CreateThesaurusRequest$ClientToken": "

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus operation with the same client token will create only one thesaurus.

" + "CreateThesaurusRequest$ClientToken": "

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus API with the same client token will create only one thesaurus.

" } }, "ColumnConfiguration": { @@ -326,7 +326,7 @@ "ColumnName": { "base": null, "refs": { - "AclConfiguration$AllowedGroupsColumnName": "

A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

", + "AclConfiguration$AllowedGroupsColumnName": "

A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query API.

", "ChangeDetectingColumns$member": null, "ColumnConfiguration$DocumentIdColumnName": "

The column that provides the document's unique identifier.

", "ColumnConfiguration$DocumentDataColumnName": "

The column that contains the contents of the document.

", @@ -353,23 +353,23 @@ "ConfluenceAttachmentFieldMappingsList": { "base": null, "refs": { - "ConfluenceAttachmentConfiguration$AttachmentFieldMappings": "

Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

" + "ConfluenceAttachmentConfiguration$AttachmentFieldMappings": "

Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

" } }, "ConfluenceAttachmentFieldName": { "base": null, "refs": { - "ConfluenceAttachmentToIndexFieldMapping$DataSourceFieldName": "

The name of the field in the data source.

You must first create the index field using the UpdateIndex operation.

" + "ConfluenceAttachmentToIndexFieldMapping$DataSourceFieldName": "

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

" } }, "ConfluenceAttachmentToIndexFieldMapping": { - "base": "

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

", + "base": "

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex API.

", "refs": { "ConfluenceAttachmentFieldMappingsList$member": null } }, "ConfluenceBlogConfiguration": { - "base": "

Specifies the blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration type.

", + "base": "

Specifies the blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.

", "refs": { "ConfluenceConfiguration$BlogConfiguration": "

Specifies configuration information for indexing Confluence blogs.

" } @@ -377,7 +377,7 @@ "ConfluenceBlogFieldMappingsList": { "base": null, "refs": { - "ConfluenceBlogConfiguration$BlogFieldMappings": "

Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

" + "ConfluenceBlogConfiguration$BlogFieldMappings": "

Defines how blog metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API.

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

" } }, "ConfluenceBlogFieldName": { @@ -387,7 +387,7 @@ } }, "ConfluenceBlogToIndexFieldMapping": { - "base": "

Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

", + "base": "

Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex API.

", "refs": { "ConfluenceBlogFieldMappingsList$member": null } @@ -407,7 +407,7 @@ "ConfluencePageFieldMappingsList": { "base": null, "refs": { - "ConfluencePageConfiguration$PageFieldMappings": "

Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

" + "ConfluencePageConfiguration$PageFieldMappings": "

Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API.

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

" } }, "ConfluencePageFieldName": { @@ -417,7 +417,7 @@ } }, "ConfluencePageToIndexFieldMapping": { - "base": "

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

", + "base": "

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex API.

", "refs": { "ConfluencePageFieldMappingsList$member": null } @@ -431,7 +431,7 @@ "ConfluenceSpaceFieldMappingsList": { "base": null, "refs": { - "ConfluenceSpaceConfiguration$SpaceFieldMappings": "

Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

" + "ConfluenceSpaceConfiguration$SpaceFieldMappings": "

Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex API.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

" } }, "ConfluenceSpaceFieldName": { @@ -454,7 +454,7 @@ } }, "ConfluenceSpaceToIndexFieldMapping": { - "base": "

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

", + "base": "

Defines the mapping between a field in the Confluence data source to an Amazon Kendra index field.

You must first create the index field using the UpdateIndex API.

", "refs": { "ConfluenceSpaceFieldMappingsList$member": null } @@ -474,7 +474,7 @@ "ContentSourceConfiguration": { "base": "

Configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument.

", "refs": { - "ExperienceConfiguration$ContentSourceConfiguration": "

The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument operation. This is the content you want to use for your Amazon Kendra experience.

" + "ExperienceConfiguration$ContentSourceConfiguration": "

The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. This is the content you want to use for your Amazon Kendra experience.

" } }, "ContentType": { @@ -552,7 +552,7 @@ "CustomDocumentEnrichmentConfiguration": { "base": "

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process.

", "refs": { - "BatchPutDocumentRequest$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument operation.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

", + "BatchPutDocumentRequest$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

", "CreateDataSourceRequest$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering document metadata and content during the document ingestion process when you create a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

", "DescribeDataSourceResponse$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

", "UpdateDataSourceRequest$CustomDocumentEnrichmentConfiguration": "

Configuration information for altering document metadata and content during the document ingestion process when you update a data source.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

" @@ -643,6 +643,8 @@ "refs": { "ConfluenceConfiguration$InclusionPatterns": "

A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.

", "ConfluenceConfiguration$ExclusionPatterns": "

A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.

", + "FsxConfiguration$InclusionPatterns": "

A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

", + "FsxConfiguration$ExclusionPatterns": "

A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

", "GoogleDriveConfiguration$InclusionPatterns": "

A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.

", "GoogleDriveConfiguration$ExclusionPatterns": "

A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.

", "OneDriveConfiguration$InclusionPatterns": "

A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The exclusion pattern is applied to the file name.

", @@ -687,7 +689,7 @@ } }, "DataSourceSummary": { - "base": "

Summary information for a Amazon Kendra data source. Returned in a call to the DescribeDataSource operation.

", + "base": "

Summary information for an Amazon Kendra data source. Returned in a call to the DescribeDataSource API.

", "refs": { "DataSourceSummaryList$member": null } @@ -699,7 +701,7 @@ } }, "DataSourceSyncJob": { - "base": "

Provides information about a synchronization job.

", + "base": "

Provides information about a data source synchronization job.

", "refs": { "DataSourceSyncJobHistoryList$member": null } @@ -736,7 +738,7 @@ } }, "DataSourceToIndexFieldMapping": { - "base": "

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.

", + "base": "

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex API.

", "refs": { "DataSourceToIndexFieldMappingList$member": null } @@ -744,8 +746,9 @@ "DataSourceToIndexFieldMappingList": { "base": null, "refs": { - "ColumnConfiguration$FieldMappings": "

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

", - "GoogleDriveConfiguration$FieldMappings": "

Defines mapping between a field in the Google Drive and a Amazon Kendra index field.

If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.

", + "ColumnConfiguration$FieldMappings": "

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

", + "FsxConfiguration$FieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names in Amazon Kendra. To create custom fields, use the UpdateIndex API before you map to Amazon FSx fields. For more information, see Mapping data source fields. The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.

", + "GoogleDriveConfiguration$FieldMappings": "

Defines mapping between a field in the Google Drive and a Amazon Kendra index field.

If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex API.

", "OneDriveConfiguration$FieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

", "SalesforceChatterFeedConfiguration$FieldMappings": "

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

", "SalesforceCustomKnowledgeArticleTypeConfiguration$FieldMappings": "

One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.

", @@ -754,8 +757,8 @@ "SalesforceStandardObjectConfiguration$FieldMappings": "

One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.

", "ServiceNowKnowledgeArticleConfiguration$FieldMappings": "

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

", "ServiceNowServiceCatalogConfiguration$FieldMappings": "

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

", - "SharePointConfiguration$FieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

", - "WorkDocsConfiguration$FieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.

" + "SharePointConfiguration$FieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the UpdateIndex API before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

", + "WorkDocsConfiguration$FieldMappings": "

A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.

" } }, "DataSourceType": { @@ -771,6 +774,7 @@ "refs": { "ConfluenceConfiguration$VpcConfiguration": "

Specifies the information for connecting to an Amazon VPC.

", "DatabaseConfiguration$VpcConfiguration": null, + "FsxConfiguration$VpcConfiguration": "

Provides the configuration information for connecting to an Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.

", "SharePointConfiguration$VpcConfiguration": null } }, @@ -1019,7 +1023,7 @@ "DocumentAttributeList": { "base": null, "refs": { - "Document$Attributes": "

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

", + "Document$Attributes": "

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

", "DocumentInfo$Attributes": "

Attributes that identify a specific version of a document to check.

The only valid attributes are:

The attributes follow these rules:

", "QueryResultItem$DocumentAttributes": "

An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

" } @@ -1104,7 +1108,7 @@ "DocumentList": { "base": null, "refs": { - "BatchPutDocumentRequest$Documents": "

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

Documents have the following file size limits.

For more information about file size and transaction per second quotas, see Quotas.

" + "BatchPutDocumentRequest$Documents": "

One or more documents to add to the index.

Documents have the following file size limits.

For more information about file size and transaction per second quotas, see Quotas.

" } }, "DocumentMetadataBoolean": { @@ -1236,7 +1240,7 @@ "BatchDeleteDocumentResponseFailedDocument$ErrorCode": "

The error code for why the document couldn't be removed from the index.

", "BatchGetDocumentStatusResponseError$ErrorCode": "

Indicates the source of the error.

", "BatchPutDocumentResponseFailedDocument$ErrorCode": "

The type of error that caused the document to fail to be indexed.

", - "DataSourceSyncJob$ErrorCode": "

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

" + "DataSourceSyncJob$ErrorCode": "

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

" } }, "ErrorMessage": { @@ -1471,6 +1475,24 @@ "QueryResultItem$FeedbackToken": "

A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .

" } }, + "FileSystemId": { + "base": null, + "refs": { + "FsxConfiguration$FileSystemId": "

The identifier of the Amazon FSx file system.

You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see Amazon FSx Getting started guide.

" + } + }, + "FsxConfiguration": { + "base": "

Provides the configuration information to connect to Amazon FSx as your data source.

", + "refs": { + "DataSourceConfiguration$FsxConfiguration": "

Provides the configuration information to connect to Amazon FSx as your data source.

" + } + }, + "FsxFileSystemType": { + "base": null, + "refs": { + "FsxConfiguration$FileSystemType": "

The Amazon FSx file system type. Windows is currently the only supported type.

" + } + }, "GetQuerySuggestionsRequest": { "base": null, "refs": { @@ -1637,8 +1659,8 @@ "AssociateEntitiesToExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", "AssociatePersonasToEntitiesRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", "BatchDeleteDocumentRequest$IndexId": "

The identifier of the index that contains the documents to delete.

", - "BatchGetDocumentStatusRequest$IndexId": "

The identifier of the index to add documents to. The index ID is returned by the CreateIndex operation.

", - "BatchPutDocumentRequest$IndexId": "

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

", + "BatchGetDocumentStatusRequest$IndexId": "

The identifier of the index to add documents to. The index ID is returned by the CreateIndex API.

", + "BatchPutDocumentRequest$IndexId": "

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.

", "ClearQuerySuggestionsRequest$IndexId": "

The identifier of the index you want to clear query suggestions from.

", "CreateDataSourceRequest$IndexId": "

The identifier of the index that should be associated with this data source.

", "CreateExperienceRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", @@ -1672,7 +1694,7 @@ "DisassociatePersonasFromEntitiesRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", "GetQuerySuggestionsRequest$IndexId": "

The identifier of the index you want to get query suggestions from.

", "GetSnapshotsRequest$IndexId": "

The identifier of the index to get search metrics data.

", - "IndexConfigurationSummary$Id": "

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

", + "IndexConfigurationSummary$Id": "

A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

", "ListDataSourceSyncJobsRequest$IndexId": "

The identifier of the index that contains the data source.

", "ListDataSourcesRequest$IndexId": "

The identifier of the index that contains the data source.

", "ListEntityPersonasRequest$IndexId": "

The identifier of the index for your Amazon Kendra experience.

", @@ -1683,7 +1705,7 @@ "ListQuerySuggestionsBlockListsRequest$IndexId": "

The identifier of the index for a list of all block lists that exist for that index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

", "ListThesauriRequest$IndexId": "

The identifier of the index associated with the thesaurus to list.

", "PutPrincipalMappingRequest$IndexId": "

The identifier of the index you want to map users to their groups.

", - "QueryRequest$IndexId": "

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex operation.

", + "QueryRequest$IndexId": "

The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex API.

", "StartDataSourceSyncJobRequest$IndexId": "

The identifier of the index that contains the data source.

", "StopDataSourceSyncJobRequest$IndexId": "

The identifier of the index that contains the data source.

", "SubmitFeedbackRequest$IndexId": "

The identifier of the index that was queried.

", @@ -2092,7 +2114,7 @@ "Mode": { "base": null, "refs": { - "DescribeQuerySuggestionsConfigResponse$Mode": "

Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig operation.

", + "DescribeQuerySuggestionsConfigResponse$Mode": "

Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

", "UpdateQuerySuggestionsConfigRequest$Mode": "

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

" } }, @@ -2267,7 +2289,7 @@ "base": null, "refs": { "QueryResult$QueryId": "

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

", - "SubmitFeedbackRequest$QueryId": "

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query operation.

" + "SubmitFeedbackRequest$QueryId": "

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

" } }, "QueryIdentifiersEnclosingOption": { @@ -2376,7 +2398,7 @@ } }, "RelevanceFeedback": { - "base": "

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information.

", + "base": "

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.

", "refs": { "RelevanceFeedbackList$member": null } @@ -2425,16 +2447,16 @@ "RoleArn": { "base": null, "refs": { - "BatchPutDocumentRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

", + "BatchPutDocumentRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument API. For more information, see IAM Roles for Amazon Kendra.

", "CreateDataSourceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

", - "CreateExperienceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access Query operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

", + "CreateExperienceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

", "CreateFaqRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

", - "CreateIndexRequest$RoleArn": "

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

", - "CreateQuerySuggestionsBlockListRequest$RoleArn": "

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

", + "CreateIndexRequest$RoleArn": "

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument API to index documents from an Amazon S3 bucket.

", + "CreateQuerySuggestionsBlockListRequest$RoleArn": "

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

", "CreateThesaurusRequest$RoleArn": "

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

", "CustomDocumentEnrichmentConfiguration$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra.

", "DescribeDataSourceResponse$RoleArn": "

The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.

", - "DescribeExperienceResponse$RoleArn": "

Shows the Amazon Resource Name (ARN) of a role with permission to access Query operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon Web Services SSO that stores your user and group information.

", + "DescribeExperienceResponse$RoleArn": "

Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.

", "DescribeFaqResponse$RoleArn": "

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

", "DescribeIndexResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

", "DescribeQuerySuggestionsBlockListResponse$RoleArn": "

Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

", @@ -2442,7 +2464,7 @@ "JwtTokenTypeConfiguration$SecretManagerArn": "

The Amazon Resource Name (arn) of the secret.

", "PutPrincipalMappingRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

For more information, see IAM roles for Amazon Kendra.

", "UpdateDataSourceRequest$RoleArn": "

The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.

", - "UpdateExperienceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access Query operations, QuerySuggestions operations, SubmitFeedback operations, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

", + "UpdateExperienceRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

", "UpdateIndexRequest$RoleArn": "

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

", "UpdateQuerySuggestionsBlockListRequest$RoleArn": "

The IAM (Identity and Access Management) role used to access the block list text file in S3.

", "UpdateThesaurusRequest$RoleArn": "

The updated role ARN of the thesaurus.

" @@ -2580,8 +2602,8 @@ "ScanSchedule": { "base": null, "refs": { - "CreateDataSourceRequest$Schedule": "

Sets the frequency that Amazon Kendra will check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob operation to update the index.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

", - "DescribeDataSourceResponse$Schedule": "

The schedule that Amazon Kendra will update the data source.

", + "CreateDataSourceRequest$Schedule": "

Sets the frequency for Amazon Kendra to check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

", + "DescribeDataSourceResponse$Schedule": "

The schedule for Amazon Kendra to update the index.

", "UpdateDataSourceRequest$Schedule": "

The new update schedule for the data source.

" } }, @@ -2609,6 +2631,7 @@ "BasicAuthenticationConfiguration$Credentials": "

Your secret ARN, which you can create in Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

", "ConfluenceConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:

", "ConnectionConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.

", + "FsxConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:

", "GoogleDriveConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

", "OneDriveConfiguration$SecretArn": "

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

", "ProxyConfiguration$Credentials": "

Your secret ARN, which you can create in Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

", @@ -3007,8 +3030,8 @@ "ClickFeedback$ClickTime": "

The Unix timestamp of the date and time that the result was clicked.

", "DataSourceSummary$CreatedAt": "

The UNIX datetime that the data source was created.

", "DataSourceSummary$UpdatedAt": "

The UNIX datetime that the data source was lasted updated.

", - "DataSourceSyncJob$StartTime": "

The UNIX datetime that the synchronization job was started.

", - "DataSourceSyncJob$EndTime": "

The UNIX datetime that the synchronization job was completed.

", + "DataSourceSyncJob$StartTime": "

The UNIX datetime that the synchronization job started.

", + "DataSourceSyncJob$EndTime": "

The UNIX datetime that the synchronization job completed.

", "DescribeDataSourceResponse$CreatedAt": "

The Unix timestamp of when the data source was created.

", "DescribeDataSourceResponse$UpdatedAt": "

The Unix timestamp of when the data source was last updated.

", "DescribeExperienceResponse$CreatedAt": "

Shows the date-time your Amazon Kendra experience was created.

", @@ -3030,7 +3053,7 @@ "GroupOrderingIdSummary$LastUpdatedAt": "

The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.

", "GroupOrderingIdSummary$ReceivedAt": "

The date-time an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

", "IndexConfigurationSummary$CreatedAt": "

The Unix timestamp when the index was created.

", - "IndexConfigurationSummary$UpdatedAt": "

The Unix timestamp when the index was last updated by the UpdateIndex operation.

", + "IndexConfigurationSummary$UpdatedAt": "

The Unix timestamp when the index was last updated by the UpdateIndex API.

", "PersonasSummary$CreatedAt": "

The date-time the summary information was created.

", "PersonasSummary$UpdatedAt": "

The date-time the summary information was last updated.

", "QuerySuggestionsBlockListSummary$CreatedAt": "

The date-time summary information for a query suggestions block list was last created.

", @@ -3130,7 +3153,7 @@ } }, "UserGroupResolutionConfiguration": { - "base": "

Provides the configuration information to fetch access levels of groups and users from an Amazon Web Services Single Sign On identity source. This is useful for setting up user context filtering, where Amazon Kendra filters search results for different users based on their group's access to documents. You can also map your users to their groups for user context filtering using the PutPrincipalMapping operation.

To set up an Amazon Web Services SSO identity source in the console to use with Amazon Kendra, see Getting started with an Amazon Web Services SSO identity source. You must also grant the required permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see IAM roles for Amazon Web Services SSO.

Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your Amazon Web Services SSO identify source. You must create your index in the parent account for the organization in order to use UserGroupResolutionConfiguration.

", + "base": "

Provides the configuration information to fetch access levels of groups and users from an Amazon Web Services Single Sign On identity source. This is useful for setting up user context filtering, where Amazon Kendra filters search results for different users based on their group's access to documents. You can also map your users to their groups for user context filtering using the PutPrincipalMapping API.

To set up an Amazon Web Services SSO identity source in the console to use with Amazon Kendra, see Getting started with an Amazon Web Services SSO identity source. You must also grant the required permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see IAM roles for Amazon Web Services SSO.

Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your Amazon Web Services SSO identify source. You must create your index in the management account for the organization in order to use UserGroupResolutionConfiguration.

", "refs": { "CreateIndexRequest$UserGroupResolutionConfiguration": "

Enables fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source. To configure this, see UserGroupResolutionConfiguration.

", "DescribeIndexResponse$UserGroupResolutionConfiguration": "

Shows whether you have enabled the configuration for fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source.

", @@ -3243,7 +3266,7 @@ "WorkDocsConfiguration": { "base": "

Provides the configuration information to connect to Amazon WorkDocs as your data source.

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

", "refs": { - "DataSourceConfiguration$WorkDocsConfiguration": "

Provides the configuration information to connect to WorkDocs as your data source.

" + "DataSourceConfiguration$WorkDocsConfiguration": "

Provides the configuration information to connect to Amazon WorkDocs as your data source.

" } } } diff --git a/apis/s3control/2018-08-20/api-2.json b/apis/s3control/2018-08-20/api-2.json index 0e4f4a3febb..dbb75c35c81 100644 --- a/apis/s3control/2018-08-20/api-2.json +++ b/apis/s3control/2018-08-20/api-2.json @@ -1138,7 +1138,6 @@ "Operation", "Report", "ClientRequestToken", - "Manifest", "Priority", "RoleArn" ], @@ -1166,7 +1165,8 @@ "box":true }, "RoleArn":{"shape":"IAMRoleArn"}, - "Tags":{"shape":"S3TagSet"} + "Tags":{"shape":"S3TagSet"}, + "ManifestGenerator":{"shape":"JobManifestGenerator"} } }, "CreateJobResult":{ @@ -1591,6 +1591,23 @@ "min":1, "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" }, + "GeneratedManifestEncryption":{ + "type":"structure", + "members":{ + "SSES3":{ + "shape":"SSES3Encryption", + "locationName":"SSE-S3" + }, + "SSEKMS":{ + "shape":"SSEKMSEncryption", + "locationName":"SSE-KMS" + } + } + }, + "GeneratedManifestFormat":{ + "type":"string", + "enum":["S3InventoryReport_CSV_20211130"] + }, "GetAccessPointConfigurationForObjectLambdaRequest":{ "type":"structure", "required":[ @@ -2181,7 +2198,9 @@ "SuspendedCause":{ "shape":"SuspendedCause", "box":true - } + }, + "ManifestGenerator":{"shape":"JobManifestGenerator"}, + "GeneratedManifestDescriptor":{"shape":"S3GeneratedManifestDescriptor"} } }, "JobFailure":{ @@ -2259,6 +2278,25 @@ "S3InventoryReport_CSV_20161130" ] }, + "JobManifestGenerator":{ + "type":"structure", + "members":{ + "S3JobManifestGenerator":{"shape":"S3JobManifestGenerator"} + }, + "union":true + }, + "JobManifestGeneratorFilter":{ + "type":"structure", + "members":{ + "EligibleForReplication":{ + "shape":"Boolean", + "box":true + }, + "CreatedAfter":{"shape":"ObjectCreationTime"}, + "CreatedBefore":{"shape":"ObjectCreationTime"}, + "ObjectReplicationStatuses":{"shape":"ReplicationStatusFilterList"} + } + }, "JobManifestLocation":{ "type":"structure", "required":[ @@ -2327,6 +2365,10 @@ "S3PutObjectRetention":{ "shape":"S3SetObjectRetentionOperation", "box":true + }, + "S3ReplicateObject":{ + "shape":"S3ReplicateObjectOperation", + "box":true } } }, @@ -2349,7 +2391,8 @@ "NumberOfTasksFailed":{ "shape":"JobNumberOfTasksFailed", "box":true - } + }, + "Timers":{"shape":"JobTimers"} } }, "JobReport":{ @@ -2421,6 +2464,19 @@ "min":1 }, "JobTerminationDate":{"type":"timestamp"}, + "JobTimeInStateSeconds":{ + "type":"long", + "min":0 + }, + "JobTimers":{ + "type":"structure", + "members":{ + "ElapsedTimeInActiveSeconds":{ + "shape":"JobTimeInStateSeconds", + "box":true + } + } + }, "JobTotalNumberOfTasks":{ "type":"long", "min":0 @@ -2686,6 +2742,11 @@ } }, "Location":{"type":"string"}, + "ManifestPrefixString":{ + "type":"string", + "max":512, + "min":1 + }, "MaxLength1024String":{ "type":"string", "max":1024 @@ -2834,6 +2895,7 @@ }, "exception":true }, + "ObjectCreationTime":{"type":"timestamp"}, "ObjectLambdaAccessPoint":{ "type":"structure", "required":["Name"], @@ -2942,7 +3004,8 @@ "S3DeleteObjectTagging", "S3InitiateRestoreObject", "S3PutObjectLegalHold", - "S3PutObjectRetention" + "S3PutObjectRetention", + "S3ReplicateObject" ] }, "OutputSchemaVersion":{ @@ -3346,6 +3409,19 @@ "locationName":"Region" } }, + "ReplicationStatus":{ + "type":"string", + "enum":[ + "COMPLETED", + "FAILED", + "REPLICA", + "NONE" + ] + }, + "ReplicationStatusFilterList":{ + "type":"list", + "member":{"shape":"ReplicationStatus"} + }, "ReportPrefixString":{ "type":"string", "max":512, @@ -3466,6 +3542,13 @@ "type":"integer", "min":0 }, + "S3GeneratedManifestDescriptor":{ + "type":"structure", + "members":{ + "Format":{"shape":"GeneratedManifestFormat"}, + "Location":{"shape":"JobManifestLocation"} + } + }, "S3GlacierJobTier":{ "type":"string", "enum":[ @@ -3513,12 +3596,40 @@ "GlacierJobTier":{"shape":"S3GlacierJobTier"} } }, + "S3JobManifestGenerator":{ + "type":"structure", + "required":[ + "SourceBucket", + "EnableManifestOutput" + ], + "members":{ + "ExpectedBucketOwner":{"shape":"AccountId"}, + "SourceBucket":{"shape":"S3BucketArnString"}, + "ManifestOutputLocation":{"shape":"S3ManifestOutputLocation"}, + "Filter":{"shape":"JobManifestGeneratorFilter"}, + "EnableManifestOutput":{"shape":"Boolean"} + } + }, "S3KeyArnString":{ "type":"string", "max":2000, "min":1, "pattern":"arn:[^:]+:s3:.*" }, + "S3ManifestOutputLocation":{ + "type":"structure", + "required":[ + "Bucket", + "ManifestFormat" + ], + "members":{ + "ExpectedManifestBucketOwner":{"shape":"AccountId"}, + "Bucket":{"shape":"S3BucketArnString"}, + "ManifestPrefix":{"shape":"ManifestPrefixString"}, + "ManifestEncryption":{"shape":"GeneratedManifestEncryption"}, + "ManifestFormat":{"shape":"GeneratedManifestFormat"} + } + }, "S3MetadataDirective":{ "type":"string", "enum":[ @@ -3600,6 +3711,11 @@ "max":128, "min":4 }, + "S3ReplicateObjectOperation":{ + "type":"structure", + "members":{ + } + }, "S3Retention":{ "type":"structure", "members":{ @@ -3652,7 +3768,8 @@ "ONEZONE_IA", "GLACIER", "INTELLIGENT_TIERING", - "DEEP_ARCHIVE" + "DEEP_ARCHIVE", + "GLACIER_IR" ] }, "S3Tag":{ @@ -3684,6 +3801,14 @@ }, "locationName":"SSE-KMS" }, + "SSEKMSEncryption":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{"shape":"KmsKeyArnString"} + }, + "locationName":"SSE-KMS" + }, "SSEKMSKeyId":{"type":"string"}, "SSES3":{ "type":"structure", @@ -3691,6 +3816,12 @@ }, "locationName":"SSE-S3" }, + "SSES3Encryption":{ + "type":"structure", + "members":{ + }, + "locationName":"SSE-S3" + }, "SelectionCriteria":{ "type":"structure", "members":{ diff --git a/apis/s3control/2018-08-20/docs-2.json b/apis/s3control/2018-08-20/docs-2.json index 975dac83308..4335d9b6063 100644 --- a/apis/s3control/2018-08-20/docs-2.json +++ b/apis/s3control/2018-08-20/docs-2.json @@ -5,7 +5,7 @@ "CreateAccessPoint": "

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

", "CreateAccessPointForObjectLambda": "

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to CreateAccessPointForObjectLambda:

", "CreateBucket": "

This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

S3 on Outposts buckets support:

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.

The following actions are related to CreateBucket for Amazon S3 on Outposts:

", - "CreateJob": "

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

", + "CreateJob": "

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

", "CreateMultiRegionAccessPoint": "

Creates a Multi-Region Access Point and associates it with the specified buckets. For more information about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

This request is asynchronous, meaning that you might receive a response before the command has completed. When this request provides a response, it provides a token that you can use to monitor the status of the request with DescribeMultiRegionAccessPointOperation.

The following actions are related to CreateMultiRegionAccessPoint:

", "DeleteAccessPoint": "

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPoint:

", "DeleteAccessPointForObjectLambda": "

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

", @@ -20,7 +20,7 @@ "DeletePublicAccessBlock": "

Removes the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

", "DeleteStorageLensConfiguration": "

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

", "DeleteStorageLensConfigurationTagging": "

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

", - "DescribeJob": "

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", + "DescribeJob": "

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", "DescribeMultiRegionAccessPointOperation": "

Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information about managing Multi-Region Access Points and how asynchronous requests work, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to GetMultiRegionAccessPoint:

", "GetAccessPoint": "

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to GetAccessPoint:

", "GetAccessPointConfigurationForObjectLambda": "

Returns configuration for an Object Lambda Access Point.

The following actions are related to GetAccessPointConfigurationForObjectLambda:

", @@ -41,8 +41,8 @@ "GetStorageLensConfiguration": "

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

", "GetStorageLensConfigurationTagging": "

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

", "ListAccessPoints": "

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

", - "ListAccessPointsForObjectLambda": "

Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000 access points per call. If there are more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

", - "ListJobs": "

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", + "ListAccessPointsForObjectLambda": "

Returns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there are more access points than what can be returned in one call, the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

", + "ListJobs": "

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", "ListMultiRegionAccessPoints": "

Returns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account. Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be associated with a single account.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to ListMultiRegionAccessPoint:

", "ListRegionalBuckets": "

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

", "ListStorageLensConfigurations": "

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

", @@ -54,11 +54,11 @@ "PutBucketTagging": "

This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.

To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.

PutBucketTagging has the following special errors:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutBucketTagging:

", "PutJobTagging": "

Sets the supplied tag-set on an S3 Batch Operations job.

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

", "PutMultiRegionAccessPointPolicy": "

Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point.

This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around managing Multi-Region Access Points, see Managing Multi-Region Access Points in the Amazon S3 User Guide.

The following actions are related to PutMultiRegionAccessPointPolicy:

", - "PutPublicAccessBlock": "

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For more information, see Using Amazon S3 block public access.

Related actions include:

", + "PutPublicAccessBlock": "

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutBucketPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

Related actions include:

", "PutStorageLensConfiguration": "

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

", "PutStorageLensConfigurationTagging": "

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

", - "UpdateJobPriority": "

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", - "UpdateJobStatus": "

Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

" + "UpdateJobPriority": "

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

", + "UpdateJobStatus": "

Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

" }, "shapes": { "AbortIncompleteMultipartUpload": { @@ -151,6 +151,8 @@ "PutStorageLensConfigurationRequest$AccountId": "

The account ID of the requester.

", "PutStorageLensConfigurationTaggingRequest$AccountId": "

The account ID of the requester.

", "S3BucketDestination$AccountId": "

The account ID of the owner of the S3 Storage Lens metrics export bucket.

", + "S3JobManifestGenerator$ExpectedBucketOwner": "

The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

", + "S3ManifestOutputLocation$ExpectedManifestBucketOwner": "

The Account ID that owns the bucket the generated manifest is written to.

", "UpdateJobPriorityRequest$AccountId": "

The Amazon Web Services account ID associated with the S3 Batch Operations job.

", "UpdateJobStatusRequest$AccountId": "

The Amazon Web Services account ID associated with the S3 Batch Operations job.

" } @@ -255,10 +257,12 @@ "Boolean": { "base": null, "refs": { + "JobManifestGeneratorFilter$EligibleForReplication": "

Include objects in the generated manifest only if they are eligible for replication according to the Replication configuration on the source bucket.

", "JobReport$Enabled": "

Indicates whether the specified job will generate a job-completion report.

", "ObjectLambdaConfiguration$CloudWatchMetricsEnabled": "

A container for whether the CloudWatch metrics configuration is enabled.

", "S3CopyObjectOperation$RequesterPays": "

", "S3CopyObjectOperation$BucketKeyEnabled": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

", + "S3JobManifestGenerator$EnableManifestOutput": "

Determines whether or not to write the job's generated manifest to a bucket.

", "S3ObjectMetadata$RequesterCharged": "

", "S3SetObjectRetentionOperation$BypassGovernanceRetention": "

Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

" } @@ -626,6 +630,19 @@ "LambdaInvokeOperation$FunctionArn": "

The Amazon Resource Name (ARN) for the Lambda function that the specified job will invoke on every object in the manifest.

" } }, + "GeneratedManifestEncryption": { + "base": "

The encryption configuration to use when storing the generated manifest.

", + "refs": { + "S3ManifestOutputLocation$ManifestEncryption": "

Specifies what encryption should be used when the generated manifest objects are written.

" + } + }, + "GeneratedManifestFormat": { + "base": null, + "refs": { + "S3GeneratedManifestDescriptor$Format": "

The format of the generated manifest.

", + "S3ManifestOutputLocation$ManifestFormat": "

The format of the generated manifest.

" + } + }, "GetAccessPointConfigurationForObjectLambdaRequest": { "base": null, "refs": { @@ -987,10 +1004,24 @@ "JobManifestSpec$Format": "

Indicates which of the available formats the specified manifest uses.

" } }, + "JobManifestGenerator": { + "base": "

Configures the type of the job's ManifestGenerator.

", + "refs": { + "CreateJobRequest$ManifestGenerator": "

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

", + "JobDescriptor$ManifestGenerator": "

The manifest generator that was used to generate a job manifest for this job.

" + } + }, + "JobManifestGeneratorFilter": { + "base": "

The filter used to describe a set of objects for the job's manifest.

", + "refs": { + "S3JobManifestGenerator$Filter": "

Specifies rules the S3JobManifestGenerator should use to use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

" + } + }, "JobManifestLocation": { "base": "

Contains the information required to locate a manifest object.

", "refs": { - "JobManifest$Location": "

Contains the information required to locate the specified job's manifest.

" + "JobManifest$Location": "

Contains the information required to locate the specified job's manifest.

", + "S3GeneratedManifestDescriptor$Location": null } }, "JobManifestSpec": { @@ -1089,6 +1120,18 @@ "JobListDescriptor$TerminationDate": "

A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

" } }, + "JobTimeInStateSeconds": { + "base": null, + "refs": { + "JobTimers$ElapsedTimeInActiveSeconds": "

Indicates the elapsed time in seconds the job has been in the Active job state.

" + } + }, + "JobTimers": { + "base": "

Provides timing details for the job.

", + "refs": { + "JobProgressSummary$Timers": "

The JobTimers attribute of a job's progress summary.

" + } + }, "JobTotalNumberOfTasks": { "base": null, "refs": { @@ -1098,7 +1141,8 @@ "KmsKeyArnString": { "base": null, "refs": { - "S3CopyObjectOperation$SSEAwsKmsKeyId": "

" + "S3CopyObjectOperation$SSEAwsKmsKeyId": "

", + "SSEKMSEncryption$KeyId": "

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting generated manifest objects.

" } }, "LambdaInvokeOperation": { @@ -1216,6 +1260,12 @@ "CreateBucketResult$Location": "

The location of the bucket.

" } }, + "ManifestPrefixString": { + "base": null, + "refs": { + "S3ManifestOutputLocation$ManifestPrefix": "

Prefix identifying one or more objects to which the manifest applies.

" + } + }, "MaxLength1024String": { "base": null, "refs": { @@ -1229,7 +1279,7 @@ "MaxResults": { "base": null, "refs": { - "ListAccessPointsForObjectLambdaRequest$MaxResults": "

The maximum number of access points that you want to include in the list. If there are more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

", + "ListAccessPointsForObjectLambdaRequest$MaxResults": "

The maximum number of access points that you want to include in the list. The response may contain fewer access points but will never contain more. If there are more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

", "ListAccessPointsRequest$MaxResults": "

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

", "ListJobsRequest$MaxResults": "

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

", "ListMultiRegionAccessPointsRequest$MaxResults": "

Not currently used. Do not use this parameter.

", @@ -1403,6 +1453,13 @@ "refs": { } }, + "ObjectCreationTime": { + "base": null, + "refs": { + "JobManifestGeneratorFilter$CreatedAfter": "

If provided, the generated manifest should include only source bucket objects that were created after this time.

", + "JobManifestGeneratorFilter$CreatedBefore": "

If provided, the generated manifest should include only source bucket objects that were created before this time.

" + } + }, "ObjectLambdaAccessPoint": { "base": "

An access point with an attached Lambda function used to access transformed data from an Amazon S3 bucket.

", "refs": { @@ -1711,6 +1768,18 @@ "Include$Regions": "

A container for the S3 Storage Lens Region includes.

" } }, + "ReplicationStatus": { + "base": null, + "refs": { + "ReplicationStatusFilterList$member": null + } + }, + "ReplicationStatusFilterList": { + "base": null, + "refs": { + "JobManifestGeneratorFilter$ObjectReplicationStatuses": "

If provided, the generated manifest should include only source bucket objects that have one of the specified Replication statuses.

" + } + }, "ReportPrefixString": { "base": null, "refs": { @@ -1756,7 +1825,9 @@ "Buckets$member": null, "JobReport$Bucket": "

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

", "S3BucketDestination$Arn": "

The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name

", - "S3CopyObjectOperation$TargetResource": "

Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named \"destinationBucket\", set the TargetResource to \"arn:aws:s3:::destinationBucket\".

" + "S3CopyObjectOperation$TargetResource": "

Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named \"destinationBucket\", set the TargetResource to \"arn:aws:s3:::destinationBucket\".

", + "S3JobManifestGenerator$SourceBucket": "

The source bucket used by the ManifestGenerator.

", + "S3ManifestOutputLocation$Bucket": "

The bucket ARN the generated manifest should be written to.

" } }, "S3BucketDestination": { @@ -1793,7 +1864,13 @@ "S3ExpirationInDays": { "base": null, "refs": { - "S3InitiateRestoreObjectOperation$ExpirationInDays": "

This argument specifies how long the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

S3 Batch Operations jobs can operate either on S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

" + "S3InitiateRestoreObjectOperation$ExpirationInDays": "

This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

" + } + }, + "S3GeneratedManifestDescriptor": { + "base": "

Describes the specified job's generated manifest. Batch Operations jobs created with a ManifestGenerator populate details of this descriptor after execution of the ManifestGenerator.

", + "refs": { + "JobDescriptor$GeneratedManifestDescriptor": "

The attribute of the JobDescriptor containing details about the job's generated manifest.

" } }, "S3GlacierJobTier": { @@ -1833,12 +1910,24 @@ "JobOperation$S3InitiateRestoreObject": "

Directs the specified job to initiate restore requests for every archived object in the manifest.

" } }, + "S3JobManifestGenerator": { + "base": "

The container for the service that will create the S3 manifest.

", + "refs": { + "JobManifestGenerator$S3JobManifestGenerator": "

The S3 job ManifestGenerator's configuration details.

" + } + }, "S3KeyArnString": { "base": null, "refs": { "JobManifestLocation$ObjectArn": "

The Amazon Resource Name (ARN) for a manifest object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

" } }, + "S3ManifestOutputLocation": { + "base": "

Location details for where the generated manifest should be written.

", + "refs": { + "S3JobManifestGenerator$ManifestOutputLocation": "

Specifies the location the generated manifest will be written to.

" + } + }, "S3MetadataDirective": { "base": null, "refs": { @@ -1873,7 +1962,7 @@ "S3ObjectMetadata": { "base": "

", "refs": { - "S3CopyObjectOperation$NewObjectMetadata": "

" + "S3CopyObjectOperation$NewObjectMetadata": "

If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

" } }, "S3ObjectOwner": { @@ -1901,6 +1990,12 @@ "RegionalBucket$BucketArn": "

The Amazon Resource Name (ARN) for the regional bucket.

" } }, + "S3ReplicateObjectOperation": { + "base": "

Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

", + "refs": { + "JobOperation$S3ReplicateObject": "

Directs the specified job to invoke ReplicateObject on every object in the job's manifest.

" + } + }, "S3Retention": { "base": "

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

", "refs": { @@ -1975,6 +2070,12 @@ "StorageLensDataExportEncryption$SSEKMS": "

" } }, + "SSEKMSEncryption": { + "base": "

Configuration for the use of SSE-KMS to encrypt generated manifest objects.

", + "refs": { + "GeneratedManifestEncryption$SSEKMS": "

Configuration details on how SSE-KMS is used to encrypt generated manifest objects.

" + } + }, "SSEKMSKeyId": { "base": null, "refs": { @@ -1987,6 +2088,12 @@ "StorageLensDataExportEncryption$SSES3": "

" } }, + "SSES3Encryption": { + "base": "

Configuration for the use of SSE-S3 to encrypt generated manifest objects.

", + "refs": { + "GeneratedManifestEncryption$SSES3": "

Specifies the use of SSE-S3 to encrypt generated manifest objects.

" + } + }, "SelectionCriteria": { "base": "

", "refs": { diff --git a/apis/sagemaker/2017-07-24/api-2.json b/apis/sagemaker/2017-07-24/api-2.json index dbda4cf549f..5b50c4174fe 100644 --- a/apis/sagemaker/2017-07-24/api-2.json +++ b/apis/sagemaker/2017-07-24/api-2.json @@ -3589,7 +3589,9 @@ "Completed", "ExplainabilityError", "DeployingModel", - "ModelDeploymentError" + "ModelDeploymentError", + "GeneratingModelInsightsReport", + "ModelInsightsError" ] }, "AutoMLJobStatus":{ @@ -3848,7 +3850,8 @@ "type":"structure", "required":["Explainability"], "members":{ - "Explainability":{"shape":"ExplainabilityLocation"} + "Explainability":{"shape":"ExplainabilityLocation"}, + "ModelInsights":{"shape":"ModelInsightsLocation"} } }, "CandidateDefinitionNotebookLocation":{ @@ -11590,6 +11593,10 @@ "DataInputConfig":{"shape":"DataInputConfig"} } }, + "ModelInsightsLocation":{ + "type":"string", + "min":1 + }, "ModelLatencyThreshold":{ "type":"structure", "members":{ diff --git a/apis/sagemaker/2017-07-24/docs-2.json b/apis/sagemaker/2017-07-24/docs-2.json index 30369c6b2ea..92109cabada 100644 --- a/apis/sagemaker/2017-07-24/docs-2.json +++ b/apis/sagemaker/2017-07-24/docs-2.json @@ -6740,6 +6740,12 @@ "ModelPackageContainerDefinition$ModelInput": "

A structure with Model Input details.

" } }, + "ModelInsightsLocation": { + "base": null, + "refs": { + "CandidateArtifactLocations$ModelInsights": "

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

" + } + }, "ModelLatencyThreshold": { "base": "

The model latency threshold.

", "refs": { diff --git a/gems/aws-sdk-apprunner/CHANGELOG.md b/gems/aws-sdk-apprunner/CHANGELOG.md index 64c54566654..94d4a4f790e 100644 --- a/gems/aws-sdk-apprunner/CHANGELOG.md +++ b/gems/aws-sdk-apprunner/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.10.0 (2022-02-08) +------------------ + +* Feature - This release adds support for App Runner to route outbound network traffic of a service through an Amazon VPC. New API: CreateVpcConnector, DescribeVpcConnector, ListVpcConnectors, and DeleteVpcConnector. Updated API: CreateService, DescribeService, and UpdateService. + 1.9.0 (2022-02-03) ------------------ diff --git a/gems/aws-sdk-apprunner/VERSION b/gems/aws-sdk-apprunner/VERSION index f8e233b2733..81c871de46b 100644 --- a/gems/aws-sdk-apprunner/VERSION +++ b/gems/aws-sdk-apprunner/VERSION @@ -1 +1 @@ -1.9.0 +1.10.0 diff --git a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner.rb b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner.rb index b9f57d475f4..688a4050257 100644 --- a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner.rb +++ b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner.rb @@ -48,6 +48,6 @@ # @!group service module Aws::AppRunner - GEM_VERSION = '1.9.0' + GEM_VERSION = '1.10.0' end diff --git a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb index 94f1d907c03..61295770c52 100644 --- a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb +++ b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client.rb @@ -432,11 +432,11 @@ def associate_custom_domain(params = {}, options = {}) # require non-default auto scaling settings. You can share an auto # scaling configuration across multiple services. # - # Create multiple revisions of a configuration by using the same - # `AutoScalingConfigurationName` and different - # `AutoScalingConfigurationRevision` values. When you create a service, - # you can set it to use the latest active revision of an auto scaling - # configuration or a specific revision. + # Create multiple revisions of a configuration by calling this action + # multiple times using the same `AutoScalingConfigurationName`. The call + # returns incremental `AutoScalingConfigurationRevision` values. When + # you create a service, you can set it to use the latest active revision + # of an auto scaling configuration or a specific revision. # # Configure a higher `MinSize` to increase the spread of your App Runner # service over more Availability Zones in the Amazon Web Services @@ -452,6 +452,17 @@ def associate_custom_domain(params = {}, options = {}) # subsequent calls, App Runner creates incremental revisions of the # configuration. # + # The name `DefaultConfiguration` is reserved (it's the configuration + # that App Runner uses if you don't provide a custome one). You can't + # use it to create a new auto scaling configuration, and you can't + # create a revision of it. + # + # When you want to use your own auto scaling configuration for your App + # Runner service, *create a configuration with a different name*, and + # then provide it when you create or update your service. + # + # + # # @option params [Integer] :max_concurrency # The maximum number of concurrent requests that you want an instance to # process. If the number of concurrent requests exceeds this limit, App @@ -592,9 +603,9 @@ def create_connection(params = {}, options = {}) # [1]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html # # @option params [required, String] :service_name - # A name for the new service. It must be unique across all the running - # App Runner services in your Amazon Web Services account in the Amazon - # Web Services Region. + # A name for the App Runner service. It must be unique across all the + # running App Runner services in your Amazon Web Services account in the + # Amazon Web Services Region. # # @option params [required, Types::SourceConfiguration] :source_configuration # The source to deploy to the App Runner service. It can be a code or an @@ -605,23 +616,27 @@ def create_connection(params = {}, options = {}) # Runner service. # # @option params [Array] :tags - # An optional list of metadata items that you can associate with your - # service resource. A tag is a key-value pair. + # An optional list of metadata items that you can associate with the App + # Runner service resource. A tag is a key-value pair. # # @option params [Types::EncryptionConfiguration] :encryption_configuration # An optional custom encryption key that App Runner uses to encrypt the # copy of your source repository that it maintains and your service - # logs. By default, App Runner uses an Amazon Web Services managed CMK. + # logs. By default, App Runner uses an Amazon Web Services managed key. # # @option params [Types::HealthCheckConfiguration] :health_check_configuration # The settings for the health check that App Runner performs to monitor - # the health of your service. + # the health of the App Runner service. # # @option params [String] :auto_scaling_configuration_arn # The Amazon Resource Name (ARN) of an App Runner automatic scaling - # configuration resource that you want to associate with your service. - # If not provided, App Runner associates the latest revision of a - # default auto scaling configuration. + # configuration resource that you want to associate with the App Runner + # service. If not provided, App Runner associates the latest revision of + # a default auto scaling configuration. + # + # @option params [Types::NetworkConfiguration] :network_configuration + # Configuration settings related to network traffic of the web + # application that the App Runner service runs. # # @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -658,7 +673,7 @@ def create_connection(params = {}, options = {}) # runtime_environment_variables: { # "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue", # }, - # start_command: "String", + # start_command: "StartCommand", # port: "String", # }, # image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC @@ -692,6 +707,12 @@ def create_connection(params = {}, options = {}) # unhealthy_threshold: 1, # }, # auto_scaling_configuration_arn: "AppRunnerResourceArn", + # network_configuration: { + # egress_configuration: { + # egress_type: "DEFAULT", # accepts DEFAULT, VPC + # vpc_connector_arn: "AppRunnerResourceArn", + # }, + # }, # }) # # @example Response structure @@ -736,6 +757,8 @@ def create_connection(params = {}, options = {}) # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer + # resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC" + # resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateService AWS API Documentation @@ -747,6 +770,69 @@ def create_service(params = {}, options = {}) req.send_request(options) end + # Create an App Runner VPC connector resource. App Runner requires this + # resource when you want to associate your App Runner service to a + # custom Amazon Virtual Private Cloud (Amazon VPC). + # + # @option params [required, String] :vpc_connector_name + # A name for the VPC connector. + # + # @option params [required, Array] :subnets + # A list of IDs of subnets that App Runner should use when it associates + # your service with a custom Amazon VPC. Specify IDs of subnets of a + # single Amazon VPC. App Runner determines the Amazon VPC from the + # subnets you specify. + # + # @option params [Array] :security_groups + # A list of IDs of security groups that App Runner should use for access + # to Amazon Web Services resources under the specified subnets. If not + # specified, App Runner uses the default security group of the Amazon + # VPC. The default security group allows all outbound traffic. + # + # @option params [Array] :tags + # A list of metadata items that you can associate with your VPC + # connector resource. A tag is a key-value pair. + # + # @return [Types::CreateVpcConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CreateVpcConnectorResponse#vpc_connector #vpc_connector} => Types::VpcConnector + # + # @example Request syntax with placeholder values + # + # resp = client.create_vpc_connector({ + # vpc_connector_name: "VpcConnectorName", # required + # subnets: ["String"], # required + # security_groups: ["String"], + # tags: [ + # { + # key: "TagKey", + # value: "TagValue", + # }, + # ], + # }) + # + # @example Response structure + # + # resp.vpc_connector.vpc_connector_name #=> String + # resp.vpc_connector.vpc_connector_arn #=> String + # resp.vpc_connector.vpc_connector_revision #=> Integer + # resp.vpc_connector.subnets #=> Array + # resp.vpc_connector.subnets[0] #=> String + # resp.vpc_connector.security_groups #=> Array + # resp.vpc_connector.security_groups[0] #=> String + # resp.vpc_connector.status #=> String, one of "ACTIVE", "INACTIVE" + # resp.vpc_connector.created_at #=> Time + # resp.vpc_connector.deleted_at #=> Time + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateVpcConnector AWS API Documentation + # + # @overload create_vpc_connector(params = {}) + # @param [Hash] params ({}) + def create_vpc_connector(params = {}, options = {}) + req = build_request(:create_vpc_connector, params) + req.send_request(options) + end + # Delete an App Runner automatic scaling configuration resource. You can # delete a specific revision or the latest active revision. You can't # delete a configuration that's used by one or more App Runner @@ -890,6 +976,8 @@ def delete_connection(params = {}, options = {}) # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer + # resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC" + # resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteService AWS API Documentation @@ -901,6 +989,47 @@ def delete_service(params = {}, options = {}) req.send_request(options) end + # Delete an App Runner VPC connector resource. You can't delete a + # connector that's used by one or more App Runner services. + # + # @option params [required, String] :vpc_connector_arn + # The Amazon Resource Name (ARN) of the App Runner VPC connector that + # you want to delete. + # + # The ARN must be a full VPC connector ARN. + # + # @return [Types::DeleteVpcConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DeleteVpcConnectorResponse#vpc_connector #vpc_connector} => Types::VpcConnector + # + # @example Request syntax with placeholder values + # + # resp = client.delete_vpc_connector({ + # vpc_connector_arn: "AppRunnerResourceArn", # required + # }) + # + # @example Response structure + # + # resp.vpc_connector.vpc_connector_name #=> String + # resp.vpc_connector.vpc_connector_arn #=> String + # resp.vpc_connector.vpc_connector_revision #=> Integer + # resp.vpc_connector.subnets #=> Array + # resp.vpc_connector.subnets[0] #=> String + # resp.vpc_connector.security_groups #=> Array + # resp.vpc_connector.security_groups[0] #=> String + # resp.vpc_connector.status #=> String, one of "ACTIVE", "INACTIVE" + # resp.vpc_connector.created_at #=> Time + # resp.vpc_connector.deleted_at #=> Time + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteVpcConnector AWS API Documentation + # + # @overload delete_vpc_connector(params = {}) + # @param [Hash] params ({}) + def delete_vpc_connector(params = {}, options = {}) + req = build_request(:delete_vpc_connector, params) + req.send_request(options) + end + # Return a full description of an App Runner automatic scaling # configuration resource. # @@ -1066,6 +1195,8 @@ def describe_custom_domains(params = {}, options = {}) # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer + # resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC" + # resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeService AWS API Documentation # @@ -1076,6 +1207,46 @@ def describe_service(params = {}, options = {}) req.send_request(options) end + # Return a description of an App Runner VPC connector resource. + # + # @option params [required, String] :vpc_connector_arn + # The Amazon Resource Name (ARN) of the App Runner VPC connector that + # you want a description for. + # + # The ARN must be a full VPC connector ARN. + # + # @return [Types::DescribeVpcConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DescribeVpcConnectorResponse#vpc_connector #vpc_connector} => Types::VpcConnector + # + # @example Request syntax with placeholder values + # + # resp = client.describe_vpc_connector({ + # vpc_connector_arn: "AppRunnerResourceArn", # required + # }) + # + # @example Response structure + # + # resp.vpc_connector.vpc_connector_name #=> String + # resp.vpc_connector.vpc_connector_arn #=> String + # resp.vpc_connector.vpc_connector_revision #=> Integer + # resp.vpc_connector.subnets #=> Array + # resp.vpc_connector.subnets[0] #=> String + # resp.vpc_connector.security_groups #=> Array + # resp.vpc_connector.security_groups[0] #=> String + # resp.vpc_connector.status #=> String, one of "ACTIVE", "INACTIVE" + # resp.vpc_connector.created_at #=> Time + # resp.vpc_connector.deleted_at #=> Time + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeVpcConnector AWS API Documentation + # + # @overload describe_vpc_connector(params = {}) + # @param [Hash] params ({}) + def describe_vpc_connector(params = {}, options = {}) + req = build_request(:describe_vpc_connector, params) + req.send_request(options) + end + # Disassociate a custom domain name from an App Runner service. # # Certificates tracking domain validity are associated with a custom @@ -1405,6 +1576,63 @@ def list_tags_for_resource(params = {}, options = {}) req.send_request(options) end + # Returns a list of App Runner VPC connectors in your Amazon Web + # Services account. + # + # @option params [Integer] :max_results + # The maximum number of results to include in each response (result + # page). It's used for a paginated request. + # + # If you don't specify `MaxResults`, the request retrieves all + # available results in a single response. + # + # @option params [String] :next_token + # A token from a previous result page. It's used for a paginated + # request. The request retrieves the next result page. All other + # parameter values must be identical to the ones that are specified in + # the initial request. + # + # If you don't specify `NextToken`, the request retrieves the first + # result page. + # + # @return [Types::ListVpcConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListVpcConnectorsResponse#vpc_connectors #vpc_connectors} => Array<Types::VpcConnector> + # * {Types::ListVpcConnectorsResponse#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_vpc_connectors({ + # max_results: 1, + # next_token: "NextToken", + # }) + # + # @example Response structure + # + # resp.vpc_connectors #=> Array + # resp.vpc_connectors[0].vpc_connector_name #=> String + # resp.vpc_connectors[0].vpc_connector_arn #=> String + # resp.vpc_connectors[0].vpc_connector_revision #=> Integer + # resp.vpc_connectors[0].subnets #=> Array + # resp.vpc_connectors[0].subnets[0] #=> String + # resp.vpc_connectors[0].security_groups #=> Array + # resp.vpc_connectors[0].security_groups[0] #=> String + # resp.vpc_connectors[0].status #=> String, one of "ACTIVE", "INACTIVE" + # resp.vpc_connectors[0].created_at #=> Time + # resp.vpc_connectors[0].deleted_at #=> Time + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListVpcConnectors AWS API Documentation + # + # @overload list_vpc_connectors(params = {}) + # @param [Hash] params ({}) + def list_vpc_connectors(params = {}, options = {}) + req = build_request(:list_vpc_connectors, params) + req.send_request(options) + end + # Pause an active App Runner service. App Runner reduces compute # capacity for the service to zero and loses state (for example, # ephemeral storage is removed). @@ -1470,6 +1698,8 @@ def list_tags_for_resource(params = {}, options = {}) # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer + # resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC" + # resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/PauseService AWS API Documentation @@ -1545,6 +1775,8 @@ def pause_service(params = {}, options = {}) # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer + # resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC" + # resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ResumeService AWS API Documentation @@ -1699,11 +1931,16 @@ def untag_resource(params = {}, options = {}) # # @option params [String] :auto_scaling_configuration_arn # The Amazon Resource Name (ARN) of an App Runner automatic scaling - # configuration resource that you want to associate with your service. + # configuration resource that you want to associate with the App Runner + # service. # # @option params [Types::HealthCheckConfiguration] :health_check_configuration # The settings for the health check that App Runner performs to monitor - # the health of your service. + # the health of the App Runner service. + # + # @option params [Types::NetworkConfiguration] :network_configuration + # Configuration settings related to network traffic of the web + # application that the App Runner service runs. # # @return [Types::UpdateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1740,7 +1977,7 @@ def untag_resource(params = {}, options = {}) # runtime_environment_variables: { # "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue", # }, - # start_command: "String", + # start_command: "StartCommand", # port: "String", # }, # image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC @@ -1765,6 +2002,12 @@ def untag_resource(params = {}, options = {}) # healthy_threshold: 1, # unhealthy_threshold: 1, # }, + # network_configuration: { + # egress_configuration: { + # egress_type: "DEFAULT", # accepts DEFAULT, VPC + # vpc_connector_arn: "AppRunnerResourceArn", + # }, + # }, # }) # # @example Response structure @@ -1809,6 +2052,8 @@ def untag_resource(params = {}, options = {}) # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_arn #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_name #=> String # resp.service.auto_scaling_configuration_summary.auto_scaling_configuration_revision #=> Integer + # resp.service.network_configuration.egress_configuration.egress_type #=> String, one of "DEFAULT", "VPC" + # resp.service.network_configuration.egress_configuration.vpc_connector_arn #=> String # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/UpdateService AWS API Documentation @@ -1833,7 +2078,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-apprunner' - context[:gem_version] = '1.9.0' + context[:gem_version] = '1.10.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client_api.rb b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client_api.rb index 8586cfde271..9d8909265c8 100644 --- a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client_api.rb +++ b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/client_api.rb @@ -46,6 +46,8 @@ module ClientApi CreateConnectionResponse = Shapes::StructureShape.new(name: 'CreateConnectionResponse') CreateServiceRequest = Shapes::StructureShape.new(name: 'CreateServiceRequest') CreateServiceResponse = Shapes::StructureShape.new(name: 'CreateServiceResponse') + CreateVpcConnectorRequest = Shapes::StructureShape.new(name: 'CreateVpcConnectorRequest') + CreateVpcConnectorResponse = Shapes::StructureShape.new(name: 'CreateVpcConnectorResponse') CustomDomain = Shapes::StructureShape.new(name: 'CustomDomain') CustomDomainAssociationStatus = Shapes::StringShape.new(name: 'CustomDomainAssociationStatus') CustomDomainList = Shapes::ListShape.new(name: 'CustomDomainList') @@ -55,6 +57,8 @@ module ClientApi DeleteConnectionResponse = Shapes::StructureShape.new(name: 'DeleteConnectionResponse') DeleteServiceRequest = Shapes::StructureShape.new(name: 'DeleteServiceRequest') DeleteServiceResponse = Shapes::StructureShape.new(name: 'DeleteServiceResponse') + DeleteVpcConnectorRequest = Shapes::StructureShape.new(name: 'DeleteVpcConnectorRequest') + DeleteVpcConnectorResponse = Shapes::StructureShape.new(name: 'DeleteVpcConnectorResponse') DescribeAutoScalingConfigurationRequest = Shapes::StructureShape.new(name: 'DescribeAutoScalingConfigurationRequest') DescribeAutoScalingConfigurationResponse = Shapes::StructureShape.new(name: 'DescribeAutoScalingConfigurationResponse') DescribeCustomDomainsMaxResults = Shapes::IntegerShape.new(name: 'DescribeCustomDomainsMaxResults') @@ -62,9 +66,13 @@ module ClientApi DescribeCustomDomainsResponse = Shapes::StructureShape.new(name: 'DescribeCustomDomainsResponse') DescribeServiceRequest = Shapes::StructureShape.new(name: 'DescribeServiceRequest') DescribeServiceResponse = Shapes::StructureShape.new(name: 'DescribeServiceResponse') + DescribeVpcConnectorRequest = Shapes::StructureShape.new(name: 'DescribeVpcConnectorRequest') + DescribeVpcConnectorResponse = Shapes::StructureShape.new(name: 'DescribeVpcConnectorResponse') DisassociateCustomDomainRequest = Shapes::StructureShape.new(name: 'DisassociateCustomDomainRequest') DisassociateCustomDomainResponse = Shapes::StructureShape.new(name: 'DisassociateCustomDomainResponse') DomainName = Shapes::StringShape.new(name: 'DomainName') + EgressConfiguration = Shapes::StructureShape.new(name: 'EgressConfiguration') + EgressType = Shapes::StringShape.new(name: 'EgressType') EncryptionConfiguration = Shapes::StructureShape.new(name: 'EncryptionConfiguration') ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage') HealthCheckConfiguration = Shapes::StructureShape.new(name: 'HealthCheckConfiguration') @@ -95,8 +103,11 @@ module ClientApi ListServicesResponse = Shapes::StructureShape.new(name: 'ListServicesResponse') ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest') ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse') + ListVpcConnectorsRequest = Shapes::StructureShape.new(name: 'ListVpcConnectorsRequest') + ListVpcConnectorsResponse = Shapes::StructureShape.new(name: 'ListVpcConnectorsResponse') MaxResults = Shapes::IntegerShape.new(name: 'MaxResults') Memory = Shapes::StringShape.new(name: 'Memory') + NetworkConfiguration = Shapes::StructureShape.new(name: 'NetworkConfiguration') NextToken = Shapes::StringShape.new(name: 'NextToken') NullableBoolean = Shapes::BooleanShape.new(name: 'NullableBoolean') OperationStatus = Shapes::StringShape.new(name: 'OperationStatus') @@ -129,6 +140,7 @@ module ClientApi StartDeploymentRequest = Shapes::StructureShape.new(name: 'StartDeploymentRequest') StartDeploymentResponse = Shapes::StructureShape.new(name: 'StartDeploymentResponse') String = Shapes::StringShape.new(name: 'String') + StringList = Shapes::ListShape.new(name: 'StringList') Tag = Shapes::StructureShape.new(name: 'Tag') TagKey = Shapes::StringShape.new(name: 'TagKey') TagKeyList = Shapes::ListShape.new(name: 'TagKeyList') @@ -142,6 +154,10 @@ module ClientApi UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse') UpdateServiceRequest = Shapes::StructureShape.new(name: 'UpdateServiceRequest') UpdateServiceResponse = Shapes::StructureShape.new(name: 'UpdateServiceResponse') + VpcConnector = Shapes::StructureShape.new(name: 'VpcConnector') + VpcConnectorName = Shapes::StringShape.new(name: 'VpcConnectorName') + VpcConnectorStatus = Shapes::StringShape.new(name: 'VpcConnectorStatus') + VpcConnectors = Shapes::ListShape.new(name: 'VpcConnectors') AssociateCustomDomainRequest.add_member(:service_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, required: true, location_name: "ServiceArn")) AssociateCustomDomainRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "DomainName")) @@ -241,12 +257,22 @@ module ClientApi CreateServiceRequest.add_member(:encryption_configuration, Shapes::ShapeRef.new(shape: EncryptionConfiguration, location_name: "EncryptionConfiguration")) CreateServiceRequest.add_member(:health_check_configuration, Shapes::ShapeRef.new(shape: HealthCheckConfiguration, location_name: "HealthCheckConfiguration")) CreateServiceRequest.add_member(:auto_scaling_configuration_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, location_name: "AutoScalingConfigurationArn")) + CreateServiceRequest.add_member(:network_configuration, Shapes::ShapeRef.new(shape: NetworkConfiguration, location_name: "NetworkConfiguration")) CreateServiceRequest.struct_class = Types::CreateServiceRequest CreateServiceResponse.add_member(:service, Shapes::ShapeRef.new(shape: Service, required: true, location_name: "Service")) CreateServiceResponse.add_member(:operation_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "OperationId")) CreateServiceResponse.struct_class = Types::CreateServiceResponse + CreateVpcConnectorRequest.add_member(:vpc_connector_name, Shapes::ShapeRef.new(shape: VpcConnectorName, required: true, location_name: "VpcConnectorName")) + CreateVpcConnectorRequest.add_member(:subnets, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "Subnets")) + CreateVpcConnectorRequest.add_member(:security_groups, Shapes::ShapeRef.new(shape: StringList, location_name: "SecurityGroups")) + CreateVpcConnectorRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags")) + CreateVpcConnectorRequest.struct_class = Types::CreateVpcConnectorRequest + + CreateVpcConnectorResponse.add_member(:vpc_connector, Shapes::ShapeRef.new(shape: VpcConnector, required: true, location_name: "VpcConnector")) + CreateVpcConnectorResponse.struct_class = Types::CreateVpcConnectorResponse + CustomDomain.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "DomainName")) CustomDomain.add_member(:enable_www_subdomain, Shapes::ShapeRef.new(shape: NullableBoolean, required: true, location_name: "EnableWWWSubdomain")) CustomDomain.add_member(:certificate_validation_records, Shapes::ShapeRef.new(shape: CertificateValidationRecordList, location_name: "CertificateValidationRecords")) @@ -274,6 +300,12 @@ module ClientApi DeleteServiceResponse.add_member(:operation_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "OperationId")) DeleteServiceResponse.struct_class = Types::DeleteServiceResponse + DeleteVpcConnectorRequest.add_member(:vpc_connector_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, required: true, location_name: "VpcConnectorArn")) + DeleteVpcConnectorRequest.struct_class = Types::DeleteVpcConnectorRequest + + DeleteVpcConnectorResponse.add_member(:vpc_connector, Shapes::ShapeRef.new(shape: VpcConnector, required: true, location_name: "VpcConnector")) + DeleteVpcConnectorResponse.struct_class = Types::DeleteVpcConnectorResponse + DescribeAutoScalingConfigurationRequest.add_member(:auto_scaling_configuration_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, required: true, location_name: "AutoScalingConfigurationArn")) DescribeAutoScalingConfigurationRequest.struct_class = Types::DescribeAutoScalingConfigurationRequest @@ -297,6 +329,12 @@ module ClientApi DescribeServiceResponse.add_member(:service, Shapes::ShapeRef.new(shape: Service, required: true, location_name: "Service")) DescribeServiceResponse.struct_class = Types::DescribeServiceResponse + DescribeVpcConnectorRequest.add_member(:vpc_connector_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, required: true, location_name: "VpcConnectorArn")) + DescribeVpcConnectorRequest.struct_class = Types::DescribeVpcConnectorRequest + + DescribeVpcConnectorResponse.add_member(:vpc_connector, Shapes::ShapeRef.new(shape: VpcConnector, required: true, location_name: "VpcConnector")) + DescribeVpcConnectorResponse.struct_class = Types::DescribeVpcConnectorResponse + DisassociateCustomDomainRequest.add_member(:service_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, required: true, location_name: "ServiceArn")) DisassociateCustomDomainRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "DomainName")) DisassociateCustomDomainRequest.struct_class = Types::DisassociateCustomDomainRequest @@ -306,6 +344,10 @@ module ClientApi DisassociateCustomDomainResponse.add_member(:custom_domain, Shapes::ShapeRef.new(shape: CustomDomain, required: true, location_name: "CustomDomain")) DisassociateCustomDomainResponse.struct_class = Types::DisassociateCustomDomainResponse + EgressConfiguration.add_member(:egress_type, Shapes::ShapeRef.new(shape: EgressType, location_name: "EgressType")) + EgressConfiguration.add_member(:vpc_connector_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, location_name: "VpcConnectorArn")) + EgressConfiguration.struct_class = Types::EgressConfiguration + EncryptionConfiguration.add_member(:kms_key, Shapes::ShapeRef.new(shape: KmsKeyArn, required: true, location_name: "KmsKey")) EncryptionConfiguration.struct_class = Types::EncryptionConfiguration @@ -318,7 +360,7 @@ module ClientApi HealthCheckConfiguration.struct_class = Types::HealthCheckConfiguration ImageConfiguration.add_member(:runtime_environment_variables, Shapes::ShapeRef.new(shape: RuntimeEnvironmentVariables, location_name: "RuntimeEnvironmentVariables")) - ImageConfiguration.add_member(:start_command, Shapes::ShapeRef.new(shape: String, location_name: "StartCommand")) + ImageConfiguration.add_member(:start_command, Shapes::ShapeRef.new(shape: StartCommand, location_name: "StartCommand")) ImageConfiguration.add_member(:port, Shapes::ShapeRef.new(shape: String, location_name: "Port")) ImageConfiguration.struct_class = Types::ImageConfiguration @@ -383,6 +425,17 @@ module ClientApi ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags")) ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse + ListVpcConnectorsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults")) + ListVpcConnectorsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken")) + ListVpcConnectorsRequest.struct_class = Types::ListVpcConnectorsRequest + + ListVpcConnectorsResponse.add_member(:vpc_connectors, Shapes::ShapeRef.new(shape: VpcConnectors, required: true, location_name: "VpcConnectors")) + ListVpcConnectorsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken")) + ListVpcConnectorsResponse.struct_class = Types::ListVpcConnectorsResponse + + NetworkConfiguration.add_member(:egress_configuration, Shapes::ShapeRef.new(shape: EgressConfiguration, location_name: "EgressConfiguration")) + NetworkConfiguration.struct_class = Types::NetworkConfiguration + OperationSummary.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "Id")) OperationSummary.add_member(:type, Shapes::ShapeRef.new(shape: OperationType, location_name: "Type")) OperationSummary.add_member(:status, Shapes::ShapeRef.new(shape: OperationStatus, location_name: "Status")) @@ -427,6 +480,7 @@ module ClientApi Service.add_member(:encryption_configuration, Shapes::ShapeRef.new(shape: EncryptionConfiguration, location_name: "EncryptionConfiguration")) Service.add_member(:health_check_configuration, Shapes::ShapeRef.new(shape: HealthCheckConfiguration, location_name: "HealthCheckConfiguration")) Service.add_member(:auto_scaling_configuration_summary, Shapes::ShapeRef.new(shape: AutoScalingConfigurationSummary, required: true, location_name: "AutoScalingConfigurationSummary")) + Service.add_member(:network_configuration, Shapes::ShapeRef.new(shape: NetworkConfiguration, required: true, location_name: "NetworkConfiguration")) Service.struct_class = Types::Service ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message")) @@ -459,6 +513,8 @@ module ClientApi StartDeploymentResponse.add_member(:operation_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "OperationId")) StartDeploymentResponse.struct_class = Types::StartDeploymentResponse + StringList.member = Shapes::ShapeRef.new(shape: String) + Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, location_name: "Key")) Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, location_name: "Value")) Tag.struct_class = Types::Tag @@ -484,12 +540,25 @@ module ClientApi UpdateServiceRequest.add_member(:instance_configuration, Shapes::ShapeRef.new(shape: InstanceConfiguration, location_name: "InstanceConfiguration")) UpdateServiceRequest.add_member(:auto_scaling_configuration_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, location_name: "AutoScalingConfigurationArn")) UpdateServiceRequest.add_member(:health_check_configuration, Shapes::ShapeRef.new(shape: HealthCheckConfiguration, location_name: "HealthCheckConfiguration")) + UpdateServiceRequest.add_member(:network_configuration, Shapes::ShapeRef.new(shape: NetworkConfiguration, location_name: "NetworkConfiguration")) UpdateServiceRequest.struct_class = Types::UpdateServiceRequest UpdateServiceResponse.add_member(:service, Shapes::ShapeRef.new(shape: Service, required: true, location_name: "Service")) UpdateServiceResponse.add_member(:operation_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "OperationId")) UpdateServiceResponse.struct_class = Types::UpdateServiceResponse + VpcConnector.add_member(:vpc_connector_name, Shapes::ShapeRef.new(shape: VpcConnectorName, location_name: "VpcConnectorName")) + VpcConnector.add_member(:vpc_connector_arn, Shapes::ShapeRef.new(shape: AppRunnerResourceArn, location_name: "VpcConnectorArn")) + VpcConnector.add_member(:vpc_connector_revision, Shapes::ShapeRef.new(shape: Integer, location_name: "VpcConnectorRevision")) + VpcConnector.add_member(:subnets, Shapes::ShapeRef.new(shape: StringList, location_name: "Subnets")) + VpcConnector.add_member(:security_groups, Shapes::ShapeRef.new(shape: StringList, location_name: "SecurityGroups")) + VpcConnector.add_member(:status, Shapes::ShapeRef.new(shape: VpcConnectorStatus, location_name: "Status")) + VpcConnector.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt")) + VpcConnector.add_member(:deleted_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "DeletedAt")) + VpcConnector.struct_class = Types::VpcConnector + + VpcConnectors.member = Shapes::ShapeRef.new(shape: VpcConnector) + # @api private API = Seahorse::Model::Api.new.tap do |api| @@ -553,6 +622,17 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) end) + api.add_operation(:create_vpc_connector, Seahorse::Model::Operation.new.tap do |o| + o.name = "CreateVpcConnector" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: CreateVpcConnectorRequest) + o.output = Shapes::ShapeRef.new(shape: CreateVpcConnectorResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException) + o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) + end) + api.add_operation(:delete_auto_scaling_configuration, Seahorse::Model::Operation.new.tap do |o| o.name = "DeleteAutoScalingConfiguration" o.http_method = "POST" @@ -587,6 +667,17 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException) end) + api.add_operation(:delete_vpc_connector, Seahorse::Model::Operation.new.tap do |o| + o.name = "DeleteVpcConnector" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: DeleteVpcConnectorRequest) + o.output = Shapes::ShapeRef.new(shape: DeleteVpcConnectorResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + end) + api.add_operation(:describe_auto_scaling_configuration, Seahorse::Model::Operation.new.tap do |o| o.name = "DescribeAutoScalingConfiguration" o.http_method = "POST" @@ -626,6 +717,17 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException) end) + api.add_operation(:describe_vpc_connector, Seahorse::Model::Operation.new.tap do |o| + o.name = "DescribeVpcConnector" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: DescribeVpcConnectorRequest) + o.output = Shapes::ShapeRef.new(shape: DescribeVpcConnectorResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + end) + api.add_operation(:disassociate_custom_domain, Seahorse::Model::Operation.new.tap do |o| o.name = "DisassociateCustomDomain" o.http_method = "POST" @@ -715,6 +817,22 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InvalidStateException) end) + api.add_operation(:list_vpc_connectors, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListVpcConnectors" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: ListVpcConnectorsRequest) + o.output = Shapes::ShapeRef.new(shape: ListVpcConnectorsResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: InternalServiceErrorException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:pause_service, Seahorse::Model::Operation.new.tap do |o| o.name = "PauseService" o.http_method = "POST" diff --git a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb index 4fff1b9af0a..67468432bd2 100644 --- a/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb +++ b/gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb @@ -106,9 +106,6 @@ class AuthenticationConfiguration < Struct.new( end # Describes an App Runner automatic scaling configuration resource. - # Multiple revisions of a configuration have the same - # `AutoScalingConfigurationName` and different - # `AutoScalingConfigurationRevision` values. # # A higher `MinSize` increases the spread of your App Runner service # over more Availability Zones in the Amazon Web Services Region. The @@ -117,6 +114,10 @@ class AuthenticationConfiguration < Struct.new( # A lower `MaxSize` controls your cost. The tradeoff is lower # responsiveness during peak demand. # + # Multiple revisions of a configuration might have the same + # `AutoScalingConfigurationName` and different + # `AutoScalingConfigurationRevision` values. + # # @!attribute [rw] auto_scaling_configuration_arn # The Amazon Resource Name (ARN) of this auto scaling configuration. # @return [String] @@ -516,6 +517,17 @@ class ConnectionSummary < Struct.new( # revision number `1` of this name. When you use the same name in # subsequent calls, App Runner creates incremental revisions of the # configuration. + # + # The name `DefaultConfiguration` is reserved (it's the configuration + # that App Runner uses if you don't provide a custome one). You + # can't use it to create a new auto scaling configuration, and you + # can't create a revision of it. + # + # When you want to use your own auto scaling configuration for your + # App Runner service, *create a configuration with a different name*, + # and then provide it when you create or update your service. + # + # # @return [String] # # @!attribute [rw] max_concurrency @@ -662,7 +674,7 @@ class CreateConnectionResponse < Struct.new( # runtime_environment_variables: { # "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue", # }, - # start_command: "String", + # start_command: "StartCommand", # port: "String", # }, # image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC @@ -696,12 +708,18 @@ class CreateConnectionResponse < Struct.new( # unhealthy_threshold: 1, # }, # auto_scaling_configuration_arn: "AppRunnerResourceArn", + # network_configuration: { + # egress_configuration: { + # egress_type: "DEFAULT", # accepts DEFAULT, VPC + # vpc_connector_arn: "AppRunnerResourceArn", + # }, + # }, # } # # @!attribute [rw] service_name - # A name for the new service. It must be unique across all the running - # App Runner services in your Amazon Web Services account in the - # Amazon Web Services Region. + # A name for the App Runner service. It must be unique across all the + # running App Runner services in your Amazon Web Services account in + # the Amazon Web Services Region. # @return [String] # # @!attribute [rw] source_configuration @@ -715,29 +733,34 @@ class CreateConnectionResponse < Struct.new( # @return [Types::InstanceConfiguration] # # @!attribute [rw] tags - # An optional list of metadata items that you can associate with your - # service resource. A tag is a key-value pair. + # An optional list of metadata items that you can associate with the + # App Runner service resource. A tag is a key-value pair. # @return [Array] # # @!attribute [rw] encryption_configuration # An optional custom encryption key that App Runner uses to encrypt # the copy of your source repository that it maintains and your # service logs. By default, App Runner uses an Amazon Web Services - # managed CMK. + # managed key. # @return [Types::EncryptionConfiguration] # # @!attribute [rw] health_check_configuration # The settings for the health check that App Runner performs to - # monitor the health of your service. + # monitor the health of the App Runner service. # @return [Types::HealthCheckConfiguration] # # @!attribute [rw] auto_scaling_configuration_arn # The Amazon Resource Name (ARN) of an App Runner automatic scaling - # configuration resource that you want to associate with your service. - # If not provided, App Runner associates the latest revision of a - # default auto scaling configuration. + # configuration resource that you want to associate with the App + # Runner service. If not provided, App Runner associates the latest + # revision of a default auto scaling configuration. # @return [String] # + # @!attribute [rw] network_configuration + # Configuration settings related to network traffic of the web + # application that the App Runner service runs. + # @return [Types::NetworkConfiguration] + # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateServiceRequest AWS API Documentation # class CreateServiceRequest < Struct.new( @@ -747,7 +770,8 @@ class CreateServiceRequest < Struct.new( :tags, :encryption_configuration, :health_check_configuration, - :auto_scaling_configuration_arn) + :auto_scaling_configuration_arn, + :network_configuration) SENSITIVE = [] include Aws::Structure end @@ -776,6 +800,68 @@ class CreateServiceResponse < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass CreateVpcConnectorRequest + # data as a hash: + # + # { + # vpc_connector_name: "VpcConnectorName", # required + # subnets: ["String"], # required + # security_groups: ["String"], + # tags: [ + # { + # key: "TagKey", + # value: "TagValue", + # }, + # ], + # } + # + # @!attribute [rw] vpc_connector_name + # A name for the VPC connector. + # @return [String] + # + # @!attribute [rw] subnets + # A list of IDs of subnets that App Runner should use when it + # associates your service with a custom Amazon VPC. Specify IDs of + # subnets of a single Amazon VPC. App Runner determines the Amazon VPC + # from the subnets you specify. + # @return [Array] + # + # @!attribute [rw] security_groups + # A list of IDs of security groups that App Runner should use for + # access to Amazon Web Services resources under the specified subnets. + # If not specified, App Runner uses the default security group of the + # Amazon VPC. The default security group allows all outbound traffic. + # @return [Array] + # + # @!attribute [rw] tags + # A list of metadata items that you can associate with your VPC + # connector resource. A tag is a key-value pair. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateVpcConnectorRequest AWS API Documentation + # + class CreateVpcConnectorRequest < Struct.new( + :vpc_connector_name, + :subnets, + :security_groups, + :tags) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] vpc_connector + # A description of the App Runner VPC connector that's created by + # this request. + # @return [Types::VpcConnector] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/CreateVpcConnectorResponse AWS API Documentation + # + class CreateVpcConnectorResponse < Struct.new( + :vpc_connector) + SENSITIVE = [] + include Aws::Structure + end + # Describes a custom domain that's associated with an App Runner # service. # @@ -921,6 +1007,41 @@ class DeleteServiceResponse < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass DeleteVpcConnectorRequest + # data as a hash: + # + # { + # vpc_connector_arn: "AppRunnerResourceArn", # required + # } + # + # @!attribute [rw] vpc_connector_arn + # The Amazon Resource Name (ARN) of the App Runner VPC connector that + # you want to delete. + # + # The ARN must be a full VPC connector ARN. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteVpcConnectorRequest AWS API Documentation + # + class DeleteVpcConnectorRequest < Struct.new( + :vpc_connector_arn) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] vpc_connector + # A description of the App Runner VPC connector that this request just + # deleted. + # @return [Types::VpcConnector] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DeleteVpcConnectorResponse AWS API Documentation + # + class DeleteVpcConnectorResponse < Struct.new( + :vpc_connector) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass DescribeAutoScalingConfigurationRequest # data as a hash: # @@ -1065,6 +1186,41 @@ class DescribeServiceResponse < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass DescribeVpcConnectorRequest + # data as a hash: + # + # { + # vpc_connector_arn: "AppRunnerResourceArn", # required + # } + # + # @!attribute [rw] vpc_connector_arn + # The Amazon Resource Name (ARN) of the App Runner VPC connector that + # you want a description for. + # + # The ARN must be a full VPC connector ARN. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeVpcConnectorRequest AWS API Documentation + # + class DescribeVpcConnectorRequest < Struct.new( + :vpc_connector_arn) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] vpc_connector + # A description of the App Runner VPC connector that you specified in + # this request. + # @return [Types::VpcConnector] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/DescribeVpcConnectorResponse AWS API Documentation + # + class DescribeVpcConnectorResponse < Struct.new( + :vpc_connector) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass DisassociateCustomDomainRequest # data as a hash: # @@ -1116,6 +1272,41 @@ class DisassociateCustomDomainResponse < Struct.new( include Aws::Structure end + # Describes configuration settings related to outbound network traffic + # of an App Runner service. + # + # @note When making an API call, you may pass EgressConfiguration + # data as a hash: + # + # { + # egress_type: "DEFAULT", # accepts DEFAULT, VPC + # vpc_connector_arn: "AppRunnerResourceArn", + # } + # + # @!attribute [rw] egress_type + # The type of egress configuration. + # + # Set to `DEFAULT` for access to resources hosted on public networks. + # + # Set to `VPC` to associate your service to a custom VPC specified by + # `VpcConnectorArn`. + # @return [String] + # + # @!attribute [rw] vpc_connector_arn + # The Amazon Resource Name (ARN) of the App Runner VPC connector that + # you want to associate with your App Runner service. Only valid when + # `EgressType = VPC`. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/EgressConfiguration AWS API Documentation + # + class EgressConfiguration < Struct.new( + :egress_type, + :vpc_connector_arn) + SENSITIVE = [] + include Aws::Structure + end + # Describes a custom encryption key that App Runner uses to encrypt # copies of the source repository and service logs. # @@ -1221,7 +1412,7 @@ class HealthCheckConfiguration < Struct.new( # runtime_environment_variables: { # "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue", # }, - # start_command: "String", + # start_command: "StartCommand", # port: "String", # } # @@ -1249,7 +1440,7 @@ class ImageConfiguration < Struct.new( :runtime_environment_variables, :start_command, :port) - SENSITIVE = [] + SENSITIVE = [:start_command] include Aws::Structure end @@ -1264,7 +1455,7 @@ class ImageConfiguration < Struct.new( # runtime_environment_variables: { # "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue", # }, - # start_command: "String", + # start_command: "StartCommand", # port: "String", # }, # image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC @@ -1674,6 +1865,87 @@ class ListTagsForResourceResponse < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass ListVpcConnectorsRequest + # data as a hash: + # + # { + # max_results: 1, + # next_token: "NextToken", + # } + # + # @!attribute [rw] max_results + # The maximum number of results to include in each response (result + # page). It's used for a paginated request. + # + # If you don't specify `MaxResults`, the request retrieves all + # available results in a single response. + # @return [Integer] + # + # @!attribute [rw] next_token + # A token from a previous result page. It's used for a paginated + # request. The request retrieves the next result page. All other + # parameter values must be identical to the ones that are specified in + # the initial request. + # + # If you don't specify `NextToken`, the request retrieves the first + # result page. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListVpcConnectorsRequest AWS API Documentation + # + class ListVpcConnectorsRequest < Struct.new( + :max_results, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] vpc_connectors + # A list of information records for VPC connectors. In a paginated + # request, the request returns up to `MaxResults` records for each + # call. + # @return [Array] + # + # @!attribute [rw] next_token + # The token that you can pass in a subsequent request to get the next + # result page. It's returned in a paginated request. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/ListVpcConnectorsResponse AWS API Documentation + # + class ListVpcConnectorsResponse < Struct.new( + :vpc_connectors, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # Describes configuration settings related to network traffic of an App + # Runner service. Consists of embedded objects for each configurable + # network feature. + # + # @note When making an API call, you may pass NetworkConfiguration + # data as a hash: + # + # { + # egress_configuration: { + # egress_type: "DEFAULT", # accepts DEFAULT, VPC + # vpc_connector_arn: "AppRunnerResourceArn", + # }, + # } + # + # @!attribute [rw] egress_configuration + # Network configuration settings for outbound message traffic. + # @return [Types::EgressConfiguration] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/NetworkConfiguration AWS API Documentation + # + class NetworkConfiguration < Struct.new( + :egress_configuration) + SENSITIVE = [] + include Aws::Structure + end + # Provides summary information for an operation that occurred on an App # Runner service. # @@ -1900,7 +2172,7 @@ class ResumeServiceResponse < Struct.new( # The encryption key that App Runner uses to encrypt the service logs # and the copy of the source repository that App Runner maintains for # the service. It can be either a customer-provided encryption key or - # an Amazon Web Services managed CMK. + # an Amazon Web Services managed key. # @return [Types::EncryptionConfiguration] # # @!attribute [rw] health_check_configuration @@ -1913,6 +2185,11 @@ class ResumeServiceResponse < Struct.new( # configuration resource that's associated with this service. # @return [Types::AutoScalingConfigurationSummary] # + # @!attribute [rw] network_configuration + # Configuration settings related to network traffic of the web + # application that this service runs. + # @return [Types::NetworkConfiguration] + # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/Service AWS API Documentation # class Service < Struct.new( @@ -1928,7 +2205,8 @@ class Service < Struct.new( :instance_configuration, :encryption_configuration, :health_check_configuration, - :auto_scaling_configuration_summary) + :auto_scaling_configuration_summary, + :network_configuration) SENSITIVE = [] include Aws::Structure end @@ -2094,7 +2372,7 @@ class SourceCodeVersion < Struct.new( # runtime_environment_variables: { # "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue", # }, - # start_command: "String", + # start_command: "StartCommand", # port: "String", # }, # image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC @@ -2315,7 +2593,7 @@ class UntagResourceResponse < Aws::EmptyStructure; end # runtime_environment_variables: { # "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue", # }, - # start_command: "String", + # start_command: "StartCommand", # port: "String", # }, # image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC @@ -2340,6 +2618,12 @@ class UntagResourceResponse < Aws::EmptyStructure; end # healthy_threshold: 1, # unhealthy_threshold: 1, # }, + # network_configuration: { + # egress_configuration: { + # egress_type: "DEFAULT", # accepts DEFAULT, VPC + # vpc_connector_arn: "AppRunnerResourceArn", + # }, + # }, # } # # @!attribute [rw] service_arn @@ -2367,14 +2651,20 @@ class UntagResourceResponse < Aws::EmptyStructure; end # # @!attribute [rw] auto_scaling_configuration_arn # The Amazon Resource Name (ARN) of an App Runner automatic scaling - # configuration resource that you want to associate with your service. + # configuration resource that you want to associate with the App + # Runner service. # @return [String] # # @!attribute [rw] health_check_configuration # The settings for the health check that App Runner performs to - # monitor the health of your service. + # monitor the health of the App Runner service. # @return [Types::HealthCheckConfiguration] # + # @!attribute [rw] network_configuration + # Configuration settings related to network traffic of the web + # application that the App Runner service runs. + # @return [Types::NetworkConfiguration] + # # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/UpdateServiceRequest AWS API Documentation # class UpdateServiceRequest < Struct.new( @@ -2382,7 +2672,8 @@ class UpdateServiceRequest < Struct.new( :source_configuration, :instance_configuration, :auto_scaling_configuration_arn, - :health_check_configuration) + :health_check_configuration, + :network_configuration) SENSITIVE = [] include Aws::Structure end @@ -2408,5 +2699,78 @@ class UpdateServiceResponse < Struct.new( include Aws::Structure end + # Describes an App Runner VPC connector resource. A VPC connector + # describes the Amazon Virtual Private Cloud (Amazon VPC) that an App + # Runner service is associated with, and the subnets and security group + # that are used. + # + # Multiple revisions of a connector might have the same `Name` and + # different `Revision` values. + # + # At this time, App Runner supports only one revision per name. + # + # + # + # @!attribute [rw] vpc_connector_name + # The customer-provided VPC connector name. + # @return [String] + # + # @!attribute [rw] vpc_connector_arn + # The Amazon Resource Name (ARN) of this VPC connector. + # @return [String] + # + # @!attribute [rw] vpc_connector_revision + # The revision of this VPC connector. It's unique among all the + # active connectors (`"Status": "ACTIVE"`) that share the same `Name`. + # + # At this time, App Runner supports only one revision per name. + # + # + # @return [Integer] + # + # @!attribute [rw] subnets + # A list of IDs of subnets that App Runner uses for your service. All + # IDs are of subnets of a single Amazon VPC. + # @return [Array] + # + # @!attribute [rw] security_groups + # A list of IDs of security groups that App Runner uses for access to + # Amazon Web Services resources under the specified subnets. If not + # specified, App Runner uses the default security group of the Amazon + # VPC. The default security group allows all outbound traffic. + # @return [Array] + # + # @!attribute [rw] status + # The current state of the VPC connector. If the status of a connector + # revision is `INACTIVE`, it was deleted and can't be used. Inactive + # connector revisions are permanently removed some time after they are + # deleted. + # @return [String] + # + # @!attribute [rw] created_at + # The time when the VPC connector was created. It's in Unix time + # stamp format. + # @return [Time] + # + # @!attribute [rw] deleted_at + # The time when the VPC connector was deleted. It's in Unix time + # stamp format. + # @return [Time] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/VpcConnector AWS API Documentation + # + class VpcConnector < Struct.new( + :vpc_connector_name, + :vpc_connector_arn, + :vpc_connector_revision, + :subnets, + :security_groups, + :status, + :created_at, + :deleted_at) + SENSITIVE = [] + include Aws::Structure + end + end end diff --git a/gems/aws-sdk-kendra/CHANGELOG.md b/gems/aws-sdk-kendra/CHANGELOG.md index 9ca18230e44..f298337a284 100644 --- a/gems/aws-sdk-kendra/CHANGELOG.md +++ b/gems/aws-sdk-kendra/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.44.0 (2022-02-08) +------------------ + +* Feature - Amazon Kendra now provides a data source connector for Amazon FSx. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-fsx.html + 1.43.0 (2022-02-03) ------------------ diff --git a/gems/aws-sdk-kendra/VERSION b/gems/aws-sdk-kendra/VERSION index b978278f05f..372cf402c73 100644 --- a/gems/aws-sdk-kendra/VERSION +++ b/gems/aws-sdk-kendra/VERSION @@ -1 +1 @@ -1.43.0 +1.44.0 diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb index 53aecfa85df..9c4c2c93848 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra.rb @@ -48,6 +48,6 @@ # @!group service module Aws::Kendra - GEM_VERSION = '1.43.0' + GEM_VERSION = '1.44.0' end diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb index f9a977e30a7..3e3efd67283 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb @@ -471,7 +471,7 @@ def associate_personas_to_entities(params = {}, options = {}) end # Removes one or more documents from an index. The documents must have - # been added with the `BatchPutDocument` operation. + # been added with the `BatchPutDocument` API. # # The documents are deleted asynchronously. You can see the progress of # the deletion by using Amazon Web Services CloudWatch. Any error @@ -519,17 +519,16 @@ def batch_delete_document(params = {}, options = {}) end # Returns the indexing status for one or more documents submitted with - # the [ BatchPutDocument][1] operation. + # the [ BatchPutDocument][1] API. # - # When you use the `BatchPutDocument` operation, documents are indexed - # asynchronously. You can use the `BatchGetDocumentStatus` operation to - # get the current status of a list of documents so that you can - # determine if they have been successfully indexed. + # When you use the `BatchPutDocument` API, documents are indexed + # asynchronously. You can use the `BatchGetDocumentStatus` API to get + # the current status of a list of documents so that you can determine if + # they have been successfully indexed. # - # You can also use the `BatchGetDocumentStatus` operation to check the - # status of the [ BatchDeleteDocument][2] operation. When a document is - # deleted from the index, Amazon Kendra returns `NOT_FOUND` as the - # status. + # You can also use the `BatchGetDocumentStatus` API to check the status + # of the [ BatchDeleteDocument][2] API. When a document is deleted from + # the index, Amazon Kendra returns `NOT_FOUND` as the status. # # # @@ -538,7 +537,7 @@ def batch_delete_document(params = {}, options = {}) # # @option params [required, String] :index_id # The identifier of the index to add documents to. The index ID is - # returned by the [ CreateIndex ][1] operation. + # returned by the [CreateIndex ][1] API. # # # @@ -599,11 +598,11 @@ def batch_get_document_status(params = {}, options = {}) # Adds one or more documents to an index. # - # The `BatchPutDocument` operation enables you to ingest inline - # documents or a set of documents stored in an Amazon S3 bucket. Use - # this operation to ingest your text and unstructured text into an - # index, add custom attributes to the documents, and to attach an access - # control list to the documents added to the index. + # The `BatchPutDocument` API enables you to ingest inline documents or a + # set of documents stored in an Amazon S3 bucket. Use this API to ingest + # your text and unstructured text into an index, add custom attributes + # to the documents, and to attach an access control list to the + # documents added to the index. # # The documents are indexed asynchronously. You can see the progress of # the batch using Amazon Web Services CloudWatch. Any error messages @@ -612,11 +611,11 @@ def batch_get_document_status(params = {}, options = {}) # # @option params [required, String] :index_id # The identifier of the index to add the documents to. You need to - # create the index first using the `CreateIndex` operation. + # create the index first using the `CreateIndex` API. # # @option params [String] :role_arn # The Amazon Resource Name (ARN) of a role that is allowed to run the - # `BatchPutDocument` operation. For more information, see [IAM Roles for + # `BatchPutDocument` API. For more information, see [IAM Roles for # Amazon Kendra][1]. # # @@ -626,12 +625,6 @@ def batch_get_document_status(params = {}, options = {}) # @option params [required, Array] :documents # One or more documents to add to the index. # - # Documents can include custom attributes. For example, 'DataSourceId' - # and 'DataSourceSyncJobId' are custom attributes that provide - # information on the synchronization of documents running on a data - # source. Note, 'DataSourceSyncJobId' could be an optional custom - # attribute as Amazon Kendra will use the ID of a running sync job. - # # Documents have the following file size limits. # # * 5 MB total size for inline documents @@ -650,7 +643,7 @@ def batch_get_document_status(params = {}, options = {}) # @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration # Configuration information for altering your document metadata and # content during the document ingestion process when you use the - # `BatchPutDocument` operation. + # `BatchPutDocument` API. # # For more information on how to create, modify and delete document # metadata, or make other content alterations when you ingest documents @@ -861,10 +854,10 @@ def clear_query_suggestions(params = {}, options = {}) # A description for the data source. # # @option params [String] :schedule - # Sets the frequency that Amazon Kendra will check the documents in your + # Sets the frequency for Amazon Kendra to check the documents in your # repository and update the index. If you don't set a schedule Amazon # Kendra will not periodically update the index. You can call the - # `StartDataSourceSyncJob` operation to update the index. + # `StartDataSourceSyncJob` API to update the index. # # You can't specify the `Schedule` parameter when the `Type` parameter # is set to `CUSTOM`. If you do, you receive a `ValidationException` @@ -892,8 +885,8 @@ def clear_query_suggestions(params = {}, options = {}) # # @option params [String] :client_token # A token that you provide to identify the request to create a data - # source. Multiple calls to the `CreateDataSource` operation with the - # same client token will create only one data source. + # source. Multiple calls to the `CreateDataSource` API with the same + # client token will create only one data source. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** @@ -930,7 +923,7 @@ def clear_query_suggestions(params = {}, options = {}) # resp = client.create_data_source({ # name: "DataSourceName", # required # index_id: "IndexId", # required - # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS + # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX # configuration: { # s3_configuration: { # bucket_name: "S3BucketName", # required @@ -1242,6 +1235,24 @@ def clear_query_suggestions(params = {}, options = {}) # }, # ], # }, + # fsx_configuration: { + # file_system_id: "FileSystemId", # required + # file_system_type: "WINDOWS", # required, accepts WINDOWS + # vpc_configuration: { # required + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # secret_arn: "SecretArn", + # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", @@ -1341,10 +1352,9 @@ def create_data_source(params = {}, options = {}) # # @option params [String] :role_arn # The Amazon Resource Name (ARN) of a role with permission to access - # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback` - # operations, and Amazon Web Services SSO that stores your user and - # group information. For more information, see [IAM roles for Amazon - # Kendra][1]. + # `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon + # Web Services SSO that stores your user and group information. For more + # information, see [IAM roles for Amazon Kendra][1]. # # # @@ -1362,8 +1372,8 @@ def create_data_source(params = {}, options = {}) # # @option params [String] :client_token # A token that you provide to identify the request to create your Amazon - # Kendra experience. Multiple calls to the `CreateExperience` operation - # with the same client token creates only one Amazon Kendra experience. + # Kendra experience. Multiple calls to the `CreateExperience` API with + # the same client token creates only one Amazon Kendra experience. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** @@ -1452,8 +1462,8 @@ def create_experience(params = {}, options = {}) # # @option params [String] :client_token # A token that you provide to identify the request to create a FAQ. - # Multiple calls to the `CreateFaqRequest` operation with the same - # client token will create only one FAQ. + # Multiple calls to the `CreateFaqRequest` API with the same client + # token will create only one FAQ. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** @@ -1508,13 +1518,12 @@ def create_faq(params = {}, options = {}) end # Creates a new Amazon Kendra index. Index creation is an asynchronous - # operation. To determine if index creation has completed, check the - # `Status` field returned from a call to `DescribeIndex`. The `Status` - # field is set to `ACTIVE` when the index is ready to use. + # API. To determine if index creation has completed, check the `Status` + # field returned from a call to `DescribeIndex`. The `Status` field is + # set to `ACTIVE` when the index is ready to use. # # Once the index is active you can index your documents using the - # `BatchPutDocument` operation or using one of the supported data - # sources. + # `BatchPutDocument` API or using one of the supported data sources. # # @option params [required, String] :name # The name for the new index. @@ -1539,8 +1548,8 @@ def create_faq(params = {}, options = {}) # @option params [required, String] :role_arn # An Identity and Access Management(IAM) role that gives Amazon Kendra # permissions to access your Amazon CloudWatch logs and metrics. This is - # also the role used when you use the `BatchPutDocument` operation to - # index documents from an Amazon S3 bucket. + # also the role used when you use the `BatchPutDocument` API to index + # documents from an Amazon S3 bucket. # # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration # The identifier of the KMScustomer managed key (CMK) to use to encrypt @@ -1552,8 +1561,8 @@ def create_faq(params = {}, options = {}) # # @option params [String] :client_token # A token that you provide to identify the request to create an index. - # Multiple calls to the `CreateIndex` operation with the same client - # token will create only one index. + # Multiple calls to the `CreateIndex` API with the same client token + # will create only one index. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** @@ -1707,9 +1716,10 @@ def create_index(params = {}, options = {}) # The IAM (Identity and Access Management) role used by Amazon Kendra to # access the block list text file in your S3 bucket. # - # You need permissions to the role ARN (Amazon Resource Name). The role - # needs S3 read permissions to your file in S3 and needs to give STS - # (Security Token Service) assume role permissions to Amazon Kendra. + # You need permissions to the role ARN (Amazon Web Services Resource + # Name). The role needs S3 read permissions to your file in S3 and needs + # to give STS (Security Token Service) assume role permissions to Amazon + # Kendra. # # @option params [Array] :tags # A tag that you can assign to a block list that categorizes the block @@ -1778,8 +1788,8 @@ def create_query_suggestions_block_list(params = {}, options = {}) # # @option params [String] :client_token # A token that you provide to identify the request to create a - # thesaurus. Multiple calls to the `CreateThesaurus` operation with the - # same client token will create only one thesaurus. + # thesaurus. Multiple calls to the `CreateThesaurus` API with the same + # client token will create only one thesaurus. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** @@ -1824,8 +1834,8 @@ def create_thesaurus(params = {}, options = {}) # Deletes an Amazon Kendra data source. An exception is not thrown if # the data source is already being deleted. While the data source is # being deleted, the `Status` field returned by a call to the - # `DescribeDataSource` operation is set to `DELETING`. For more - # information, see [Deleting Data Sources][1]. + # `DescribeDataSource` API is set to `DELETING`. For more information, + # see [Deleting Data Sources][1]. # # # @@ -1916,8 +1926,8 @@ def delete_faq(params = {}, options = {}) # Deletes an existing Amazon Kendra index. An exception is not thrown if # the index is already being deleted. While the index is being deleted, - # the `Status` field returned by a call to the `DescribeIndex` operation - # is set to `DELETING`. + # the `Status` field returned by a call to the `DescribeIndex` API is + # set to `DELETING`. # # @option params [required, String] :id # The identifier of the index to delete. @@ -2073,7 +2083,7 @@ def delete_thesaurus(params = {}, options = {}) req.send_request(options) end - # Gets information about a Amazon Kendra data source. + # Gets information about an Amazon Kendra data source. # # @option params [required, String] :id # The unique identifier of the data source to describe. @@ -2110,7 +2120,7 @@ def delete_thesaurus(params = {}, options = {}) # resp.id #=> String # resp.index_id #=> String # resp.name #=> String - # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS" + # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX" # resp.configuration.s3_configuration.bucket_name #=> String # resp.configuration.s3_configuration.inclusion_prefixes #=> Array # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String @@ -2329,6 +2339,21 @@ def delete_thesaurus(params = {}, options = {}) # resp.configuration.work_docs_configuration.field_mappings[0].data_source_field_name #=> String # resp.configuration.work_docs_configuration.field_mappings[0].date_field_format #=> String # resp.configuration.work_docs_configuration.field_mappings[0].index_field_name #=> String + # resp.configuration.fsx_configuration.file_system_id #=> String + # resp.configuration.fsx_configuration.file_system_type #=> String, one of "WINDOWS" + # resp.configuration.fsx_configuration.vpc_configuration.subnet_ids #=> Array + # resp.configuration.fsx_configuration.vpc_configuration.subnet_ids[0] #=> String + # resp.configuration.fsx_configuration.vpc_configuration.security_group_ids #=> Array + # resp.configuration.fsx_configuration.vpc_configuration.security_group_ids[0] #=> String + # resp.configuration.fsx_configuration.secret_arn #=> String + # resp.configuration.fsx_configuration.inclusion_patterns #=> Array + # resp.configuration.fsx_configuration.inclusion_patterns[0] #=> String + # resp.configuration.fsx_configuration.exclusion_patterns #=> Array + # resp.configuration.fsx_configuration.exclusion_patterns[0] #=> String + # resp.configuration.fsx_configuration.field_mappings #=> Array + # resp.configuration.fsx_configuration.field_mappings[0].data_source_field_name #=> String + # resp.configuration.fsx_configuration.field_mappings[0].date_field_format #=> String + # resp.configuration.fsx_configuration.field_mappings[0].index_field_name #=> String # resp.created_at #=> Time # resp.updated_at #=> Time # resp.description #=> String @@ -3163,7 +3188,7 @@ def list_data_source_sync_jobs(params = {}, options = {}) # resp.summary_items #=> Array # resp.summary_items[0].name #=> String # resp.summary_items[0].id #=> String - # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS" + # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX" # resp.summary_items[0].created_at #=> Time # resp.summary_items[0].updated_at #=> Time # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE" @@ -3767,8 +3792,8 @@ def put_principal_mapping(params = {}, options = {}) end # Searches an active index. Use this API to search your documents using - # query. The `Query` operation enables to do faceted search and to - # filter results based on document attributes. + # query. The `Query` API enables to do faceted search and to filter + # results based on document attributes. # # It also enables you to provide user context that Amazon Kendra uses to # enforce document access control in the search results. @@ -3790,7 +3815,7 @@ def put_principal_mapping(params = {}, options = {}) # # @option params [required, String] :index_id # The unique identifier of the index to search. The identifier is - # returned in the response from the `CreateIndex` operation. + # returned in the response from the `CreateIndex` API. # # @option params [String] :query_text # The text to search for. @@ -4093,8 +4118,8 @@ def start_data_source_sync_job(params = {}, options = {}) req.send_request(options) end - # Stops a running synchronization job. You can't stop a scheduled - # synchronization job. + # Stops a synchronization job that is currently running. You can't stop + # a scheduled synchronization job. # # @option params [required, String] :id # The identifier of the data source for which to stop the @@ -4132,8 +4157,7 @@ def stop_data_source_sync_job(params = {}, options = {}) # # @option params [required, String] :query_id # The identifier of the specific query for which you are submitting - # feedback. The query ID is returned in the response to the `Query` - # operation. + # feedback. The query ID is returned in the response to the `Query` API. # # @option params [Array] :click_feedback_items # Tells Amazon Kendra that a particular search result link was chosen by @@ -4604,6 +4628,24 @@ def untag_resource(params = {}, options = {}) # }, # ], # }, + # fsx_configuration: { + # file_system_id: "FileSystemId", # required + # file_system_type: "WINDOWS", # required, accepts WINDOWS + # vpc_configuration: { # required + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # secret_arn: "SecretArn", + # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", @@ -4696,10 +4738,9 @@ def update_data_source(params = {}, options = {}) # # @option params [String] :role_arn # The Amazon Resource Name (ARN) of a role with permission to access - # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback` - # operations, and Amazon Web Services SSO that stores your user and - # group information. For more information, see [IAM roles for Amazon - # Kendra][1]. + # `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon + # Web Services SSO that stores your user and group information. For more + # information, see [IAM roles for Amazon Kendra][1]. # # # @@ -5076,7 +5117,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-kendra' - context[:gem_version] = '1.43.0' + context[:gem_version] = '1.44.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb index 3d1693e0562..a31c8262cc9 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/client_api.rb @@ -220,6 +220,9 @@ module ClientApi FaqSummary = Shapes::StructureShape.new(name: 'FaqSummary') FaqSummaryItems = Shapes::ListShape.new(name: 'FaqSummaryItems') FeedbackToken = Shapes::StringShape.new(name: 'FeedbackToken') + FileSystemId = Shapes::StringShape.new(name: 'FileSystemId') + FsxConfiguration = Shapes::StructureShape.new(name: 'FsxConfiguration') + FsxFileSystemType = Shapes::StringShape.new(name: 'FsxFileSystemType') GetQuerySuggestionsRequest = Shapes::StructureShape.new(name: 'GetQuerySuggestionsRequest') GetQuerySuggestionsResponse = Shapes::StructureShape.new(name: 'GetQuerySuggestionsResponse') GetSnapshotsRequest = Shapes::StructureShape.new(name: 'GetSnapshotsRequest') @@ -780,6 +783,7 @@ module ClientApi DataSourceConfiguration.add_member(:google_drive_configuration, Shapes::ShapeRef.new(shape: GoogleDriveConfiguration, location_name: "GoogleDriveConfiguration")) DataSourceConfiguration.add_member(:web_crawler_configuration, Shapes::ShapeRef.new(shape: WebCrawlerConfiguration, location_name: "WebCrawlerConfiguration")) DataSourceConfiguration.add_member(:work_docs_configuration, Shapes::ShapeRef.new(shape: WorkDocsConfiguration, location_name: "WorkDocsConfiguration")) + DataSourceConfiguration.add_member(:fsx_configuration, Shapes::ShapeRef.new(shape: FsxConfiguration, location_name: "FsxConfiguration")) DataSourceConfiguration.struct_class = Types::DataSourceConfiguration DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId")) @@ -1188,6 +1192,15 @@ module ClientApi FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary) + FsxConfiguration.add_member(:file_system_id, Shapes::ShapeRef.new(shape: FileSystemId, required: true, location_name: "FileSystemId")) + FsxConfiguration.add_member(:file_system_type, Shapes::ShapeRef.new(shape: FsxFileSystemType, required: true, location_name: "FileSystemType")) + FsxConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, required: true, location_name: "VpcConfiguration")) + FsxConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn")) + FsxConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns")) + FsxConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns")) + FsxConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings")) + FsxConfiguration.struct_class = Types::FsxConfiguration + GetQuerySuggestionsRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId")) GetQuerySuggestionsRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: SuggestionQueryText, required: true, location_name: "QueryText")) GetQuerySuggestionsRequest.add_member(:max_suggestions_count, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxSuggestionsCount")) diff --git a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb index f8d6ded580c..b106ed40331 100644 --- a/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb +++ b/gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb @@ -62,7 +62,7 @@ class AccessDeniedException < Struct.new( # A list of groups, separated by semi-colons, that filters a query # response based on user context. The document is only returned to # users that are in one of the groups specified in the `UserContext` - # field of the `Query` operation. + # field of the `Query` API. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation @@ -736,7 +736,7 @@ class BatchDeleteDocumentResponse < Struct.new( end # Provides information about documents that could not be removed from an - # index by the `BatchDeleteDocument` operation. + # index by the `BatchDeleteDocument` API. # # @!attribute [rw] id # The identifier of the document that couldn't be removed from the @@ -788,7 +788,7 @@ class BatchDeleteDocumentResponseFailedDocument < Struct.new( # # @!attribute [rw] index_id # The identifier of the index to add documents to. The index ID is - # returned by the [ CreateIndex ][1] operation. + # returned by the [CreateIndex ][1] API. # # # @@ -969,13 +969,13 @@ class BatchGetDocumentStatusResponseError < Struct.new( # # @!attribute [rw] index_id # The identifier of the index to add the documents to. You need to - # create the index first using the `CreateIndex` operation. + # create the index first using the `CreateIndex` API. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of a role that is allowed to run the - # `BatchPutDocument` operation. For more information, see [IAM Roles - # for Amazon Kendra][1]. + # `BatchPutDocument` API. For more information, see [IAM Roles for + # Amazon Kendra][1]. # # # @@ -985,13 +985,6 @@ class BatchGetDocumentStatusResponseError < Struct.new( # @!attribute [rw] documents # One or more documents to add to the index. # - # Documents can include custom attributes. For example, - # 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes - # that provide information on the synchronization of documents running - # on a data source. Note, 'DataSourceSyncJobId' could be an optional - # custom attribute as Amazon Kendra will use the ID of a running sync - # job. - # # Documents have the following file size limits. # # * 5 MB total size for inline documents @@ -1011,7 +1004,7 @@ class BatchGetDocumentStatusResponseError < Struct.new( # @!attribute [rw] custom_document_enrichment_configuration # Configuration information for altering your document metadata and # content during the document ingestion process when you use the - # `BatchPutDocument` operation. + # `BatchPutDocument` API. # # For more information on how to create, modify and delete document # metadata, or make other content alterations when you ingest @@ -1151,8 +1144,8 @@ class ClearQuerySuggestionsRequest < Struct.new( end # Gathers information about when a particular result was clicked by a - # user. Your application uses the `SubmitFeedback` operation to provide - # click information. + # user. Your application uses the `SubmitFeedback` API to provide click + # information. # # @note When making an API call, you may pass ClickFeedback # data as a hash: @@ -1214,7 +1207,7 @@ class ClickFeedback < Struct.new( # @!attribute [rw] field_mappings # An array of objects that map database column names to the # corresponding fields in an index. You must first create the fields - # in the index using the `UpdateIndex` operation. + # in the index using the `UpdateIndex` API. # @return [Array] # # @!attribute [rw] change_detecting_columns @@ -1272,7 +1265,7 @@ class ConflictException < Struct.new( # Defines how attachment metadata fields should be mapped to index # fields. Before you can map a field, you must first create an index # field with a matching type using the console or the `UpdateIndex` - # operation. + # API. # # If you specify the `AttachentFieldMappings` parameter, you must # specify at least one field mapping. @@ -1290,8 +1283,7 @@ class ConfluenceAttachmentConfiguration < Struct.new( # Defines the mapping between a field in the Confluence data source to a # Amazon Kendra index field. # - # You must first create the index field using the `UpdateIndex` - # operation. + # You must first create the index field using the `UpdateIndex` API. # # @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping # data as a hash: @@ -1305,8 +1297,7 @@ class ConfluenceAttachmentConfiguration < Struct.new( # @!attribute [rw] data_source_field_name # The name of the field in the data source. # - # You must first create the index field using the `UpdateIndex` - # operation. + # You must first create the index field using the `UpdateIndex` API. # @return [String] # # @!attribute [rw] date_field_format @@ -1334,7 +1325,7 @@ class ConfluenceAttachmentToIndexFieldMapping < Struct.new( # Specifies the blog settings for the Confluence data source. Blogs are # always indexed unless filtered from the index by the # `ExclusionPatterns` or `InclusionPatterns` fields in the - # `ConfluenceConfiguration` type. + # `ConfluenceConfiguration` object. # # @note When making an API call, you may pass ConfluenceBlogConfiguration # data as a hash: @@ -1352,8 +1343,7 @@ class ConfluenceAttachmentToIndexFieldMapping < Struct.new( # @!attribute [rw] blog_field_mappings # Defines how blog metadata fields should be mapped to index fields. # Before you can map a field, you must first create an index field - # with a matching type using the console or the `UpdateIndex` - # operation. + # with a matching type using the console or the `UpdateIndex` API. # # If you specify the `BlogFieldMappings` parameter, you must specify # at least one field mapping. @@ -1370,8 +1360,7 @@ class ConfluenceBlogConfiguration < Struct.new( # Defines the mapping between a blog field in the Confluence data source # to a Amazon Kendra index field. # - # You must first create the index field using the `UpdateIndex` - # operation. + # You must first create the index field using the `UpdateIndex` API. # # @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping # data as a hash: @@ -1566,8 +1555,7 @@ class ConfluenceConfiguration < Struct.new( # @!attribute [rw] page_field_mappings # Defines how page metadata fields should be mapped to index fields. # Before you can map a field, you must first create an index field - # with a matching type using the console or the `UpdateIndex` - # operation. + # with a matching type using the console or the `UpdateIndex` API. # # If you specify the `PageFieldMappings` parameter, you must specify # at least one field mapping. @@ -1584,8 +1572,7 @@ class ConfluencePageConfiguration < Struct.new( # Defines the mapping between a field in the Confluence data source to a # Amazon Kendra index field. # - # You must first create the index field using the `UpdateIndex` - # operation. + # You must first create the index field using the `UpdateIndex` API. # # @note When making an API call, you may pass ConfluencePageToIndexFieldMapping # data as a hash: @@ -1676,8 +1663,7 @@ class ConfluencePageToIndexFieldMapping < Struct.new( # @!attribute [rw] space_field_mappings # Defines how space metadata fields should be mapped to index fields. # Before you can map a field, you must first create an index field - # with a matching type using the console or the `UpdateIndex` - # operation. + # with a matching type using the console or the `UpdateIndex` API. # # If you specify the `SpaceFieldMappings` parameter, you must specify # at least one field mapping. @@ -1695,11 +1681,10 @@ class ConfluenceSpaceConfiguration < Struct.new( include Aws::Structure end - # Defines the mapping between a field in the Confluence data source to a - # Amazon Kendra index field. + # Defines the mapping between a field in the Confluence data source to + # an Amazon Kendra index field. # - # You must first create the index field using the `UpdateIndex` - # operation. + # You must first create the index field using the `UpdateIndex` API. # # @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping # data as a hash: @@ -1819,7 +1804,7 @@ class ConnectionConfiguration < Struct.new( # # @!attribute [rw] direct_put_content # `TRUE` to use documents you indexed directly using the - # `BatchPutDocument` operation. + # `BatchPutDocument` API. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ContentSourceConfiguration AWS API Documentation @@ -1838,7 +1823,7 @@ class ContentSourceConfiguration < Struct.new( # { # name: "DataSourceName", # required # index_id: "IndexId", # required - # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS + # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX # configuration: { # s3_configuration: { # bucket_name: "S3BucketName", # required @@ -2150,6 +2135,24 @@ class ContentSourceConfiguration < Struct.new( # }, # ], # }, + # fsx_configuration: { + # file_system_id: "FileSystemId", # required + # file_system_type: "WINDOWS", # required, accepts WINDOWS + # vpc_configuration: { # required + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # secret_arn: "SecretArn", + # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", @@ -2251,10 +2254,10 @@ class ContentSourceConfiguration < Struct.new( # @return [String] # # @!attribute [rw] schedule - # Sets the frequency that Amazon Kendra will check the documents in - # your repository and update the index. If you don't set a schedule - # Amazon Kendra will not periodically update the index. You can call - # the `StartDataSourceSyncJob` operation to update the index. + # Sets the frequency for Amazon Kendra to check the documents in your + # repository and update the index. If you don't set a schedule Amazon + # Kendra will not periodically update the index. You can call the + # `StartDataSourceSyncJob` API to update the index. # # You can't specify the `Schedule` parameter when the `Type` # parameter is set to `CUSTOM`. If you do, you receive a @@ -2285,8 +2288,8 @@ class ContentSourceConfiguration < Struct.new( # # @!attribute [rw] client_token # A token that you provide to identify the request to create a data - # source. Multiple calls to the `CreateDataSource` operation with the - # same client token will create only one data source. + # source. Multiple calls to the `CreateDataSource` API with the same + # client token will create only one data source. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. @@ -2379,10 +2382,9 @@ class CreateDataSourceResponse < Struct.new( # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of a role with permission to access - # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback` - # operations, and Amazon Web Services SSO that stores your user and - # group information. For more information, see [IAM roles for Amazon - # Kendra][1]. + # `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and + # Amazon Web Services SSO that stores your user and group information. + # For more information, see [IAM roles for Amazon Kendra][1]. # # # @@ -2404,7 +2406,7 @@ class CreateDataSourceResponse < Struct.new( # @!attribute [rw] client_token # A token that you provide to identify the request to create your # Amazon Kendra experience. Multiple calls to the `CreateExperience` - # operation with the same client token creates only one Amazon Kendra + # API with the same client token creates only one Amazon Kendra # experience. # # **A suitable default value is auto-generated.** You should normally @@ -2508,8 +2510,8 @@ class CreateExperienceResponse < Struct.new( # # @!attribute [rw] client_token # A token that you provide to identify the request to create a FAQ. - # Multiple calls to the `CreateFaqRequest` operation with the same - # client token will create only one FAQ. + # Multiple calls to the `CreateFaqRequest` API with the same client + # token will create only one FAQ. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. @@ -2620,8 +2622,8 @@ class CreateFaqResponse < Struct.new( # @!attribute [rw] role_arn # An Identity and Access Management(IAM) role that gives Amazon Kendra # permissions to access your Amazon CloudWatch logs and metrics. This - # is also the role used when you use the `BatchPutDocument` operation - # to index documents from an Amazon S3 bucket. + # is also the role used when you use the `BatchPutDocument` API to + # index documents from an Amazon S3 bucket. # @return [String] # # @!attribute [rw] server_side_encryption_configuration @@ -2636,8 +2638,8 @@ class CreateFaqResponse < Struct.new( # # @!attribute [rw] client_token # A token that you provide to identify the request to create an index. - # Multiple calls to the `CreateIndex` operation with the same client - # token will create only one index. + # Multiple calls to the `CreateIndex` API with the same client token + # will create only one index. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. @@ -2778,10 +2780,10 @@ class CreateIndexResponse < Struct.new( # The IAM (Identity and Access Management) role used by Amazon Kendra # to access the block list text file in your S3 bucket. # - # You need permissions to the role ARN (Amazon Resource Name). The - # role needs S3 read permissions to your file in S3 and needs to give - # STS (Security Token Service) assume role permissions to Amazon - # Kendra. + # You need permissions to the role ARN (Amazon Web Services Resource + # Name). The role needs S3 read permissions to your file in S3 and + # needs to give STS (Security Token Service) assume role permissions + # to Amazon Kendra. # @return [String] # # @!attribute [rw] tags @@ -2865,8 +2867,8 @@ class CreateQuerySuggestionsBlockListResponse < Struct.new( # # @!attribute [rw] client_token # A token that you provide to identify the request to create a - # thesaurus. Multiple calls to the `CreateThesaurus` operation with - # the same client token will create only one thesaurus. + # thesaurus. Multiple calls to the `CreateThesaurus` API with the same + # client token will create only one thesaurus. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. @@ -3336,6 +3338,24 @@ class CustomDocumentEnrichmentConfiguration < Struct.new( # }, # ], # }, + # fsx_configuration: { + # file_system_id: "FileSystemId", # required + # file_system_type: "WINDOWS", # required, accepts WINDOWS + # vpc_configuration: { # required + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # secret_arn: "SecretArn", + # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # } # # @!attribute [rw] s3_configuration @@ -3384,10 +3404,15 @@ class CustomDocumentEnrichmentConfiguration < Struct.new( # @return [Types::WebCrawlerConfiguration] # # @!attribute [rw] work_docs_configuration - # Provides the configuration information to connect to WorkDocs as - # your data source. + # Provides the configuration information to connect to Amazon WorkDocs + # as your data source. # @return [Types::WorkDocsConfiguration] # + # @!attribute [rw] fsx_configuration + # Provides the configuration information to connect to Amazon FSx as + # your data source. + # @return [Types::FsxConfiguration] + # # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation # class DataSourceConfiguration < Struct.new( @@ -3400,7 +3425,8 @@ class DataSourceConfiguration < Struct.new( :confluence_configuration, :google_drive_configuration, :web_crawler_configuration, - :work_docs_configuration) + :work_docs_configuration, + :fsx_configuration) SENSITIVE = [] include Aws::Structure end @@ -3436,8 +3462,8 @@ class DataSourceGroup < Struct.new( include Aws::Structure end - # Summary information for a Amazon Kendra data source. Returned in a - # call to the `DescribeDataSource` operation. + # Summary information for an Amazon Kendra data source. Returned in a + # call to the `DescribeDataSource` API. # # @!attribute [rw] name # The name of the data source. @@ -3489,18 +3515,18 @@ class DataSourceSummary < Struct.new( include Aws::Structure end - # Provides information about a synchronization job. + # Provides information about a data source synchronization job. # # @!attribute [rw] execution_id # A unique identifier for the synchronization job. # @return [String] # # @!attribute [rw] start_time - # The UNIX datetime that the synchronization job was started. + # The UNIX datetime that the synchronization job started. # @return [Time] # # @!attribute [rw] end_time - # The UNIX datetime that the synchronization job was completed. + # The UNIX datetime that the synchronization job completed. # @return [Time] # # @!attribute [rw] status @@ -3518,7 +3544,7 @@ class DataSourceSummary < Struct.new( # # @!attribute [rw] error_code # If the `Status` field is set to `FAILED`, the `ErrorCode` field - # contains a the reason that the synchronization failed. + # indicates the reason the synchronization failed. # @return [String] # # @!attribute [rw] data_source_error_code @@ -3626,8 +3652,7 @@ class DataSourceSyncJobMetrics < Struct.new( end # Maps a column or attribute in the data source to an index field. You - # must first create the fields in the index using the `UpdateIndex` - # operation. + # must first create the fields in the index using the `UpdateIndex` API. # # @note When making an API call, you may pass DataSourceToIndexFieldMapping # data as a hash: @@ -4048,7 +4073,7 @@ class DescribeDataSourceRequest < Struct.new( # @return [String] # # @!attribute [rw] schedule - # The schedule that Amazon Kendra will update the data source. + # The schedule for Amazon Kendra to update the index. # @return [String] # # @!attribute [rw] role_arn @@ -4182,9 +4207,9 @@ class DescribeExperienceRequest < Struct.new( # # @!attribute [rw] role_arn # Shows the Amazon Resource Name (ARN) of a role with permission to - # access `Query` operations, `QuerySuggestions` operations, - # `SubmitFeedback` operations, and Amazon Web Services SSO that stores - # your user and group information. + # access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, + # and Amazon Web Services SSO that stores your user and group + # information. # @return [String] # # @!attribute [rw] error_message @@ -4649,7 +4674,7 @@ class DescribeQuerySuggestionsConfigRequest < Struct.new( # # By default, Amazon Kendra enables query suggestions.`LEARN_ONLY` # turns off query suggestions for your users. You can change the mode - # using the [UpdateQuerySuggestionsConfig][1] operation. + # using the [UpdateQuerySuggestionsConfig][1] API. # # # @@ -4987,9 +5012,9 @@ class DisassociatePersonasFromEntitiesResponse < Struct.new( # # Documents passed to the `Blob` parameter must be base64 encoded. # Your code might not need to encode the document file bytes if - # you're using an Amazon Web Services SDK to call Amazon Kendra - # operations. If you are calling the Amazon Kendra endpoint directly - # using REST, you must base64 encode the contents before sending. + # you're using an Amazon Web Services SDK to call Amazon Kendra APIs. + # If you are calling the Amazon Kendra endpoint directly using REST, + # you must base64 encode the contents before sending. # @return [String] # # @!attribute [rw] s3_path @@ -5001,6 +5026,12 @@ class DisassociatePersonasFromEntitiesResponse < Struct.new( # attributes to provide additional information for searching, to # provide facets for refining searches, and to provide additional # information in the query response. + # + # For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom + # attributes that provide information on the synchronization of + # documents running on a data source. Note, 'DataSourceSyncJobId' + # could be an optional custom attribute as Amazon Kendra will use the + # ID of a running sync job. # @return [Array] # # @!attribute [rw] access_control_list @@ -5577,8 +5608,8 @@ class EntityPersonaConfiguration < Struct.new( # @!attribute [rw] content_source_configuration # The identifiers of your data sources and FAQs. Or, you can specify # that you want to use documents indexed via the `BatchPutDocument` - # operation. This is the content you want to use for your Amazon - # Kendra experience. + # API. This is the content you want to use for your Amazon Kendra + # experience. # @return [Types::ContentSourceConfiguration] # # @!attribute [rw] user_identity_configuration @@ -5837,6 +5868,117 @@ class FaqSummary < Struct.new( include Aws::Structure end + # Provides the configuration information to connect to Amazon FSx as + # your data source. + # + # @note When making an API call, you may pass FsxConfiguration + # data as a hash: + # + # { + # file_system_id: "FileSystemId", # required + # file_system_type: "WINDOWS", # required, accepts WINDOWS + # vpc_configuration: { # required + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # secret_arn: "SecretArn", + # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # } + # + # @!attribute [rw] file_system_id + # The identifier of the Amazon FSx file system. + # + # You can find your file system ID on the file system dashboard in the + # Amazon FSx console. For information on how to create a file system + # in Amazon FSx console, using Windows File Server as an example, see + # [Amazon FSx Getting started guide][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html + # @return [String] + # + # @!attribute [rw] file_system_type + # The Amazon FSx file system type. Windows is currently the only + # supported type. + # @return [String] + # + # @!attribute [rw] vpc_configuration + # Provides the configuration information for connecting to an Amazon + # Virtual Private Cloud for your Amazon FSx. Your Amazon FSx instance + # must reside inside your VPC. + # @return [Types::DataSourceVpcConfiguration] + # + # @!attribute [rw] secret_arn + # The Amazon Resource Name (ARN) of an Secrets Manager secret that + # contains the key-value pairs required to connect to your Amazon FSx + # file system. Windows is currently the only supported type. The + # secret must contain a JSON structure with the following keys: + # + # * username—The Active Directory user name, along with the Domain + # Name System (DNS) domain name. For example, + # *user@corp.example.com*. The Active Directory user account must + # have read and mounting access to the Amazon FSx file system for + # Windows. + # + # * password—The password of the active directory user with read and + # mounting access Amazon FSx Windows file system. + # @return [String] + # + # @!attribute [rw] inclusion_patterns + # A list of regular expression patterns to include certain files in + # your Amazon FSx file system. Files that match the patterns are + # included in the index. Files that don't match the patterns are + # excluded from the index. If a file matches both an inclusion pattern + # and an exclusion pattern, the exclusion pattern takes precedence and + # the file isn't included in the index. + # @return [Array] + # + # @!attribute [rw] exclusion_patterns + # A list of regular expression patterns to exclude certain files in + # your Amazon FSx file system. Files that match the patterns are + # excluded from the index. Files that don’t match the patterns are + # included in the index. If a file matches both an inclusion pattern + # and an exclusion pattern, the exclusion pattern takes precedence and + # the file isn't included in the index. + # @return [Array] + # + # @!attribute [rw] field_mappings + # A list of `DataSourceToIndexFieldMapping` objects that map Amazon + # FSx data source attributes or field names to Amazon Kendra index + # field names in Amazon Kendra. To create custom fields, use the + # `UpdateIndex` API before you map to Amazon FSx fields. For more + # information, see [Mapping data source fields][1]. The Amazon FSx + # data source field names must exist in your Amazon FSx custom + # metadata. + # + # + # + # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FsxConfiguration AWS API Documentation + # + class FsxConfiguration < Struct.new( + :file_system_id, + :file_system_type, + :vpc_configuration, + :secret_arn, + :inclusion_patterns, + :exclusion_patterns, + :field_mappings) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass GetQuerySuggestionsRequest # data as a hash: # @@ -6056,7 +6198,7 @@ class GetSnapshotsResponse < Struct.new( # # If you are using the console, you can define index fields when # creating the mapping. If you are using the API, you must first - # create the field using the `UpdateIndex` operation. + # create the field using the `UpdateIndex` API. # @return [Array] # # @!attribute [rw] exclude_mime_types @@ -6372,7 +6514,7 @@ class HookConfiguration < Struct.new( # # @!attribute [rw] id # A unique identifier for the index. Use this to identify the index - # when you are using operations such as `Query`, `DescribeIndex`, + # when you are using APIs such as `Query`, `DescribeIndex`, # `UpdateIndex`, and `DeleteIndex`. # @return [String] # @@ -6387,7 +6529,7 @@ class HookConfiguration < Struct.new( # # @!attribute [rw] updated_at # The Unix timestamp when the index was last updated by the - # `UpdateIndex` operation. + # `UpdateIndex` API. # @return [Time] # # @!attribute [rw] status @@ -7777,7 +7919,7 @@ class PutPrincipalMappingRequest < Struct.new( # # @!attribute [rw] index_id # The unique identifier of the index to search. The identifier is - # returned in the response from the `CreateIndex` operation. + # returned in the response from the `CreateIndex` API. # @return [String] # # @!attribute [rw] query_text @@ -8148,7 +8290,7 @@ class Relevance < Struct.new( end # Provides feedback on how relevant a document is to a search. Your - # application uses the `SubmitFeedback` operation to provide relevance + # application uses the `SubmitFeedback` API to provide relevance # information. # # @note When making an API call, you may pass RelevanceFeedback @@ -9321,9 +9463,9 @@ class ServiceQuotaExceededException < Struct.new( # @!attribute [rw] field_mappings # A list of `DataSourceToIndexFieldMapping` objects that map Microsoft # SharePoint attributes to custom fields in the Amazon Kendra index. - # You must first create the index fields using the `UpdateIndex` - # operation before you map SharePoint attributes. For more - # information, see [Mapping Data Source Fields][1]. + # You must first create the index fields using the `UpdateIndex` API + # before you map SharePoint attributes. For more information, see + # [Mapping Data Source Fields][1]. # # # @@ -9614,7 +9756,7 @@ class StopDataSourceSyncJobRequest < Struct.new( # @!attribute [rw] query_id # The identifier of the specific query for which you are submitting # feedback. The query ID is returned in the response to the `Query` - # operation. + # API. # @return [String] # # @!attribute [rw] click_feedback_items @@ -10245,6 +10387,24 @@ class UntagResourceResponse < Aws::EmptyStructure; end # }, # ], # }, + # fsx_configuration: { + # file_system_id: "FileSystemId", # required + # file_system_type: "WINDOWS", # required, accepts WINDOWS + # vpc_configuration: { # required + # subnet_ids: ["SubnetId"], # required + # security_group_ids: ["VpcSecurityGroupId"], # required + # }, + # secret_arn: "SecretArn", + # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], + # field_mappings: [ + # { + # data_source_field_name: "DataSourceFieldName", # required + # date_field_format: "DataSourceDateFieldFormat", + # index_field_name: "IndexFieldName", # required + # }, + # ], + # }, # }, # description: "Description", # schedule: "ScanSchedule", @@ -10417,10 +10577,9 @@ class UpdateDataSourceRequest < Struct.new( # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of a role with permission to access - # `Query` operations, `QuerySuggestions` operations, `SubmitFeedback` - # operations, and Amazon Web Services SSO that stores your user and - # group information. For more information, see [IAM roles for Amazon - # Kendra][1]. + # `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and + # Amazon Web Services SSO that stores your user and group information. + # For more information, see [IAM roles for Amazon Kendra][1]. # # # @@ -10899,7 +11058,7 @@ class UserContext < Struct.new( # Amazon Kendra filters search results for different users based on # their group's access to documents. You can also map your users to # their groups for user context filtering using the [PutPrincipalMapping - # operation][1]. + # API][1]. # # To set up an Amazon Web Services SSO identity source in the console to # use with Amazon Kendra, see [Getting started with an Amazon Web @@ -10910,7 +11069,7 @@ class UserContext < Struct.new( # Amazon Kendra currently does not support using # `UserGroupResolutionConfiguration` with an Amazon Web Services # organization member account for your Amazon Web Services SSO identify - # source. You must create your index in the parent account for the + # source. You must create your index in the management account for the # organization in order to use `UserGroupResolutionConfiguration`. # # @@ -11292,9 +11451,9 @@ class WebCrawlerConfiguration < Struct.new( # A list of `DataSourceToIndexFieldMapping` objects that map Amazon # WorkDocs field names to custom index field names in Amazon Kendra. # You must first create the custom index fields using the - # `UpdateIndex` operation before you map to Amazon WorkDocs fields. - # For more information, see [Mapping Data Source Fields][1]. The - # Amazon WorkDocs data source field names need to exist in your Amazon + # `UpdateIndex` API before you map to Amazon WorkDocs fields. For more + # information, see [Mapping Data Source Fields][1]. The Amazon + # WorkDocs data source field names need to exist in your Amazon # WorkDocs custom metadata. # # diff --git a/gems/aws-sdk-s3control/CHANGELOG.md b/gems/aws-sdk-s3control/CHANGELOG.md index f6c4a9596db..f484fa17cb7 100644 --- a/gems/aws-sdk-s3control/CHANGELOG.md +++ b/gems/aws-sdk-s3control/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.48.0 (2022-02-08) +------------------ + +* Feature - This release adds support for S3 Batch Replication. Batch Replication lets you replicate existing objects, already replicated objects to new destinations, and objects that previously failed to replicate. Customers will receive object-level visibility of progress and a detailed completion report. + 1.47.0 (2022-02-03) ------------------ diff --git a/gems/aws-sdk-s3control/VERSION b/gems/aws-sdk-s3control/VERSION index 21998d3c2d9..9db5ea12f52 100644 --- a/gems/aws-sdk-s3control/VERSION +++ b/gems/aws-sdk-s3control/VERSION @@ -1 +1 @@ -1.47.0 +1.48.0 diff --git a/gems/aws-sdk-s3control/lib/aws-sdk-s3control.rb b/gems/aws-sdk-s3control/lib/aws-sdk-s3control.rb index db251f713c4..08c5269832f 100644 --- a/gems/aws-sdk-s3control/lib/aws-sdk-s3control.rb +++ b/gems/aws-sdk-s3control/lib/aws-sdk-s3control.rb @@ -48,6 +48,6 @@ # @!group service module Aws::S3Control - GEM_VERSION = '1.47.0' + GEM_VERSION = '1.48.0' end diff --git a/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb b/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb index f1edd31aa23..859ecb72aac 100644 --- a/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb +++ b/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client.rb @@ -726,7 +726,7 @@ def create_bucket(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html @@ -760,7 +760,7 @@ def create_bucket(params = {}, options = {}) # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # - # @option params [required, Types::JobManifest] :manifest + # @option params [Types::JobManifest] :manifest # Configuration parameters for the manifest. # # @option params [String] :description @@ -781,6 +781,11 @@ def create_bucket(params = {}, options = {}) # A set of tags to associate with the S3 Batch Operations job. This is # an optional parameter. # + # @option params [Types::JobManifestGenerator] :manifest_generator + # The attribute container for the ManifestGenerator details. Jobs must + # be created with either a manifest file or a ManifestGenerator, but not + # both. + # # @return [Types::CreateJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateJobResult#job_id #job_id} => String @@ -832,7 +837,7 @@ def create_bucket(params = {}, options = {}) # ], # redirect_location: "NonEmptyMaxLength2048String", # requester_pays: false, - # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE + # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR # un_modified_since_constraint: Time.now, # sse_aws_kms_key_id: "KmsKeyArnString", # target_key_prefix: "NonEmptyMaxLength1024String", @@ -888,6 +893,8 @@ def create_bucket(params = {}, options = {}) # mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE # }, # }, + # s3_replicate_object: { + # }, # }, # report: { # required # bucket: "S3BucketArnString", @@ -897,7 +904,7 @@ def create_bucket(params = {}, options = {}) # report_scope: "AllTasks", # accepts AllTasks, FailedTasksOnly # }, # client_request_token: "NonEmptyMaxLength64String", # required - # manifest: { # required + # manifest: { # spec: { # required # format: "S3BatchOperations_CSV_20180820", # required, accepts S3BatchOperations_CSV_20180820, S3InventoryReport_CSV_20161130 # fields: ["Ignore"], # accepts Ignore, Bucket, Key, VersionId @@ -917,6 +924,32 @@ def create_bucket(params = {}, options = {}) # value: "TagValueString", # required # }, # ], + # manifest_generator: { + # s3_job_manifest_generator: { + # expected_bucket_owner: "AccountId", + # source_bucket: "S3BucketArnString", # required + # manifest_output_location: { + # expected_manifest_bucket_owner: "AccountId", + # bucket: "S3BucketArnString", # required + # manifest_prefix: "ManifestPrefixString", + # manifest_encryption: { + # sses3: { + # }, + # ssekms: { + # key_id: "KmsKeyArnString", # required + # }, + # }, + # manifest_format: "S3InventoryReport_CSV_20211130", # required, accepts S3InventoryReport_CSV_20211130 + # }, + # filter: { + # eligible_for_replication: false, + # created_after: Time.now, + # created_before: Time.now, + # object_replication_statuses: ["COMPLETED"], # accepts COMPLETED, FAILED, REPLICA, NONE + # }, + # enable_manifest_output: false, # required + # }, + # }, # }) # # @example Response structure @@ -1797,7 +1830,7 @@ def delete_storage_lens_configuration_tagging(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html @@ -1861,7 +1894,7 @@ def delete_storage_lens_configuration_tagging(params = {}, options = {}) # resp.job.operation.s3_put_object_copy.new_object_tagging[0].value #=> String # resp.job.operation.s3_put_object_copy.redirect_location #=> String # resp.job.operation.s3_put_object_copy.requester_pays #=> Boolean - # resp.job.operation.s3_put_object_copy.storage_class #=> String, one of "STANDARD", "STANDARD_IA", "ONEZONE_IA", "GLACIER", "INTELLIGENT_TIERING", "DEEP_ARCHIVE" + # resp.job.operation.s3_put_object_copy.storage_class #=> String, one of "STANDARD", "STANDARD_IA", "ONEZONE_IA", "GLACIER", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "GLACIER_IR" # resp.job.operation.s3_put_object_copy.un_modified_since_constraint #=> Time # resp.job.operation.s3_put_object_copy.sse_aws_kms_key_id #=> String # resp.job.operation.s3_put_object_copy.target_key_prefix #=> String @@ -1890,6 +1923,7 @@ def delete_storage_lens_configuration_tagging(params = {}, options = {}) # resp.job.progress_summary.total_number_of_tasks #=> Integer # resp.job.progress_summary.number_of_tasks_succeeded #=> Integer # resp.job.progress_summary.number_of_tasks_failed #=> Integer + # resp.job.progress_summary.timers.elapsed_time_in_active_seconds #=> Integer # resp.job.status_update_reason #=> String # resp.job.failure_reasons #=> Array # resp.job.failure_reasons[0].failure_code #=> String @@ -1904,6 +1938,23 @@ def delete_storage_lens_configuration_tagging(params = {}, options = {}) # resp.job.role_arn #=> String # resp.job.suspended_date #=> Time # resp.job.suspended_cause #=> String + # resp.job.manifest_generator.s3_job_manifest_generator.expected_bucket_owner #=> String + # resp.job.manifest_generator.s3_job_manifest_generator.source_bucket #=> String + # resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.expected_manifest_bucket_owner #=> String + # resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.bucket #=> String + # resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_prefix #=> String + # resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_encryption.ssekms.key_id #=> String + # resp.job.manifest_generator.s3_job_manifest_generator.manifest_output_location.manifest_format #=> String, one of "S3InventoryReport_CSV_20211130" + # resp.job.manifest_generator.s3_job_manifest_generator.filter.eligible_for_replication #=> Boolean + # resp.job.manifest_generator.s3_job_manifest_generator.filter.created_after #=> Time + # resp.job.manifest_generator.s3_job_manifest_generator.filter.created_before #=> Time + # resp.job.manifest_generator.s3_job_manifest_generator.filter.object_replication_statuses #=> Array + # resp.job.manifest_generator.s3_job_manifest_generator.filter.object_replication_statuses[0] #=> String, one of "COMPLETED", "FAILED", "REPLICA", "NONE" + # resp.job.manifest_generator.s3_job_manifest_generator.enable_manifest_output #=> Boolean + # resp.job.generated_manifest_descriptor.format #=> String, one of "S3InventoryReport_CSV_20211130" + # resp.job.generated_manifest_descriptor.location.object_arn #=> String + # resp.job.generated_manifest_descriptor.location.object_version_id #=> String + # resp.job.generated_manifest_descriptor.location.etag #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DescribeJob AWS API Documentation # @@ -3277,10 +3328,9 @@ def list_access_points(params = {}, options = {}) req.send_request(options) end - # Returns a list of the access points associated with the Object Lambda - # Access Point. You can retrieve up to 1000 access points per call. If - # there are more than 1,000 access points (or the number specified in - # `maxResults`, whichever is less), the response will include a + # Returns some or all (up to 1,000) access points associated with the + # Object Lambda Access Point per call. If there are more access points + # than what can be returned in one call, the response will include a # continuation token that you can use to list the additional access # points. # @@ -3311,9 +3361,10 @@ def list_access_points(params = {}, options = {}) # # @option params [Integer] :max_results # The maximum number of access points that you want to include in the - # list. If there are more than this number of access points, then the - # response will include a continuation token in the `NextToken` field - # that you can use to retrieve the next page of access points. + # list. The response may contain fewer access points but will never + # contain more. If there are more than this number of access points, + # then the response will include a continuation token in the `NextToken` + # field that you can use to retrieve the next page of access points. # # @return [Types::ListAccessPointsForObjectLambdaResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3365,7 +3416,7 @@ def list_access_points_for_object_lambda(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html @@ -3412,7 +3463,7 @@ def list_access_points_for_object_lambda(params = {}, options = {}) # resp.jobs #=> Array # resp.jobs[0].job_id #=> String # resp.jobs[0].description #=> String - # resp.jobs[0].operation #=> String, one of "LambdaInvoke", "S3PutObjectCopy", "S3PutObjectAcl", "S3PutObjectTagging", "S3DeleteObjectTagging", "S3InitiateRestoreObject", "S3PutObjectLegalHold", "S3PutObjectRetention" + # resp.jobs[0].operation #=> String, one of "LambdaInvoke", "S3PutObjectCopy", "S3PutObjectAcl", "S3PutObjectTagging", "S3DeleteObjectTagging", "S3InitiateRestoreObject", "S3PutObjectLegalHold", "S3PutObjectRetention", "S3ReplicateObject" # resp.jobs[0].priority #=> Integer # resp.jobs[0].status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended" # resp.jobs[0].creation_time #=> Time @@ -3420,6 +3471,7 @@ def list_access_points_for_object_lambda(params = {}, options = {}) # resp.jobs[0].progress_summary.total_number_of_tasks #=> Integer # resp.jobs[0].progress_summary.number_of_tasks_succeeded #=> Integer # resp.jobs[0].progress_summary.number_of_tasks_failed #=> Integer + # resp.jobs[0].progress_summary.timers.elapsed_time_in_active_seconds #=> Integer # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListJobs AWS API Documentation # @@ -4320,8 +4372,9 @@ def put_multi_region_access_point_policy(params = {}, options = {}) end # Creates or modifies the `PublicAccessBlock` configuration for an - # Amazon Web Services account. For more information, see [ Using Amazon - # S3 block public access][1]. + # Amazon Web Services account. For this operation, users must have the + # `s3:PutBucketPublicAccessBlock` permission. For more information, see + # [ Using Amazon S3 block public access][1]. # # Related actions include: # @@ -4549,7 +4602,7 @@ def put_storage_lens_configuration_tagging(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html @@ -4611,7 +4664,7 @@ def update_job_priority(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html @@ -4674,7 +4727,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-s3control' - context[:gem_version] = '1.47.0' + context[:gem_version] = '1.48.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client_api.rb b/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client_api.rb index fb7d4a2a2b2..e0d82a12c9a 100644 --- a/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client_api.rb +++ b/gems/aws-sdk-s3control/lib/aws-sdk-s3control/client_api.rb @@ -92,6 +92,8 @@ module ClientApi ExpiredObjectDeleteMarker = Shapes::BooleanShape.new(name: 'ExpiredObjectDeleteMarker') Format = Shapes::StringShape.new(name: 'Format') FunctionArnString = Shapes::StringShape.new(name: 'FunctionArnString') + GeneratedManifestEncryption = Shapes::StructureShape.new(name: 'GeneratedManifestEncryption') + GeneratedManifestFormat = Shapes::StringShape.new(name: 'GeneratedManifestFormat') GetAccessPointConfigurationForObjectLambdaRequest = Shapes::StructureShape.new(name: 'GetAccessPointConfigurationForObjectLambdaRequest') GetAccessPointConfigurationForObjectLambdaResult = Shapes::StructureShape.new(name: 'GetAccessPointConfigurationForObjectLambdaResult') GetAccessPointForObjectLambdaRequest = Shapes::StructureShape.new(name: 'GetAccessPointForObjectLambdaRequest') @@ -156,6 +158,8 @@ module ClientApi JobManifestFieldList = Shapes::ListShape.new(name: 'JobManifestFieldList') JobManifestFieldName = Shapes::StringShape.new(name: 'JobManifestFieldName') JobManifestFormat = Shapes::StringShape.new(name: 'JobManifestFormat') + JobManifestGenerator = Shapes::UnionShape.new(name: 'JobManifestGenerator') + JobManifestGeneratorFilter = Shapes::StructureShape.new(name: 'JobManifestGeneratorFilter') JobManifestLocation = Shapes::StructureShape.new(name: 'JobManifestLocation') JobManifestSpec = Shapes::StructureShape.new(name: 'JobManifestSpec') JobNumberOfTasksFailed = Shapes::IntegerShape.new(name: 'JobNumberOfTasksFailed') @@ -171,6 +175,8 @@ module ClientApi JobStatusList = Shapes::ListShape.new(name: 'JobStatusList') JobStatusUpdateReason = Shapes::StringShape.new(name: 'JobStatusUpdateReason') JobTerminationDate = Shapes::TimestampShape.new(name: 'JobTerminationDate') + JobTimeInStateSeconds = Shapes::IntegerShape.new(name: 'JobTimeInStateSeconds') + JobTimers = Shapes::StructureShape.new(name: 'JobTimers') JobTotalNumberOfTasks = Shapes::IntegerShape.new(name: 'JobTotalNumberOfTasks') KmsKeyArnString = Shapes::StringShape.new(name: 'KmsKeyArnString') LambdaInvokeOperation = Shapes::StructureShape.new(name: 'LambdaInvokeOperation') @@ -194,6 +200,7 @@ module ClientApi ListStorageLensConfigurationsRequest = Shapes::StructureShape.new(name: 'ListStorageLensConfigurationsRequest') ListStorageLensConfigurationsResult = Shapes::StructureShape.new(name: 'ListStorageLensConfigurationsResult') Location = Shapes::StringShape.new(name: 'Location') + ManifestPrefixString = Shapes::StringShape.new(name: 'ManifestPrefixString') MaxLength1024String = Shapes::StringShape.new(name: 'MaxLength1024String') MaxResults = Shapes::IntegerShape.new(name: 'MaxResults') MinStorageBytesPercentage = Shapes::FloatShape.new(name: 'MinStorageBytesPercentage') @@ -218,6 +225,7 @@ module ClientApi NoncurrentVersionTransition = Shapes::StructureShape.new(name: 'NoncurrentVersionTransition') NoncurrentVersionTransitionList = Shapes::ListShape.new(name: 'NoncurrentVersionTransitionList') NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException') + ObjectCreationTime = Shapes::TimestampShape.new(name: 'ObjectCreationTime') ObjectLambdaAccessPoint = Shapes::StructureShape.new(name: 'ObjectLambdaAccessPoint') ObjectLambdaAccessPointArn = Shapes::StringShape.new(name: 'ObjectLambdaAccessPointArn') ObjectLambdaAccessPointList = Shapes::ListShape.new(name: 'ObjectLambdaAccessPointList') @@ -266,6 +274,8 @@ module ClientApi RegionalBucket = Shapes::StructureShape.new(name: 'RegionalBucket') RegionalBucketList = Shapes::ListShape.new(name: 'RegionalBucketList') Regions = Shapes::ListShape.new(name: 'Regions') + ReplicationStatus = Shapes::StringShape.new(name: 'ReplicationStatus') + ReplicationStatusFilterList = Shapes::ListShape.new(name: 'ReplicationStatusFilterList') ReportPrefixString = Shapes::StringShape.new(name: 'ReportPrefixString') RequestedJobStatus = Shapes::StringShape.new(name: 'RequestedJobStatus') S3AWSRegion = Shapes::StringShape.new(name: 'S3AWSRegion') @@ -279,13 +289,16 @@ module ClientApi S3CopyObjectOperation = Shapes::StructureShape.new(name: 'S3CopyObjectOperation') S3DeleteObjectTaggingOperation = Shapes::StructureShape.new(name: 'S3DeleteObjectTaggingOperation') S3ExpirationInDays = Shapes::IntegerShape.new(name: 'S3ExpirationInDays') + S3GeneratedManifestDescriptor = Shapes::StructureShape.new(name: 'S3GeneratedManifestDescriptor') S3GlacierJobTier = Shapes::StringShape.new(name: 'S3GlacierJobTier') S3Grant = Shapes::StructureShape.new(name: 'S3Grant') S3GrantList = Shapes::ListShape.new(name: 'S3GrantList') S3Grantee = Shapes::StructureShape.new(name: 'S3Grantee') S3GranteeTypeIdentifier = Shapes::StringShape.new(name: 'S3GranteeTypeIdentifier') S3InitiateRestoreObjectOperation = Shapes::StructureShape.new(name: 'S3InitiateRestoreObjectOperation') + S3JobManifestGenerator = Shapes::StructureShape.new(name: 'S3JobManifestGenerator') S3KeyArnString = Shapes::StringShape.new(name: 'S3KeyArnString') + S3ManifestOutputLocation = Shapes::StructureShape.new(name: 'S3ManifestOutputLocation') S3MetadataDirective = Shapes::StringShape.new(name: 'S3MetadataDirective') S3ObjectLockLegalHold = Shapes::StructureShape.new(name: 'S3ObjectLockLegalHold') S3ObjectLockLegalHoldStatus = Shapes::StringShape.new(name: 'S3ObjectLockLegalHoldStatus') @@ -296,6 +309,7 @@ module ClientApi S3ObjectVersionId = Shapes::StringShape.new(name: 'S3ObjectVersionId') S3Permission = Shapes::StringShape.new(name: 'S3Permission') S3RegionalBucketArn = Shapes::StringShape.new(name: 'S3RegionalBucketArn') + S3ReplicateObjectOperation = Shapes::StructureShape.new(name: 'S3ReplicateObjectOperation') S3Retention = Shapes::StructureShape.new(name: 'S3Retention') S3SSEAlgorithm = Shapes::StringShape.new(name: 'S3SSEAlgorithm') S3SetObjectAclOperation = Shapes::StructureShape.new(name: 'S3SetObjectAclOperation') @@ -307,8 +321,10 @@ module ClientApi S3TagSet = Shapes::ListShape.new(name: 'S3TagSet') S3UserMetadata = Shapes::MapShape.new(name: 'S3UserMetadata') SSEKMS = Shapes::StructureShape.new(name: 'SSEKMS') + SSEKMSEncryption = Shapes::StructureShape.new(name: 'SSEKMSEncryption') SSEKMSKeyId = Shapes::StringShape.new(name: 'SSEKMSKeyId') SSES3 = Shapes::StructureShape.new(name: 'SSES3') + SSES3Encryption = Shapes::StructureShape.new(name: 'SSES3Encryption') SelectionCriteria = Shapes::StructureShape.new(name: 'SelectionCriteria') Setting = Shapes::BooleanShape.new(name: 'Setting') StorageLensArn = Shapes::StringShape.new(name: 'StorageLensArn') @@ -448,11 +464,12 @@ module ClientApi CreateJobRequest.add_member(:operation, Shapes::ShapeRef.new(shape: JobOperation, required: true, location_name: "Operation")) CreateJobRequest.add_member(:report, Shapes::ShapeRef.new(shape: JobReport, required: true, location_name: "Report")) CreateJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: NonEmptyMaxLength64String, required: true, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true})) - CreateJobRequest.add_member(:manifest, Shapes::ShapeRef.new(shape: JobManifest, required: true, location_name: "Manifest")) + CreateJobRequest.add_member(:manifest, Shapes::ShapeRef.new(shape: JobManifest, location_name: "Manifest")) CreateJobRequest.add_member(:description, Shapes::ShapeRef.new(shape: NonEmptyMaxLength256String, location_name: "Description")) CreateJobRequest.add_member(:priority, Shapes::ShapeRef.new(shape: JobPriority, required: true, location_name: "Priority", metadata: {"box"=>true})) CreateJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: IAMRoleArn, required: true, location_name: "RoleArn")) CreateJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: S3TagSet, location_name: "Tags")) + CreateJobRequest.add_member(:manifest_generator, Shapes::ShapeRef.new(shape: JobManifestGenerator, location_name: "ManifestGenerator")) CreateJobRequest.struct_class = Types::CreateJobRequest CreateJobResult.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId")) @@ -557,6 +574,10 @@ module ClientApi Exclude.add_member(:regions, Shapes::ShapeRef.new(shape: Regions, location_name: "Regions")) Exclude.struct_class = Types::Exclude + GeneratedManifestEncryption.add_member(:sses3, Shapes::ShapeRef.new(shape: SSES3Encryption, location_name: "SSE-S3")) + GeneratedManifestEncryption.add_member(:ssekms, Shapes::ShapeRef.new(shape: SSEKMSEncryption, location_name: "SSE-KMS")) + GeneratedManifestEncryption.struct_class = Types::GeneratedManifestEncryption + GetAccessPointConfigurationForObjectLambdaRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location: "header", location_name: "x-amz-account-id", metadata: {"hostLabel"=>true, "hostLabelName"=>"AccountId"})) GetAccessPointConfigurationForObjectLambdaRequest.add_member(:name, Shapes::ShapeRef.new(shape: ObjectLambdaAccessPointName, required: true, location: "uri", location_name: "name")) GetAccessPointConfigurationForObjectLambdaRequest.struct_class = Types::GetAccessPointConfigurationForObjectLambdaRequest @@ -731,6 +752,8 @@ module ClientApi JobDescriptor.add_member(:role_arn, Shapes::ShapeRef.new(shape: IAMRoleArn, location_name: "RoleArn", metadata: {"box"=>true})) JobDescriptor.add_member(:suspended_date, Shapes::ShapeRef.new(shape: SuspendedDate, location_name: "SuspendedDate", metadata: {"box"=>true})) JobDescriptor.add_member(:suspended_cause, Shapes::ShapeRef.new(shape: SuspendedCause, location_name: "SuspendedCause", metadata: {"box"=>true})) + JobDescriptor.add_member(:manifest_generator, Shapes::ShapeRef.new(shape: JobManifestGenerator, location_name: "ManifestGenerator")) + JobDescriptor.add_member(:generated_manifest_descriptor, Shapes::ShapeRef.new(shape: S3GeneratedManifestDescriptor, location_name: "GeneratedManifestDescriptor")) JobDescriptor.struct_class = Types::JobDescriptor JobFailure.add_member(:failure_code, Shapes::ShapeRef.new(shape: JobFailureCode, location_name: "FailureCode")) @@ -757,6 +780,18 @@ module ClientApi JobManifestFieldList.member = Shapes::ShapeRef.new(shape: JobManifestFieldName) + JobManifestGenerator.add_member(:s3_job_manifest_generator, Shapes::ShapeRef.new(shape: S3JobManifestGenerator, location_name: "S3JobManifestGenerator")) + JobManifestGenerator.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown')) + JobManifestGenerator.add_member_subclass(:s3_job_manifest_generator, Types::JobManifestGenerator::S3JobManifestGenerator) + JobManifestGenerator.add_member_subclass(:unknown, Types::JobManifestGenerator::Unknown) + JobManifestGenerator.struct_class = Types::JobManifestGenerator + + JobManifestGeneratorFilter.add_member(:eligible_for_replication, Shapes::ShapeRef.new(shape: Boolean, location_name: "EligibleForReplication", metadata: {"box"=>true})) + JobManifestGeneratorFilter.add_member(:created_after, Shapes::ShapeRef.new(shape: ObjectCreationTime, location_name: "CreatedAfter")) + JobManifestGeneratorFilter.add_member(:created_before, Shapes::ShapeRef.new(shape: ObjectCreationTime, location_name: "CreatedBefore")) + JobManifestGeneratorFilter.add_member(:object_replication_statuses, Shapes::ShapeRef.new(shape: ReplicationStatusFilterList, location_name: "ObjectReplicationStatuses")) + JobManifestGeneratorFilter.struct_class = Types::JobManifestGeneratorFilter + JobManifestLocation.add_member(:object_arn, Shapes::ShapeRef.new(shape: S3KeyArnString, required: true, location_name: "ObjectArn")) JobManifestLocation.add_member(:object_version_id, Shapes::ShapeRef.new(shape: S3ObjectVersionId, location_name: "ObjectVersionId", metadata: {"box"=>true})) JobManifestLocation.add_member(:etag, Shapes::ShapeRef.new(shape: NonEmptyMaxLength1024String, required: true, location_name: "ETag")) @@ -774,11 +809,13 @@ module ClientApi JobOperation.add_member(:s3_initiate_restore_object, Shapes::ShapeRef.new(shape: S3InitiateRestoreObjectOperation, location_name: "S3InitiateRestoreObject", metadata: {"box"=>true})) JobOperation.add_member(:s3_put_object_legal_hold, Shapes::ShapeRef.new(shape: S3SetObjectLegalHoldOperation, location_name: "S3PutObjectLegalHold", metadata: {"box"=>true})) JobOperation.add_member(:s3_put_object_retention, Shapes::ShapeRef.new(shape: S3SetObjectRetentionOperation, location_name: "S3PutObjectRetention", metadata: {"box"=>true})) + JobOperation.add_member(:s3_replicate_object, Shapes::ShapeRef.new(shape: S3ReplicateObjectOperation, location_name: "S3ReplicateObject", metadata: {"box"=>true})) JobOperation.struct_class = Types::JobOperation JobProgressSummary.add_member(:total_number_of_tasks, Shapes::ShapeRef.new(shape: JobTotalNumberOfTasks, location_name: "TotalNumberOfTasks", metadata: {"box"=>true})) JobProgressSummary.add_member(:number_of_tasks_succeeded, Shapes::ShapeRef.new(shape: JobNumberOfTasksSucceeded, location_name: "NumberOfTasksSucceeded", metadata: {"box"=>true})) JobProgressSummary.add_member(:number_of_tasks_failed, Shapes::ShapeRef.new(shape: JobNumberOfTasksFailed, location_name: "NumberOfTasksFailed", metadata: {"box"=>true})) + JobProgressSummary.add_member(:timers, Shapes::ShapeRef.new(shape: JobTimers, location_name: "Timers")) JobProgressSummary.struct_class = Types::JobProgressSummary JobReport.add_member(:bucket, Shapes::ShapeRef.new(shape: S3BucketArnString, location_name: "Bucket", metadata: {"box"=>true})) @@ -793,6 +830,9 @@ module ClientApi JobStatusList.member = Shapes::ShapeRef.new(shape: JobStatus) + JobTimers.add_member(:elapsed_time_in_active_seconds, Shapes::ShapeRef.new(shape: JobTimeInStateSeconds, location_name: "ElapsedTimeInActiveSeconds", metadata: {"box"=>true})) + JobTimers.struct_class = Types::JobTimers + LambdaInvokeOperation.add_member(:function_arn, Shapes::ShapeRef.new(shape: FunctionArnString, location_name: "FunctionArn")) LambdaInvokeOperation.struct_class = Types::LambdaInvokeOperation @@ -1067,6 +1107,8 @@ module ClientApi Regions.member = Shapes::ShapeRef.new(shape: S3AWSRegion, location_name: "Region") + ReplicationStatusFilterList.member = Shapes::ShapeRef.new(shape: ReplicationStatus) + S3AccessControlList.add_member(:owner, Shapes::ShapeRef.new(shape: S3ObjectOwner, required: true, location_name: "Owner")) S3AccessControlList.add_member(:grants, Shapes::ShapeRef.new(shape: S3GrantList, location_name: "Grants")) S3AccessControlList.struct_class = Types::S3AccessControlList @@ -1104,6 +1146,10 @@ module ClientApi S3DeleteObjectTaggingOperation.struct_class = Types::S3DeleteObjectTaggingOperation + S3GeneratedManifestDescriptor.add_member(:format, Shapes::ShapeRef.new(shape: GeneratedManifestFormat, location_name: "Format")) + S3GeneratedManifestDescriptor.add_member(:location, Shapes::ShapeRef.new(shape: JobManifestLocation, location_name: "Location")) + S3GeneratedManifestDescriptor.struct_class = Types::S3GeneratedManifestDescriptor + S3Grant.add_member(:grantee, Shapes::ShapeRef.new(shape: S3Grantee, location_name: "Grantee")) S3Grant.add_member(:permission, Shapes::ShapeRef.new(shape: S3Permission, location_name: "Permission")) S3Grant.struct_class = Types::S3Grant @@ -1119,6 +1165,20 @@ module ClientApi S3InitiateRestoreObjectOperation.add_member(:glacier_job_tier, Shapes::ShapeRef.new(shape: S3GlacierJobTier, location_name: "GlacierJobTier")) S3InitiateRestoreObjectOperation.struct_class = Types::S3InitiateRestoreObjectOperation + S3JobManifestGenerator.add_member(:expected_bucket_owner, Shapes::ShapeRef.new(shape: AccountId, location_name: "ExpectedBucketOwner")) + S3JobManifestGenerator.add_member(:source_bucket, Shapes::ShapeRef.new(shape: S3BucketArnString, required: true, location_name: "SourceBucket")) + S3JobManifestGenerator.add_member(:manifest_output_location, Shapes::ShapeRef.new(shape: S3ManifestOutputLocation, location_name: "ManifestOutputLocation")) + S3JobManifestGenerator.add_member(:filter, Shapes::ShapeRef.new(shape: JobManifestGeneratorFilter, location_name: "Filter")) + S3JobManifestGenerator.add_member(:enable_manifest_output, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "EnableManifestOutput")) + S3JobManifestGenerator.struct_class = Types::S3JobManifestGenerator + + S3ManifestOutputLocation.add_member(:expected_manifest_bucket_owner, Shapes::ShapeRef.new(shape: AccountId, location_name: "ExpectedManifestBucketOwner")) + S3ManifestOutputLocation.add_member(:bucket, Shapes::ShapeRef.new(shape: S3BucketArnString, required: true, location_name: "Bucket")) + S3ManifestOutputLocation.add_member(:manifest_prefix, Shapes::ShapeRef.new(shape: ManifestPrefixString, location_name: "ManifestPrefix")) + S3ManifestOutputLocation.add_member(:manifest_encryption, Shapes::ShapeRef.new(shape: GeneratedManifestEncryption, location_name: "ManifestEncryption")) + S3ManifestOutputLocation.add_member(:manifest_format, Shapes::ShapeRef.new(shape: GeneratedManifestFormat, required: true, location_name: "ManifestFormat")) + S3ManifestOutputLocation.struct_class = Types::S3ManifestOutputLocation + S3ObjectLockLegalHold.add_member(:status, Shapes::ShapeRef.new(shape: S3ObjectLockLegalHoldStatus, required: true, location_name: "Status")) S3ObjectLockLegalHold.struct_class = Types::S3ObjectLockLegalHold @@ -1139,6 +1199,8 @@ module ClientApi S3ObjectOwner.add_member(:display_name, Shapes::ShapeRef.new(shape: NonEmptyMaxLength1024String, location_name: "DisplayName")) S3ObjectOwner.struct_class = Types::S3ObjectOwner + S3ReplicateObjectOperation.struct_class = Types::S3ReplicateObjectOperation + S3Retention.add_member(:retain_until_date, Shapes::ShapeRef.new(shape: TimeStamp, location_name: "RetainUntilDate")) S3Retention.add_member(:mode, Shapes::ShapeRef.new(shape: S3ObjectLockRetentionMode, location_name: "Mode")) S3Retention.struct_class = Types::S3Retention @@ -1168,8 +1230,13 @@ module ClientApi SSEKMS.add_member(:key_id, Shapes::ShapeRef.new(shape: SSEKMSKeyId, required: true, location_name: "KeyId")) SSEKMS.struct_class = Types::SSEKMS + SSEKMSEncryption.add_member(:key_id, Shapes::ShapeRef.new(shape: KmsKeyArnString, required: true, location_name: "KeyId")) + SSEKMSEncryption.struct_class = Types::SSEKMSEncryption + SSES3.struct_class = Types::SSES3 + SSES3Encryption.struct_class = Types::SSES3Encryption + SelectionCriteria.add_member(:delimiter, Shapes::ShapeRef.new(shape: StorageLensPrefixLevelDelimiter, location_name: "Delimiter")) SelectionCriteria.add_member(:max_depth, Shapes::ShapeRef.new(shape: StorageLensPrefixLevelMaxDepth, location_name: "MaxDepth")) SelectionCriteria.add_member(:min_storage_bytes_percentage, Shapes::ShapeRef.new(shape: MinStorageBytesPercentage, location_name: "MinStorageBytesPercentage")) diff --git a/gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb b/gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb index f7856039abb..dad35d1ac9d 100644 --- a/gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb +++ b/gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb @@ -777,7 +777,7 @@ class CreateBucketResult < Struct.new( # ], # redirect_location: "NonEmptyMaxLength2048String", # requester_pays: false, - # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE + # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR # un_modified_since_constraint: Time.now, # sse_aws_kms_key_id: "KmsKeyArnString", # target_key_prefix: "NonEmptyMaxLength1024String", @@ -833,6 +833,8 @@ class CreateBucketResult < Struct.new( # mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE # }, # }, + # s3_replicate_object: { + # }, # }, # report: { # required # bucket: "S3BucketArnString", @@ -842,7 +844,7 @@ class CreateBucketResult < Struct.new( # report_scope: "AllTasks", # accepts AllTasks, FailedTasksOnly # }, # client_request_token: "NonEmptyMaxLength64String", # required - # manifest: { # required + # manifest: { # spec: { # required # format: "S3BatchOperations_CSV_20180820", # required, accepts S3BatchOperations_CSV_20180820, S3InventoryReport_CSV_20161130 # fields: ["Ignore"], # accepts Ignore, Bucket, Key, VersionId @@ -862,6 +864,32 @@ class CreateBucketResult < Struct.new( # value: "TagValueString", # required # }, # ], + # manifest_generator: { + # s3_job_manifest_generator: { + # expected_bucket_owner: "AccountId", + # source_bucket: "S3BucketArnString", # required + # manifest_output_location: { + # expected_manifest_bucket_owner: "AccountId", + # bucket: "S3BucketArnString", # required + # manifest_prefix: "ManifestPrefixString", + # manifest_encryption: { + # sses3: { + # }, + # ssekms: { + # key_id: "KmsKeyArnString", # required + # }, + # }, + # manifest_format: "S3InventoryReport_CSV_20211130", # required, accepts S3InventoryReport_CSV_20211130 + # }, + # filter: { + # eligible_for_replication: false, + # created_after: Time.now, + # created_before: Time.now, + # object_replication_statuses: ["COMPLETED"], # accepts COMPLETED, FAILED, REPLICA, NONE + # }, + # enable_manifest_output: false, # required + # }, + # }, # } # # @!attribute [rw] account_id @@ -923,6 +951,12 @@ class CreateBucketResult < Struct.new( # an optional parameter. # @return [Array] # + # @!attribute [rw] manifest_generator + # The attribute container for the ManifestGenerator details. Jobs must + # be created with either a manifest file or a ManifestGenerator, but + # not both. + # @return [Types::JobManifestGenerator] + # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateJobRequest AWS API Documentation # class CreateJobRequest < Struct.new( @@ -935,7 +969,8 @@ class CreateJobRequest < Struct.new( :description, :priority, :role_arn, - :tags) + :tags, + :manifest_generator) SENSITIVE = [] include Aws::Structure end @@ -1681,6 +1716,38 @@ class Exclude < Struct.new( include Aws::Structure end + # The encryption configuration to use when storing the generated + # manifest. + # + # @note When making an API call, you may pass GeneratedManifestEncryption + # data as a hash: + # + # { + # sses3: { + # }, + # ssekms: { + # key_id: "KmsKeyArnString", # required + # }, + # } + # + # @!attribute [rw] sses3 + # Specifies the use of SSE-S3 to encrypt generated manifest objects. + # @return [Types::SSES3Encryption] + # + # @!attribute [rw] ssekms + # Configuration details on how SSE-KMS is used to encrypt generated + # manifest objects. + # @return [Types::SSEKMSEncryption] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GeneratedManifestEncryption AWS API Documentation + # + class GeneratedManifestEncryption < Struct.new( + :sses3, + :ssekms) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass GetAccessPointConfigurationForObjectLambdaRequest # data as a hash: # @@ -2715,6 +2782,16 @@ class InvalidRequestException < Struct.new( # automatically exits the `Suspended` state. # @return [String] # + # @!attribute [rw] manifest_generator + # The manifest generator that was used to generate a job manifest for + # this job. + # @return [Types::JobManifestGenerator] + # + # @!attribute [rw] generated_manifest_descriptor + # The attribute of the JobDescriptor containing details about the + # job's generated manifest. + # @return [Types::S3GeneratedManifestDescriptor] + # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobDescriptor AWS API Documentation # class JobDescriptor < Struct.new( @@ -2734,7 +2811,9 @@ class JobDescriptor < Struct.new( :termination_date, :role_arn, :suspended_date, - :suspended_cause) + :suspended_cause, + :manifest_generator, + :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end @@ -2851,6 +2930,73 @@ class JobManifest < Struct.new( include Aws::Structure end + # Configures the type of the job's ManifestGenerator. + # + # @note JobManifestGenerator is a union - when making an API calls you must set exactly one of the members. + # + # @note JobManifestGenerator is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of JobManifestGenerator corresponding to the set member. + # + # @!attribute [rw] s3_job_manifest_generator + # The S3 job ManifestGenerator's configuration details. + # @return [Types::S3JobManifestGenerator] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifestGenerator AWS API Documentation + # + class JobManifestGenerator < Struct.new( + :s3_job_manifest_generator, + :unknown) + SENSITIVE = [] + include Aws::Structure + include Aws::Structure::Union + + class S3JobManifestGenerator < JobManifestGenerator; end + class Unknown < JobManifestGenerator; end + end + + # The filter used to describe a set of objects for the job's manifest. + # + # @note When making an API call, you may pass JobManifestGeneratorFilter + # data as a hash: + # + # { + # eligible_for_replication: false, + # created_after: Time.now, + # created_before: Time.now, + # object_replication_statuses: ["COMPLETED"], # accepts COMPLETED, FAILED, REPLICA, NONE + # } + # + # @!attribute [rw] eligible_for_replication + # Include objects in the generated manifest only if they are eligible + # for replication according to the Replication configuration on the + # source bucket. + # @return [Boolean] + # + # @!attribute [rw] created_after + # If provided, the generated manifest should include only source + # bucket objects that were created after this time. + # @return [Time] + # + # @!attribute [rw] created_before + # If provided, the generated manifest should include only source + # bucket objects that were created before this time. + # @return [Time] + # + # @!attribute [rw] object_replication_statuses + # If provided, the generated manifest should include only source + # bucket objects that have one of the specified Replication statuses. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobManifestGeneratorFilter AWS API Documentation + # + class JobManifestGeneratorFilter < Struct.new( + :eligible_for_replication, + :created_after, + :created_before, + :object_replication_statuses) + SENSITIVE = [] + include Aws::Structure + end + # Contains the information required to locate a manifest object. # # @note When making an API call, you may pass JobManifestLocation @@ -2977,7 +3123,7 @@ class JobManifestSpec < Struct.new( # ], # redirect_location: "NonEmptyMaxLength2048String", # requester_pays: false, - # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE + # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR # un_modified_since_constraint: Time.now, # sse_aws_kms_key_id: "KmsKeyArnString", # target_key_prefix: "NonEmptyMaxLength1024String", @@ -3033,6 +3179,8 @@ class JobManifestSpec < Struct.new( # mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE # }, # }, + # s3_replicate_object: { + # }, # } # # @!attribute [rw] lambda_invoke @@ -3089,6 +3237,11 @@ class JobManifestSpec < Struct.new( # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html # @return [Types::S3SetObjectRetentionOperation] # + # @!attribute [rw] s3_replicate_object + # Directs the specified job to invoke `ReplicateObject` on every + # object in the job's manifest. + # @return [Types::S3ReplicateObjectOperation] + # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobOperation AWS API Documentation # class JobOperation < Struct.new( @@ -3099,7 +3252,8 @@ class JobOperation < Struct.new( :s3_delete_object_tagging, :s3_initiate_restore_object, :s3_put_object_legal_hold, - :s3_put_object_retention) + :s3_put_object_retention, + :s3_replicate_object) SENSITIVE = [] include Aws::Structure end @@ -3117,12 +3271,17 @@ class JobOperation < Struct.new( # @!attribute [rw] number_of_tasks_failed # @return [Integer] # + # @!attribute [rw] timers + # The JobTimers attribute of a job's progress summary. + # @return [Types::JobTimers] + # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobProgressSummary AWS API Documentation # class JobProgressSummary < Struct.new( :total_number_of_tasks, :number_of_tasks_succeeded, - :number_of_tasks_failed) + :number_of_tasks_failed, + :timers) SENSITIVE = [] include Aws::Structure end @@ -3188,6 +3347,21 @@ class JobStatusException < Struct.new( include Aws::Structure end + # Provides timing details for the job. + # + # @!attribute [rw] elapsed_time_in_active_seconds + # Indicates the elapsed time in seconds the job has been in the Active + # job state. + # @return [Integer] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobTimers AWS API Documentation + # + class JobTimers < Struct.new( + :elapsed_time_in_active_seconds) + SENSITIVE = [] + include Aws::Structure + end + # Contains the configuration parameters for a `Lambda Invoke` operation. # # @note When making an API call, you may pass LambdaInvokeOperation @@ -3547,9 +3721,11 @@ class LifecycleRuleFilter < Struct.new( # # @!attribute [rw] max_results # The maximum number of access points that you want to include in the - # list. If there are more than this number of access points, then the - # response will include a continuation token in the `NextToken` field - # that you can use to retrieve the next page of access points. + # list. The response may contain fewer access points but will never + # contain more. If there are more than this number of access points, + # then the response will include a continuation token in the + # `NextToken` field that you can use to retrieve the next page of + # access points. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListAccessPointsForObjectLambdaRequest AWS API Documentation @@ -5331,7 +5507,7 @@ class S3BucketDestination < Struct.new( # ], # redirect_location: "NonEmptyMaxLength2048String", # requester_pays: false, - # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE + # storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR # un_modified_since_constraint: Time.now, # sse_aws_kms_key_id: "KmsKeyArnString", # target_key_prefix: "NonEmptyMaxLength1024String", @@ -5361,6 +5537,10 @@ class S3BucketDestination < Struct.new( # @return [Time] # # @!attribute [rw] new_object_metadata + # If you don't provide this parameter, Amazon S3 copies all the + # metadata from the original objects. If you specify an empty set, the + # new objects will have no tags. Otherwise, Amazon S3 assigns the + # supplied tags to the new objects. # @return [Types::S3ObjectMetadata] # # @!attribute [rw] new_object_tagging @@ -5450,6 +5630,27 @@ class S3CopyObjectOperation < Struct.new( # class S3DeleteObjectTaggingOperation < Aws::EmptyStructure; end + # Describes the specified job's generated manifest. Batch Operations + # jobs created with a ManifestGenerator populate details of this + # descriptor after execution of the ManifestGenerator. + # + # @!attribute [rw] format + # The format of the generated manifest. + # @return [String] + # + # @!attribute [rw] location + # Contains the information required to locate a manifest object. + # @return [Types::JobManifestLocation] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3GeneratedManifestDescriptor AWS API Documentation + # + class S3GeneratedManifestDescriptor < Struct.new( + :format, + :location) + SENSITIVE = [] + include Aws::Structure + end + # @note When making an API call, you may pass S3Grant # data as a hash: # @@ -5523,11 +5724,10 @@ class S3Grantee < Struct.new( # } # # @!attribute [rw] expiration_in_days - # This argument specifies how long the S3 Glacier Flexible Retrieval - # or S3 Glacier Deep Archive object remains available in Amazon S3. S3 - # Initiate Restore Object jobs that target S3 Glacier Flexible - # Retrieval and S3 Glacier Deep Archive objects require - # `ExpirationInDays` set to 1 or greater. + # This argument specifies how long the S3 Glacier or S3 Glacier Deep + # Archive object remains available in Amazon S3. S3 Initiate Restore + # Object jobs that target S3 Glacier and S3 Glacier Deep Archive + # objects require `ExpirationInDays` set to 1 or greater. # # Conversely, do *not* set `ExpirationInDays` when creating S3 # Initiate Restore Object jobs that target S3 Intelligent-Tiering @@ -5536,8 +5736,8 @@ class S3Grantee < Struct.new( # expiry, so specifying `ExpirationInDays` results in restore request # failure. # - # S3 Batch Operations jobs can operate either on S3 Glacier Flexible - # Retrieval and S3 Glacier Deep Archive storage class objects or on S3 + # S3 Batch Operations jobs can operate either on S3 Glacier and S3 + # Glacier Deep Archive storage class objects or on S3 # Intelligent-Tiering Archive Access and Deep Archive Access storage # tier objects, but not both types in the same job. If you need to # restore objects of both types you *must* create separate Batch @@ -5558,6 +5758,128 @@ class S3InitiateRestoreObjectOperation < Struct.new( include Aws::Structure end + # The container for the service that will create the S3 manifest. + # + # @note When making an API call, you may pass S3JobManifestGenerator + # data as a hash: + # + # { + # expected_bucket_owner: "AccountId", + # source_bucket: "S3BucketArnString", # required + # manifest_output_location: { + # expected_manifest_bucket_owner: "AccountId", + # bucket: "S3BucketArnString", # required + # manifest_prefix: "ManifestPrefixString", + # manifest_encryption: { + # sses3: { + # }, + # ssekms: { + # key_id: "KmsKeyArnString", # required + # }, + # }, + # manifest_format: "S3InventoryReport_CSV_20211130", # required, accepts S3InventoryReport_CSV_20211130 + # }, + # filter: { + # eligible_for_replication: false, + # created_after: Time.now, + # created_before: Time.now, + # object_replication_statuses: ["COMPLETED"], # accepts COMPLETED, FAILED, REPLICA, NONE + # }, + # enable_manifest_output: false, # required + # } + # + # @!attribute [rw] expected_bucket_owner + # The Amazon Web Services account ID that owns the bucket the + # generated manifest is written to. If provided the generated manifest + # bucket's owner Amazon Web Services account ID must match this + # value, else the job fails. + # @return [String] + # + # @!attribute [rw] source_bucket + # The source bucket used by the ManifestGenerator. + # @return [String] + # + # @!attribute [rw] manifest_output_location + # Specifies the location the generated manifest will be written to. + # @return [Types::S3ManifestOutputLocation] + # + # @!attribute [rw] filter + # Specifies rules the S3JobManifestGenerator should use to use to + # decide whether an object in the source bucket should or should not + # be included in the generated job manifest. + # @return [Types::JobManifestGeneratorFilter] + # + # @!attribute [rw] enable_manifest_output + # Determines whether or not to write the job's generated manifest to + # a bucket. + # @return [Boolean] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3JobManifestGenerator AWS API Documentation + # + class S3JobManifestGenerator < Struct.new( + :expected_bucket_owner, + :source_bucket, + :manifest_output_location, + :filter, + :enable_manifest_output) + SENSITIVE = [] + include Aws::Structure + end + + # Location details for where the generated manifest should be written. + # + # @note When making an API call, you may pass S3ManifestOutputLocation + # data as a hash: + # + # { + # expected_manifest_bucket_owner: "AccountId", + # bucket: "S3BucketArnString", # required + # manifest_prefix: "ManifestPrefixString", + # manifest_encryption: { + # sses3: { + # }, + # ssekms: { + # key_id: "KmsKeyArnString", # required + # }, + # }, + # manifest_format: "S3InventoryReport_CSV_20211130", # required, accepts S3InventoryReport_CSV_20211130 + # } + # + # @!attribute [rw] expected_manifest_bucket_owner + # The Account ID that owns the bucket the generated manifest is + # written to. + # @return [String] + # + # @!attribute [rw] bucket + # The bucket ARN the generated manifest should be written to. + # @return [String] + # + # @!attribute [rw] manifest_prefix + # Prefix identifying one or more objects to which the manifest + # applies. + # @return [String] + # + # @!attribute [rw] manifest_encryption + # Specifies what encryption should be used when the generated manifest + # objects are written. + # @return [Types::GeneratedManifestEncryption] + # + # @!attribute [rw] manifest_format + # The format of the generated manifest. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3ManifestOutputLocation AWS API Documentation + # + class S3ManifestOutputLocation < Struct.new( + :expected_manifest_bucket_owner, + :bucket, + :manifest_prefix, + :manifest_encryption, + :manifest_format) + SENSITIVE = [] + include Aws::Structure + end + # Whether S3 Object Lock legal hold will be applied to objects in an S3 # Batch Operations job. # @@ -5674,6 +5996,15 @@ class S3ObjectOwner < Struct.new( include Aws::Structure end + # Directs the specified job to invoke `ReplicateObject` on every object + # in the job's manifest. + # + # @api private + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3ReplicateObjectOperation AWS API Documentation + # + class S3ReplicateObjectOperation < Aws::EmptyStructure; end + # Contains the S3 Object Lock retention mode to be applied to all # objects in the S3 Batch Operations job. If you don't provide `Mode` # and `RetainUntilDate` data types in your operation, you will remove @@ -5913,12 +6244,45 @@ class SSEKMS < Struct.new( include Aws::Structure end + # Configuration for the use of SSE-KMS to encrypt generated manifest + # objects. + # + # @note When making an API call, you may pass SSEKMSEncryption + # data as a hash: + # + # { + # key_id: "KmsKeyArnString", # required + # } + # + # @!attribute [rw] key_id + # Specifies the ID of the Amazon Web Services Key Management Service + # (Amazon Web Services KMS) symmetric customer managed key to use for + # encrypting generated manifest objects. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/SSEKMSEncryption AWS API Documentation + # + class SSEKMSEncryption < Struct.new( + :key_id) + SENSITIVE = [] + include Aws::Structure + end + # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/SSES3 AWS API Documentation # class SSES3 < Aws::EmptyStructure; end + # Configuration for the use of SSE-S3 to encrypt generated manifest + # objects. + # + # @api private + # + # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/SSES3Encryption AWS API Documentation + # + class SSES3Encryption < Aws::EmptyStructure; end + # @note When making an API call, you may pass SelectionCriteria # data as a hash: # diff --git a/gems/aws-sdk-sagemaker/CHANGELOG.md b/gems/aws-sdk-sagemaker/CHANGELOG.md index ed3f75d8452..11bfee4e26c 100644 --- a/gems/aws-sdk-sagemaker/CHANGELOG.md +++ b/gems/aws-sdk-sagemaker/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.119.0 (2022-02-08) +------------------ + +* Feature - Autopilot now generates an additional report with information on the performance of the best model, such as a Confusion matrix and Area under the receiver operating characteristic (AUC-ROC). The path to the report can be found in CandidateArtifactLocations. + 1.118.0 (2022-02-03) ------------------ diff --git a/gems/aws-sdk-sagemaker/VERSION b/gems/aws-sdk-sagemaker/VERSION index 5fce89726f0..46cd9694132 100644 --- a/gems/aws-sdk-sagemaker/VERSION +++ b/gems/aws-sdk-sagemaker/VERSION @@ -1 +1 @@ -1.118.0 +1.119.0 diff --git a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker.rb b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker.rb index ee638022a86..4f0680a9701 100644 --- a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker.rb +++ b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker.rb @@ -49,6 +49,6 @@ # @!group service module Aws::SageMaker - GEM_VERSION = '1.118.0' + GEM_VERSION = '1.119.0' end diff --git a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb index bbd5c1802e0..a9ebcfc2c9a 100644 --- a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb +++ b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client.rb @@ -8268,12 +8268,13 @@ def describe_artifact(params = {}, options = {}) # resp.best_candidate.last_modified_time #=> Time # resp.best_candidate.failure_reason #=> String # resp.best_candidate.candidate_properties.candidate_artifact_locations.explainability #=> String + # resp.best_candidate.candidate_properties.candidate_artifact_locations.model_insights #=> String # resp.best_candidate.candidate_properties.candidate_metrics #=> Array # resp.best_candidate.candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC" # resp.best_candidate.candidate_properties.candidate_metrics[0].value #=> Float # resp.best_candidate.candidate_properties.candidate_metrics[0].set #=> String, one of "Train", "Validation", "Test" # resp.auto_ml_job_status #=> String, one of "Completed", "InProgress", "Failed", "Stopped", "Stopping" - # resp.auto_ml_job_secondary_status #=> String, one of "Starting", "AnalyzingData", "FeatureEngineering", "ModelTuning", "MaxCandidatesReached", "Failed", "Stopped", "MaxAutoMLJobRuntimeReached", "Stopping", "CandidateDefinitionsGenerated", "GeneratingExplainabilityReport", "Completed", "ExplainabilityError", "DeployingModel", "ModelDeploymentError" + # resp.auto_ml_job_secondary_status #=> String, one of "Starting", "AnalyzingData", "FeatureEngineering", "ModelTuning", "MaxCandidatesReached", "Failed", "Stopped", "MaxAutoMLJobRuntimeReached", "Stopping", "CandidateDefinitionsGenerated", "GeneratingExplainabilityReport", "Completed", "ExplainabilityError", "DeployingModel", "ModelDeploymentError", "GeneratingModelInsightsReport", "ModelInsightsError" # resp.generate_candidate_definitions_only #=> Boolean # resp.auto_ml_job_artifacts.candidate_definition_notebook_location #=> String # resp.auto_ml_job_artifacts.data_exploration_notebook_location #=> String @@ -12302,7 +12303,7 @@ def list_associations(params = {}, options = {}) # resp.auto_ml_job_summaries[0].auto_ml_job_name #=> String # resp.auto_ml_job_summaries[0].auto_ml_job_arn #=> String # resp.auto_ml_job_summaries[0].auto_ml_job_status #=> String, one of "Completed", "InProgress", "Failed", "Stopped", "Stopping" - # resp.auto_ml_job_summaries[0].auto_ml_job_secondary_status #=> String, one of "Starting", "AnalyzingData", "FeatureEngineering", "ModelTuning", "MaxCandidatesReached", "Failed", "Stopped", "MaxAutoMLJobRuntimeReached", "Stopping", "CandidateDefinitionsGenerated", "GeneratingExplainabilityReport", "Completed", "ExplainabilityError", "DeployingModel", "ModelDeploymentError" + # resp.auto_ml_job_summaries[0].auto_ml_job_secondary_status #=> String, one of "Starting", "AnalyzingData", "FeatureEngineering", "ModelTuning", "MaxCandidatesReached", "Failed", "Stopped", "MaxAutoMLJobRuntimeReached", "Stopping", "CandidateDefinitionsGenerated", "GeneratingExplainabilityReport", "Completed", "ExplainabilityError", "DeployingModel", "ModelDeploymentError", "GeneratingModelInsightsReport", "ModelInsightsError" # resp.auto_ml_job_summaries[0].creation_time #=> Time # resp.auto_ml_job_summaries[0].end_time #=> Time # resp.auto_ml_job_summaries[0].last_modified_time #=> Time @@ -12387,6 +12388,7 @@ def list_auto_ml_jobs(params = {}, options = {}) # resp.candidates[0].last_modified_time #=> Time # resp.candidates[0].failure_reason #=> String # resp.candidates[0].candidate_properties.candidate_artifact_locations.explainability #=> String + # resp.candidates[0].candidate_properties.candidate_artifact_locations.model_insights #=> String # resp.candidates[0].candidate_properties.candidate_metrics #=> Array # resp.candidates[0].candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC" # resp.candidates[0].candidate_properties.candidate_metrics[0].value #=> Float @@ -19448,7 +19450,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-sagemaker' - context[:gem_version] = '1.118.0' + context[:gem_version] = '1.119.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client_api.rb b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client_api.rb index e83b0d0c5e7..46c350f6f0a 100644 --- a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client_api.rb +++ b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/client_api.rb @@ -989,6 +989,7 @@ module ClientApi ModelExplainabilityBaselineConfig = Shapes::StructureShape.new(name: 'ModelExplainabilityBaselineConfig') ModelExplainabilityJobInput = Shapes::StructureShape.new(name: 'ModelExplainabilityJobInput') ModelInput = Shapes::StructureShape.new(name: 'ModelInput') + ModelInsightsLocation = Shapes::StringShape.new(name: 'ModelInsightsLocation') ModelLatencyThreshold = Shapes::StructureShape.new(name: 'ModelLatencyThreshold') ModelLatencyThresholds = Shapes::ListShape.new(name: 'ModelLatencyThresholds') ModelMetadataFilter = Shapes::StructureShape.new(name: 'ModelMetadataFilter') @@ -1937,6 +1938,7 @@ module ClientApi CallbackStepMetadata.struct_class = Types::CallbackStepMetadata CandidateArtifactLocations.add_member(:explainability, Shapes::ShapeRef.new(shape: ExplainabilityLocation, required: true, location_name: "Explainability")) + CandidateArtifactLocations.add_member(:model_insights, Shapes::ShapeRef.new(shape: ModelInsightsLocation, location_name: "ModelInsights")) CandidateArtifactLocations.struct_class = Types::CandidateArtifactLocations CandidateProperties.add_member(:candidate_artifact_locations, Shapes::ShapeRef.new(shape: CandidateArtifactLocations, location_name: "CandidateArtifactLocations")) diff --git a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb index ab734825cd0..e2c4f8fc827 100644 --- a/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb +++ b/gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb @@ -2769,10 +2769,16 @@ class CallbackStepMetadata < Struct.new( # the AutoML candidate. # @return [String] # + # @!attribute [rw] model_insights + # The Amazon S3 prefix to the model insight artifacts generated for + # the AutoML candidate. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CandidateArtifactLocations AWS API Documentation # class CandidateArtifactLocations < Struct.new( - :explainability) + :explainability, + :model_insights) SENSITIVE = [] include Aws::Structure end